Lua:Environments - Revision history

Flozi: /* Environments */ underp links

2017-12-26T01:31:27Z

Environments: underp links

← Older revision		Revision as of 02:31, 26 December 2017
Line 2:		Line 2:
	Here is an exhaustive list of the different lua environments within Spring, roughly in execution order as a game is loaded.		Here is an exhaustive list of the different lua environments within Spring, roughly in execution order as a game is loaded.
	=== LuaMenu ===		=== LuaMenu ===
	Source: {{sourcelink\|file=Lua/LuaMenu.cpp}}		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.		Introduced in 104.0, a stripped down environment that starts before the game is loaded and persists through reload.
	=== LuaParser ===		=== LuaParser ===
	Source: {{sourcelink\|file=Lua/LuaParser.cpp}}		Source: {{sourcelink\|file=rts/Lua/LuaParser.cpp}}

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

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

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

	The main environment for synced game-controlling mechanics ("gadgets").		The main environment for synced game-controlling mechanics ("gadgets").
	=== LuaRules (unsynced) ===		=== LuaRules (unsynced) ===
	Source: {{sourcelink\|file=Lua/LuaHandle.cpp}}		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")		The main environment for unsynced game effects, rendering, UI etc. ("gadgets")
	=== LuaGaia (synced) ===		=== LuaGaia (synced) ===
	Source: {{sourcelink\|file=Lua/LuaGaia.cpp}}		Source: {{sourcelink\|file=rts/Lua/LuaGaia.cpp}}

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

	As LuaRules (unsynced) but for maps.		As LuaRules (unsynced) but for maps.

Flozi: /* Environments */ some source links

2017-12-25T22:46:48Z

Environments: some source links

← Older revision		Revision as of 23:46, 25 December 2017
Line 2:		Line 2:
	Here is an exhaustive list of the different lua environments within Spring, roughly in execution order as a game is loaded.		Here is an exhaustive list of the different lua environments within Spring, roughly in execution order as a game is loaded.
	=== LuaMenu ===		=== LuaMenu ===
			Source: {{sourcelink\|file=Lua/LuaMenu.cpp}}

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

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

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

			Source: {{sourcelink\|file=Lua/LuaHandleSynced.cpp}}

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

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

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

	As LuaRules (unsynced) but for maps.		As LuaRules (unsynced) but for maps.
	=== LuaUI ===		=== LuaUI ===

Hokomoko: /* Interfaces */

2017-12-22T16:46:25Z

Interfaces

← Older revision		Revision as of 17:46, 22 December 2017
Line 49:		Line 49:
	\| align="center" bgcolor="#227722" \| +		\| align="center" bgcolor="#227722" \| +
	\| align="center" bgcolor="#772222" \| -		\| 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="center" bgcolor="#227722" \| +

Flozi: /* Interfaces */ add LuaIntro, LuaParser

2017-12-22T16:33:23Z

Interfaces: add LuaIntro, LuaParser

Show changes

Flozi: Move lua interfaces table and give further details on the purpose of each environment

2017-12-22T15:26:14Z

Move lua interfaces table and give further details on the purpose of each environment

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 ===
Introduced in 104.0, a stripped down environment that starts before the game is loaded and persists through reload.
=== LuaParser ===
Minimal environment used to parse and load definition files.
=== LuaIntro ===
Introduced in 95.0, to allow visual customisation of the loading process.
=== LuaRules (synced) ===
The main environment for synced game-controlling mechanics ("gadgets").
=== LuaRules (unsynced) ===
The main environment for unsynced game effects, rendering, UI etc. ("gadgets")
=== LuaGaia (synced) ===
As LuaRules (synced) but for maps.
=== LuaGaia (unsynced) ===
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" | LuaUI
! align="center" | LuaRules (unsynced)
! align="center" | LuaRules (synced)
! align="center" | LuaMenu
|-
| align="left" | [[Lua_ConstGame]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_ConstEngine]]
| 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="#227722" | +
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_UnitDefs]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_WeaponDefs]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_FeatureDefs]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -

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

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

|-
| align="left" | [[Lua_UnsyncedRead]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_UnsyncedCtrl]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_SyncedRead]]
| align="center" bgcolor="#888800" | +**
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_SyncedCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_MoveCtrl]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_PathFinder]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_OpenGL_Api]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_GLSL_Api]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_FBO_and_RBO]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#888800" | +***
|-
| align="left" | [[Lua_UnitRendering ]]
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_Fonts]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_ConstGL]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_VFS]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#888800" | +*
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_Scream]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
| align="center" bgcolor="#227722" | +
|-
| align="left" | [[Lua_BitOps]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_MathExtra]]
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#227722" | +
| align="center" bgcolor="#772222" | -
|-
| align="left" | [[Lua_Socket]]
| align="center" bgcolor="#227722" | +
| 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]]