Animation-LuaCallouts - Revision history

Maddox: Fixing nowiki notation

2017-09-23T00:53:01Z

Fixing nowiki notation

← Older revision		Revision as of 01:53, 23 September 2017
Line 13:		Line 13:

	You may also get the unit's "type" or def, which is the tag of each unit.lua file - and also what you use to spawn a certain unit using a console command. Both the UnitDefs global table and the unitDefID unit instance identifier are available in your lua animation script, so you can simply do:		You may also get the unit's "type" or def, which is the tag of each unit.lua file - and also what you use to spawn a certain unit using a console command. Both the UnitDefs global table and the unitDefID unit instance identifier are available in your lua animation script, so you can simply do:
	~~[code]~~		<nowiki>
	Spring.Echo(UnitDefs[unitDefID].name)		Spring.Echo(UnitDefs[unitDefID].name)
	[/~~code]~~		</nowiki>

	== Animation ==		== Animation ==

Maddox: /* Introduction */

2017-09-23T00:51:42Z

Introduction

← Older revision		Revision as of 01:51, 23 September 2017
Line 13:		Line 13:

	You may also get the unit's "type" or def, which is the tag of each unit.lua file - and also what you use to spawn a certain unit using a console command. Both the UnitDefs global table and the unitDefID unit instance identifier are available in your lua animation script, so you can simply do:		You may also get the unit's "type" or def, which is the tag of each unit.lua file - and also what you use to spawn a certain unit using a console command. Both the UnitDefs global table and the unitDefID unit instance identifier are available in your lua animation script, so you can simply do:
	[~~nowiki~~]		[code]
	Spring.Echo(UnitDefs[unitDefID].name)		Spring.Echo(UnitDefs[unitDefID].name)
	[/~~nowiki~~]		[/code]

	== Animation ==		== Animation ==

Maddox: * Added info on how to get the unit type from within the animation script

2017-09-23T00:51:04Z

* Added info on how to get the unit type from within the animation script

← Older revision		Revision as of 01:51, 23 September 2017
Line 12:		Line 12:
	* accel/decel: number ([[radian]]s per second per frame)		* accel/decel: number ([[radian]]s per second per frame)

			You may also get the unit's "type" or def, which is the tag of each unit.lua file - and also what you use to spawn a certain unit using a console command. Both the UnitDefs global table and the unitDefID unit instance identifier are available in your lua animation script, so you can simply do:
			[nowiki]
			Spring.Echo(UnitDefs[unitDefID].name)
			[/nowiki]

	== Animation ==		== Animation ==

Flozi: /* Animation */ 102.0 - Remove updateMatrix argument in Spring.UnitScript.{Move,Turn} as matrices will be automatically updated if necessary.

2016-08-26T15:10:08Z

Animation: 102.0 - Remove updateMatrix argument in Spring.UnitScript.{Move,Turn} as matrices will be automatically updated if necessary.

← Older revision		Revision as of 16:10, 26 August 2016
Line 22:		Line 22:


	'''Spring.UnitScript.Move''' ( piece, axis, destination[, speed~~][, updateMatrix]~~] ) -> nil		'''Spring.UnitScript.Move''' ( piece, axis, destination[, speed] ) -> nil

	Move piece along axis to the destination position. If speed is given, the piece isn't moved immediately, but will move there at the desired speed. The X axis is mirrored compared to BOS/COB scripts, to match the direction of the X axis in Spring world space~~. The 5th param was introduced in 95.0 and instantly updates the piece position matrix (rather than waiting for the next frame)~~.		Move piece along axis to the destination position. If speed is given, the piece isn't moved immediately, but will move there at the desired speed. The X axis is mirrored compared to BOS/COB scripts, to match the direction of the X axis in Spring world space.


	'''Spring.UnitScript.Turn''' ( piece, axis, destination[, speed~~][, updateMatrix]~~] ) -> nil		'''Spring.UnitScript.Turn''' ( piece, axis, destination[, speed] ) -> nil

	Turn piece around axis to the destination angle. If speed is given, the piece isn't rotated immediately, but will turn at the desired angular velocity. Angles are in radians.		Turn piece around axis to the destination angle. If speed is given, the piece isn't rotated immediately, but will turn at the desired angular velocity. Angles are in radians.
	Always uses the shortest angular towards destination degree, and if at exactly 180 degrees opposite, will go counter-clockwise~~. The 5th param was introduced in 95.0 and instantly updates the piece rotation matrix (rather than waiting for the next frame)~~.		Always uses the shortest angular towards destination degree, and if at exactly 180 degrees opposite, will go counter-clockwise.

Picassoct at 10:43, 22 February 2015

2015-02-22T10:43:37Z

← Older revision		Revision as of 11:43, 22 February 2015
Line 187:		Line 187:
	Spring.UnitScript.Show (piece)		Spring.UnitScript.Show (piece)

	'~~Localisation~~:' ~~Localisation~~ is a important way to speed up lua scripts. ~~Everytime~~ a variable or function in Lua is used, the Lua-VM has to search for this function first, find it and then put it to use. This is slows your script down, especially if a function is called ~~repeatetly~~ (e.g. in a loop). To Avoid such searches, Lua allows you to ~~localise~~ 64 variables or functions per script.		'Localization:' Localization is a important way to speed up lua scripts. Every time a variable or function in Lua is used, the Lua-VM has to search for this function first, find it and then put it to use. This slows your script down, especially if a function is called repeatedly (e.g. in a loop). To Avoid such searches, Lua allows you to localize 64 variables or functions per script.

	<font color="#ee0000">		<font color="#ee0000">
Line 204:		Line 204:

	end</font color>		end</font color>
	*This function is near ~~instantanously~~ found and thus faster		*This function is near instantaneously found and thus faster


	[[Category:Animation]]		[[Category:Animation]]
	[[Category:Lua]]		[[Category:Lua]]

Flozi: /* Other */ 97.0- SetUnitValue now accepts booleans, too

2014-10-10T17:45:51Z

Other: 97.0- SetUnitValue now accepts booleans, too

← Older revision		Revision as of 18:45, 10 October 2014
Line 143:		Line 143:


	'''Spring.UnitScript.GetUnitValue''' ( ... ) -> number \| number, number<br>		'''Spring.UnitScript.GetUnitValue''' ( ... ) -> number \| number, number \| bool<br>
	'''Spring.UnitScript.SetUnitValue''' ( ... ) -> nil		'''Spring.UnitScript.SetUnitValue''' ( ... ) -> nil

	This may be used instead of COB's get and set codes. It is recommended however, to use dedicated Lua functions (e.g. Spring.GetUnitHealth(unitID) instead of GetUnitValue(4)): these functions should be considered a relic of the past.		This may be used instead of COB's get and set codes. It is recommended however, to use dedicated Lua functions (e.g. Spring.GetUnitHealth(unitID) instead of GetUnitValue(4)): these functions should be considered a relic of the past. As of 97.0 SetUnitValue now accepts lua booleans as well as numbers to set the value.

	Note that these are identical to Spring.GetUnitCOBValue and Spring.SetUnitCOBValue (see also [[Lua_SyncedCtrl#Lua_to_COB]] for the signature of those functions), except that an unitID argument shouldn't be passed to the versions in the Spring.UnitScript table.		Note that these are identical to Spring.GetUnitCOBValue and Spring.SetUnitCOBValue (see also [[Lua_SyncedCtrl#Lua_to_COB]] for the signature of those functions), except that an unitID argument shouldn't be passed to the versions in the Spring.UnitScript table.

Picassoct at 20:31, 13 September 2014

2014-09-13T20:31:28Z

← Older revision		Revision as of 21:31, 13 September 2014
Line 181:		Line 181:

	== Localized functions for less typing ==		== Localized functions for less typing ==
	In unitscript enviroment some of the '''Spring.UnitScript.xxxxx()''' functions are already localized.		In unitscript enviroment some of the '''Spring.UnitScript.xxxxx()''' functions are already localized*.
	So unless doing anything special, you can save ~~type~~:		So unless doing anything special, you can save keystrokes:
	Show (piece)		Show (piece)
	instead of the longer:		instead of the longer:
	Spring.UnitScript.Show (piece)		Spring.UnitScript.Show (piece)

			'Localisation:' Localisation is a important way to speed up lua scripts. Everytime a variable or function in Lua is used, the Lua-VM has to search for this function first, find it and then put it to use. This is slows your script down, especially if a function is called repeatetly (e.g. in a loop). To Avoid such searches, Lua allows you to localise 64 variables or functions per script.

			<font color="#ee0000">
			for i=1,128, 1 do

			x,y,z= Spring.GetUnitPosition(unitID)

			end</font color>
			*This function is searched and found 128 Times in the table Spring, where it resides
			<font color="#55ee99">
			local fastVersionOfTheSameFunction=Spring.GetUnitPosition

			for i=1,128, 1 do

			x,y,z= fastVersionOfTheSameFunction(unitID)

			end</font color>
			*This function is near instantanously found and thus faster


	[[Category:Animation]]		[[Category:Animation]]
	[[Category:Lua]]		[[Category:Lua]]

Knorke: /* Localized functions for less typing */ some

2014-05-03T20:53:20Z

Localized functions for less typing: some

← Older revision		Revision as of 21:53, 3 May 2014
Line 181:		Line 181:

	== Localized functions for less typing ==		== Localized functions for less typing ==
	In unitscript enviroment the '''Spring.UnitScript.xxxxx()''' functions are already localized.		In unitscript enviroment some of the '''Spring.UnitScript.xxxxx()''' functions are already localized.
	So unless doing anything special, you can save type:		So unless doing anything special, you can save type:
	Show (piece)		Show (piece)

Knorke: Localized functions for less typing

2014-05-01T07:32:38Z

Localized functions for less typing

← Older revision		Revision as of 08:32, 1 May 2014
Line 11:		Line 11:
	* speed: number ([[elmo]]s per second (linear), [[radian]]s per second (angular))		* speed: number ([[elmo]]s per second (linear), [[radian]]s per second (angular))
	* accel/decel: number ([[radian]]s per second per frame)		* accel/decel: number ([[radian]]s per second per frame)


	== Animation ==		== Animation ==
Line 177:		Line 178:

	Tells Spring the Killed script finished, and which wreckLevel to use. If wreckLevel is not given no wreck is created. May only be called after Killed has been called. DO NOT USE, the framework handles this transparently (it passes the return value of Killed into this function.)		Tells Spring the Killed script finished, and which wreckLevel to use. If wreckLevel is not given no wreck is created. May only be called after Killed has been called. DO NOT USE, the framework handles this transparently (it passes the return value of Killed into this function.)


			== Localized functions for less typing ==
			In unitscript enviroment the '''Spring.UnitScript.xxxxx()''' functions are already localized.
			So unless doing anything special, you can save type:
			Show (piece)
			instead of the longer:
			Spring.UnitScript.Show (piece)


	[[Category:Animation]]		[[Category:Animation]]
	[[Category:Lua]]		[[Category:Lua]]

Beherith: /* Effects */

2014-04-09T18:27:21Z

Effects

← Older revision		Revision as of 19:27, 9 April 2014
Line 91:		Line 91:

	Emits a [[CEG]] effect or weapon from the given piece. The id is based on one of the effect or weapon ids defined in the units unitdef.<br>		Emits a [[CEG]] effect or weapon from the given piece. The id is based on one of the effect or weapon ids defined in the units unitdef.<br>

			If the piece has no geometry, then the sfx is emitted in the +z direction from the origin of the piece.

			If the piece has 1 vertex, the emit dir is the vector from the origin to the the position of the first vertex the emit position is the origin of the piece.

			If there is more than one vertex in the piece, then the emit vector is the vector pointing from v[0] to v[1], and the emit position is v[0].

	Example:		Example: