Animation-LuaCallins - Revision history

Forboding angel: /* Example of parts needed to create a Mobile Builder */

2022-11-17T08:30:21Z

Example of parts needed to create a Mobile Builder

← Older revision		Revision as of 09:30, 17 November 2022
Line 166:		Line 166:
	<span class="note">N.B. As of 92.0 the results are cached and the function is called 31 times only. Deprecated in favour of Spring.SetUnitNanoPieces, which disables this callin when used.</span>		<span class="note">N.B. As of 92.0 the results are cached and the function is called 31 times only. Deprecated in favour of Spring.SetUnitNanoPieces, which disables this callin when used.</span>

	=== Example of ~~parts~~ needed to create a Mobile Builder ===		=== Example of what is needed to create a Mobile Builder ===
	<nowiki>		<nowiki>
	local nanoPieces = {[0] = nanopoint1}		local nanoPieces = {[0] = nanopoint1}

Forboding angel: /* Example of what is needed for a Transport */

2022-11-17T08:29:54Z

Example of what is needed for a Transport

← Older revision		Revision as of 09:29, 17 November 2022
Line 262:		Line 262:
	In UnloadLand and UnloadLandFlood behaviors, these are called one time after all units are unloaded. (The transport is empty.) For the UnloadDrop behavior, this is called for every unit that is unloaded.		In UnloadLand and UnloadLandFlood behaviors, these are called one time after all units are unloaded. (The transport is empty.) For the UnloadDrop behavior, this is called for every unit that is unloaded.

	==== Example of what is needed for a Transport ====		==== Example of what is needed for an air Transport ====
	<nowiki>		<nowiki>
	-- This assumes that the name of the piece where you want to attach the unit is "link"		-- This assumes that the name of the piece where you want to attach the unit is "link"

Forboding angel: /* Example of what is needed for a Transport */

2022-11-17T08:29:08Z

Example of what is needed for a Transport

← Older revision		Revision as of 09:29, 17 November 2022
Line 264:		Line 264:
	==== Example of what is needed for a Transport ====		==== Example of what is needed for a Transport ====
	<nowiki>		<nowiki>
			-- This assumes that the name of the piece where you want to attach the unit is "link"
	function script.BeginTransport(passengerID)		function script.BeginTransport(passengerID)
	local unitHeight = Spring.GetUnitHeight(passengerID) -- This moves the unit down so that it appears as though the top of it is attached to where the link piece was set (usually underneath the transport)		local unitHeight = Spring.GetUnitHeight(passengerID) -- This moves the unit down so that it appears as though the top of it is attached to where the link piece was set (usually underneath the transport)

Forboding angel: /* Example of what is needed for a Transport */

2022-11-17T08:28:03Z

Example of what is needed for a Transport

← Older revision		Revision as of 09:28, 17 November 2022
Line 263:		Line 263:

	==== Example of what is needed for a Transport ====		==== Example of what is needed for a Transport ====
	<nowiki>		<nowiki>
	function script.BeginTransport(passengerID)		function script.BeginTransport(passengerID)
	local unitHeight = Spring.GetUnitHeight(passengerID) -- This moves the unit down so that it appears as though the top of it is attached to where the link piece was set (usually underneath the transport)		local unitHeight = Spring.GetUnitHeight(passengerID) -- This moves the unit down so that it appears as though the top of it is attached to where the link piece was set (usually underneath the transport)
Line 276:		Line 276:
	Move(link, y_axis, 0, 500) -- Once transport is complete, move the link piece back to where it was originally		Move(link, y_axis, 0, 500) -- Once transport is complete, move the link piece back to where it was originally
	end		end
	</nowiki>		</nowiki>

	=== Ground transports ===		=== Ground transports ===

Forboding angel: /* Air transports */

2022-11-17T08:27:45Z

Air transports

← Older revision		Revision as of 09:27, 17 November 2022
Line 262:		Line 262:
	In UnloadLand and UnloadLandFlood behaviors, these are called one time after all units are unloaded. (The transport is empty.) For the UnloadDrop behavior, this is called for every unit that is unloaded.		In UnloadLand and UnloadLandFlood behaviors, these are called one time after all units are unloaded. (The transport is empty.) For the UnloadDrop behavior, this is called for every unit that is unloaded.

			==== Example of what is needed for a Transport ====
			<nowiki>
			function script.BeginTransport(passengerID)
			local unitHeight = Spring.GetUnitHeight(passengerID) -- This moves the unit down so that it appears as though the top of it is attached to where the link piece was set (usually underneath the transport)
			Move(link, y_axis, -unitHeight, 500)
			end

			function script.QueryTransport()
			return link
			end

			function script.EndTransport(passengerID)
			Move(link, y_axis, 0, 500) -- Once transport is complete, move the link piece back to where it was originally
			end
			</nowiki>

	=== Ground transports ===		=== Ground transports ===

Forboding angel: /* Builders and factories */

2022-11-17T08:24:19Z

Builders and factories

← Older revision		Revision as of 09:24, 17 November 2022
Line 165:		Line 165:

	<span class="note">N.B. As of 92.0 the results are cached and the function is called 31 times only. Deprecated in favour of Spring.SetUnitNanoPieces, which disables this callin when used.</span>		<span class="note">N.B. As of 92.0 the results are cached and the function is called 31 times only. Deprecated in favour of Spring.SetUnitNanoPieces, which disables this callin when used.</span>

			=== Example of parts needed to create a Mobile Builder ===
			<nowiki>
			local nanoPieces = {[0] = nanopoint1}
			local SIG_AIM = 2


			-- Add this to create()
			Spring.SetUnitNanoPieces(unitID, nanoPieces)
			--

			function RestoreAfterDelay()
			SetSignalMask(SIG_AIM)
			if building == false then
			Sleep(2000)
			end
			end

			function script.StopBuilding()
			SetUnitValue(COB.INBUILDSTANCE, 0)
			building = false
			StartThread(RestoreAfterDelay)
			Signal(SIG_AIM)
			SetSignalMask(SIG_AIM)
			end

			function script.StartBuilding(heading, pitch)
			Signal(SIG_AIM)
			SetUnitValue(COB.INBUILDSTANCE, 1)
			building = true
			end

			function script.QueryNanoPiece()
			local nano = nanoPieces[nanoNum]
			return nano
			end
			</nowiki>

	== Transports ==		== Transports ==

Flozi: /* Transports */ no s

2020-06-10T08:52:52Z

Transports: no s

← Older revision		Revision as of 09:52, 10 June 2020
Line 170:		Line 170:
	There are some different code paths inside Spring related to transports, each (unfortunately) also associated with a different set of unit script call-ins.		There are some different code paths inside Spring related to transports, each (unfortunately) also associated with a different set of unit script call-ins.

	This table shows for the three different {{xtaglink\|Gamedev:UnitDefs\|~~transportUnloadMethods~~}} for both air transports and ground transports which callins are used and roughly when and how often they are called. Refer to the documentation below for a description of the call-ins.		This table shows for the three different {{xtaglink\|Gamedev:UnitDefs\|transportUnloadMethod}} for both air transports and ground transports which callins are used and roughly when and how often they are called. Refer to the documentation below for a description of the call-ins.

	The entire behavior around transports should be considered subject to change; it is obvious it is far from a perfect design currently.		The entire behavior around transports should be considered subject to change; it is obvious it is far from a perfect design currently.

Flozi: /* Transports */ taglink

2020-06-10T08:44:04Z

Transports: taglink

← Older revision		Revision as of 09:44, 10 June 2020
Line 170:		Line 170:
	There are some different code paths inside Spring related to transports, each (unfortunately) also associated with a different set of unit script call-ins.		There are some different code paths inside Spring related to transports, each (unfortunately) also associated with a different set of unit script call-ins.

	This table shows for the three different transportUnloadMethods for both air transports and ground transports which callins are used and roughly when and how often they are called. Refer to the documentation below for a description of the call-ins.		This table shows for the three different {{xtaglink\|Gamedev:UnitDefs\|transportUnloadMethods}} for both air transports and ground transports which callins are used and roughly when and how often they are called. Refer to the documentation below for a description of the call-ins.

	The entire behavior around transports should be considered subject to change; it is obvious it is far from a perfect design currently.		The entire behavior around transports should be considered subject to change; it is obvious it is far from a perfect design currently.
Line 253:		Line 253:

	This is called one time after the unit reached the ground. May be used to hide a parachute for example.		This is called one time after the unit reached the ground. May be used to hide a parachute for example.


	== Internal ==		== Internal ==

Flozi: /* Generic */ 104.0 - add LUS ChangeHeading callin & add LUS {Start,Stop}Skidding callins; called when a (ground) unit reacts to an impulse

2017-12-21T17:33:34Z

Generic: 104.0 - add LUS ChangeHeading callin & add LUS {Start,Stop}Skidding callins; called when a (ground) unit reacts to an impulse

← Older revision		Revision as of 18:33, 21 December 2017
Line 23:		Line 23:

	These are called whenever the unit starts or stops moving. Typical use for them is to trigger wheels to start spinning, animate treads, or start/stop a walking animation. Since 95.0 they are only run when a unit transitions from zero to non-zero speed or vice versa, and no longer during in-place rotations.		These are called whenever the unit starts or stops moving. Typical use for them is to trigger wheels to start spinning, animate treads, or start/stop a walking animation. Since 95.0 they are only run when a unit transitions from zero to non-zero speed or vice versa, and no longer during in-place rotations.


			'''script.ChangeHeading''' ( number deltaHeading ) -> nil

			{{new\|104.0}} Called when the unit changes heading.


			'''script.StartSkidding''' ( ) -> nil<br>
			'''script.StopSkidding''' ( ) -> nil

			{{new\|104.0}} Called when a (ground) unit reacts to an impulse. The start-skidding threshold ('sqSkidSpeedMult') is configurable via [[Lua_MoveCtrl#MoveType-Controlling\|MoveCtrl.SetGroundMoveTypeData]]

Maddox: Formatting fix

2017-09-21T20:53:51Z

Formatting fix

← Older revision		Revision as of 21:53, 21 September 2017
Line 135:		Line 135:
	BTW, don't forget to set INBUILDSTANCE to 1 to start building! For lua script, that is		BTW, don't forget to set INBUILDSTANCE to 1 to start building! For lua script, that is

	<~~code~~>		<nowiki>
	function script.StartBuilding(heading, pitch)		function script.StartBuilding(heading, pitch)

	SetUnitValue(COB.INBUILDSTANCE, 1)		SetUnitValue(COB.INBUILDSTANCE, 1)

	end		end

Line 145:		Line 143:
	SetUnitValue(COB.INBUILDSTANCE, 0)		SetUnitValue(COB.INBUILDSTANCE, 0)
	end		end
	</~~code~~>		</nowiki>

	'''script.QueryBuildInfo''' ( ) -> number piece		'''script.QueryBuildInfo''' ( ) -> number piece

	For factories only. Should return the piece to which the unit which is going to be build will be attached while it's being build.		For factories only. Should return the piece to which the unit which is going to be build will be attached while it's being build.


	'''script.QueryNanopiece''' ( ) -> number piece		'''script.QueryNanopiece''' ( ) -> number piece