Qrow: 1 revision imported

2025-11-13T01:51:00Z

1 revision imported

← Older revision	Revision as of 18:51, 12 November 2025
(No difference)

interwiki3>Flozi: /* Environments */ underp links

2017-12-26T01:31:27Z

Environments: underp links

New page

== Environments ==
Here is an exhaustive list of the different lua environments within Spring, roughly in execution order as a game is loaded.
=== LuaMenu ===
Source: {{sourcelink|file=rts/Lua/LuaMenu.cpp}}

Introduced in 104.0, a stripped down environment that starts before the game is loaded and persists through reload.
=== LuaParser ===
Source: {{sourcelink|file=rts/Lua/LuaParser.cpp}}

Minimal environment used to parse and load definition files.
=== LuaIntro ===
Source: {{sourcelink|file=rts/Lua/LuaIntro.cpp}}

Introduced in 95.0, to allow visual customisation of the loading process.
=== LuaRules (synced) ===
Source: {{sourcelink|file=rts/Lua/LuaHandle.cpp}}

Source: {{sourcelink|file=rts/Lua/LuaHandleSynced.cpp#L305}}

The main environment for synced game-controlling mechanics ("gadgets").
=== LuaRules (unsynced) ===
Source: {{sourcelink|file=rts/Lua/LuaHandle.cpp}}

Source: {{sourcelink|file=rts/Lua/LuaHandleSynced.cpp#L57}}

The main environment for unsynced game effects, rendering, UI etc. ("gadgets")
=== LuaGaia (synced) ===
Source: {{sourcelink|file=rts/Lua/LuaGaia.cpp}}

As LuaRules (synced) but for maps.
=== LuaGaia (unsynced) ===
Source: {{sourcelink|file=rts/Lua/LuaGaia.cpp}}

As LuaRules (unsynced) but for maps.
=== LuaUI ===
The main environment for toggleable UI elements and controls ("widgets").

== Interfaces ==
The following table demonstrates which interfaces are available to each environment.
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em; border: 1px #aaa solid; border-collapse: collapse;"
|
! align="center" | LuaMenu
! align="center" | LuaIntro
! align="center" | LuaParser
! align="center" | LuaRules/Gaia (synced)
! align="center" | LuaRules/Gaia (unsynced)
! align="center" | LuaUI
|-
| align="left" | [[Lua_ConstGame]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstEngine]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstPlatform]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_UnitDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_WeaponDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_FeatureDefs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_ConstCOB]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -

|-
| align="left" | [[Lua_CMDs]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_UnsyncedRead]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +

|-
| align="left" | [[Lua_UnsyncedCtrl]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_SyncedRead]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +**

|-
| align="left" | [[Lua_SyncedCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_MoveCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_PathFinder]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_OpenGL_Api]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_GLSL_Api]]
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#888800" | +***
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_FBO_and_RBO]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_UnitRendering ]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_Fonts]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstGL]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_VFS]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +*
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_Scream]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_BitOps]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_MathExtra]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_Socket]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|}

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em; border: 1px #aaa solid; border-collapse: collapse;"
|-
| align="center" | *
| align="left"| only VFS.ZIP_ONLY
|-
| align="center" | **
| align="left"| with special LOS handling and decoy unit handling
|-
| align="center" | ***
| align="left"| stripped down environment with certain functions removed
|}

[[Category:Lua]]

Lua:Environments - Revision history

Qrow: 1 revision imported

interwiki3>Flozi: /* Environments */ underp links