Lua System - Revision history

Master-athmos: Applied LuaConstant template to constant numbers.

2021-02-28T21:17:02Z

Applied LuaConstant template to constant numbers.

← Older revision		Revision as of 22:17, 28 February 2021
Line 228:		Line 228:
	==Special team constants==		==Special team constants==

	{{type\|~~number}}~~ NO_ACCESS_TEAM		{{LuaConstant
	: <font color="maroon" style="font-weight:600">No description available</font>		\|type = number
			\|name = NO_ACCESS_TEAM
			\|info = <font color="maroon" style="font-weight:600">No description available</font>
			}}


	{{type\|~~number}}~~ ALL_ACCESS_TEAM		{{LuaConstant
	: <font color="maroon" style="font-weight:600">No description available</font>		\|type = number
			\|name = ALL_ACCESS_TEAM
			\|info = <font color="maroon" style="font-weight:600">No description available</font>
			}}

	=LuaUI only=		=LuaUI only=
Line 274:		Line 279:
	==Synced==		==Synced==

	{{type\|~~number}}~~ COBSCALE		{{LuaConstant
	: Number containing the cobscale factor, which is applied to transform the variables assigned via unit cob animation scripts for use inside the engine (default: 65536).		\|type = number
			\|name = COBSCALE
			\|info =Number containing the cobscale factor, which is applied to transform the variables assigned via unit cob animation scripts for use inside the engine (default: 65536).
			}}

2021-02-17T14:10:55Z

Updated page with new anchorable template for LuaCallouts, added COBSCALE description

2014-10-11T14:05:35Z

All Lua Contexts: 97.0- added Script.IsEngineMinVersion(major [,minor [,commits]])

← Older revision		Revision as of 15:05, 11 October 2014
Line 41:		Line 41:
	...		...
	}		}

			'''Script.IsEngineMinVersion'''
			( major [, minor [, commits ]] ) -> nil \| boolean isMinVersion
	</span>		</span>

2013-10-28T22:39:14Z

Synced: update links

← Older revision		Revision as of 23:39, 28 October 2013
Line 70:		Line 70:
	( string callin_name ) -> nil		( string callin_name ) -> nil

	'''Script.SetWatchFeature''' <span class=note>Enables the `UnitFeatureCollision` callin for a specific [[~~Units-~~FeatureDefs\|FeatureDef]].</span>		'''Script.SetWatchFeature''' <span class=note>Enables the `UnitFeatureCollision` callin for a specific [[Gamedev:FeatureDefs\|FeatureDef]].</span>
	( number featureDefID, boolean enable ) -> nil		( number featureDefID, boolean enable ) -> nil

Line 76:		Line 76:
	( number featureDefID ) -> nil \| boolean enabled		( number featureDefID ) -> nil \| boolean enabled

	'''Script.SetWatchUnit''' <span class=note>Enables the `UnitUnitCollision`, `UnitFeatureCollision` and `UnitMoveFailed` callins for a specific [[~~Units-~~UnitDefs\|UnitDef]].</span>		'''Script.SetWatchUnit''' <span class=note>Enables the `UnitUnitCollision`, `UnitFeatureCollision` and `UnitMoveFailed` callins for a specific [[Gamedev:UnitDefs\|UnitDef]].</span>
	( number unitDefID, boolean enable ) -> nil		( number unitDefID, boolean enable ) -> nil

2013-07-13T13:07:28Z

Synced

@@ Line 118: / Line 118: @@
 '''Script.PermitHelperAIs'''
    ( boolean permit ) -> nil
 [[category: Lua]]

2012-12-26T20:06:09Z

Synced

← Older revision		Revision as of 21:06, 26 December 2012
Line 120:		Line 120:

	'''Spring.SetUnitRulesParam'''		'''Spring.SetUnitRulesParam'''
	( number unitID, string paramName, number paramValue, table <span class=note>losAccess</span> ) -> nil		( number unitID, string paramName, number paramValue [, table <span class=note>losAccess</span>] ) -> nil
	<span class=note>possible values for the losAccess table are:		<span class=note>possible values for the losAccess table are:
	`private` : only readable by the ally (default)		`private` : only readable by the ally (default)
Line 132:		Line 132:

	'''Spring.SetTeamRulesParam'''		'''Spring.SetTeamRulesParam'''
	( number teamID, string paramName, number paramValue, table <span class=note>losAccess</span> ) -> nil		( number teamID, string paramName, number paramValue [, table <span class=note>losAccess</span>] ) -> nil
	<span class=note>see above for further documentation of losAccess</span>		<span class=note>see above for further documentation of losAccess</span>

	'''Spring.SetGameRulesParam'''		'''Spring.SetGameRulesParam'''
	( string paramName, number paramValue, table <span class=note>losAccess</span> ) -> nil		( string paramName, number paramValue [, table <span class=note>losAccess</span>] ) -> nil
	<span class=note>see above for further documentation of losAccess</span>		<span class=note>see above for further documentation of losAccess</span>

	[[category: Lua]]		[[category: Lua]]

2012-04-15T15:04:31Z

Synced

← Older revision		Revision as of 16:04, 15 April 2012
Line 129:		Line 129:
	note: if one condition is fulfilled all beneath it are too (e.g. if an unit is in LOS it<br/> can read params with `inradar=true` even if the param has `inlos=false`)		note: if one condition is fulfilled all beneath it are too (e.g. if an unit is in LOS it<br/> can read params with `inradar=true` even if the param has `inlos=false`)
	note2: all GameRulesParam are public, TeamRulesParams can just be `private`,`allied`<br/> and/or `public`		note2: all GameRulesParam are public, TeamRulesParams can just be `private`,`allied`<br/> and/or `public`
	note3: You can read RulesParams from '''any''' Lua enviroments! With those losAccess<br/> policies can limit their access.</span>		note3: You can read RulesParams from '''any''' Lua enviroments! With those losAccess<br/> policies you can limit their access.</span>

	'''Spring.SetTeamRulesParam'''		'''Spring.SetTeamRulesParam'''

2012-03-31T17:45:21Z

Synced: single quotes

← Older revision		Revision as of 18:45, 31 March 2012
Line 76:		Line 76:
	( number featureDefID ) -> nil \| boolean enabled		( number featureDefID ) -> nil \| boolean enabled

	'''Script.SetWatchUnit''' <span class=note>Enables the `UnitUnitCollision`, `UnitFeatureCollision` and UnitMoveFailed callins for a specific [[Units-UnitDefs\|UnitDef]].</span>		'''Script.SetWatchUnit''' <span class=note>Enables the `UnitUnitCollision`, `UnitFeatureCollision` and `UnitMoveFailed` callins for a specific [[Units-UnitDefs\|UnitDef]].</span>
	( number unitDefID, boolean enable ) -> nil		( number unitDefID, boolean enable ) -> nil

2012-03-31T17:44:38Z

Synced: UnitMoveFailed is tied to SetWatchUnit also

← Older revision		Revision as of 18:44, 31 March 2012
Line 76:		Line 76:
	( number featureDefID ) -> nil \| boolean enabled		( number featureDefID ) -> nil \| boolean enabled

	'''Script.SetWatchUnit''' <span class=note>Enables the `UnitUnitCollision` ~~and~~ `UnitFeatureCollision` callins for a specific [[Units-UnitDefs\|UnitDef]].</span>		'''Script.SetWatchUnit''' <span class=note>Enables the `UnitUnitCollision`, `UnitFeatureCollision` and UnitMoveFailed callins for a specific [[Units-UnitDefs\|UnitDef]].</span>
	( number unitDefID, boolean enable ) -> nil		( number unitDefID, boolean enable ) -> nil

2012-03-31T15:34:08Z

Synced: 83.0 - added Spring.SetWatchUnit(unitDefID) and Spring.SetWatchFeature(featureDefID) analogues of SetWatchWeapon

@@ Line 69: / Line 69: @@
 '''Script.UpdateCallIn'''
    ( string callin_name ) -> nil
 '''Script.SetWatchWeapon''' <span class=note>Enables the `Explosion` and (as of 0.83+) `ProjectileCreated` and `ProjectileDestroyed` callins for a specific WeaponDef.</span>