Lua:Callins - Revision history

Beherith: /* Drawing */ newline

2022-10-12T14:10:04Z

Drawing: newline

← Older revision		Revision as of 15:10, 12 October 2022
Line 250:		Line 250:
	\|name = Update		\|name = Update
	\|args = dt		\|args = dt
	\|info = Called for every draw frame (including when the game is paused) and at least once per sim frame except when catching up. The parameter is the time since the last update. }}		\|info = Called for every draw frame (including when the game is paused) and at least once per sim frame except when catching up. The parameter is the time since the last update.
			}}

	=== Draw* Functions ===		=== Draw* Functions ===

Beherith: /* Units */

2022-08-02T20:49:02Z

Units

← Older revision		Revision as of 21:49, 2 August 2022
Line 606:		Line 606:
	\|name = UnitEnteredLos		\|name = UnitEnteredLos
	\|args = unitID, unitTeam, allyTeam, unitDefID		\|args = unitID, unitTeam, allyTeam, unitDefID
	\|info = Called when a unit enters LOS of an allyteam. Its called after the unit is in LOS, so you can query that unit.		\|info = Called when a unit enters LOS of an allyteam. Its called after the unit is in LOS, so you can query that unit. The allyTeam is who's LOS the unit entered.
	}}		}}

Maddox: Fix to the AllowFeatureBuildStep description, added description for "part" with a numerical example (provided by Sprung)

2022-05-24T19:48:50Z

Fix to the AllowFeatureBuildStep description, added description for "part" with a numerical example (provided by Sprung)

← Older revision		Revision as of 20:48, 24 May 2022
Line 744:		Line 744:
	\|args = builderID, builderTeam, featureID, featureDefID, part		\|args = builderID, builderTeam, featureID, featureDefID, part
	\|return = {{type\|bool}} allow		\|return = {{type\|bool}} allow
	\|info = Called just before a feature ~~progresses~~ its build percentage, the boolean return value determines whether or not the ~~progress~~ change is permitted. Note that this is also called for resurrecting features, and for refilling features with resources before resurrection. On reclaim the part values are negative, and on refill and ~~reclaim~~ they are positive.		\|info = Called just before a feature changes its build percentage, the boolean return value determines whether or not the change is permitted. Note that this is also called for resurrecting features, and for refilling features with resources before resurrection. On reclaim the part values are negative, and on refill and ressurect they are positive. Part is the percentage the feature be built or reclaimed per frame. Eg. for a 30 workertime builder, that's a build power of 1 per frame. For a 50 buildtime feature reclaimed by this builder, part will be 100/-50(/1) = -2%, or -0.02 numerically.
	}}		}}

Beherith: /* Units */

2022-02-21T11:30:15Z

Units

← Older revision		Revision as of 12:30, 21 February 2022
Line 624:		Line 624:
	\|name = UnitLeftRadar		\|name = UnitLeftRadar
	\|args = unitID, unitTeam, allyTeam, unitDefID		\|args = unitID, unitTeam, allyTeam, unitDefID
	\|info = Called when a unit leaves radar of an allyteam. For widgets, this is called just after a unit leaves radar coverage, so widgets cannot get the position of units that left their radar.		\|info = Called when a unit leaves radar of an allyteam. Also called when a unit leaves LOS without any radar coverage. For widgets, this is called just after a unit leaves radar coverage, so widgets cannot get the position of units that left their radar.
	}}		}}

Beherith: /* Units */

2022-02-21T11:28:51Z

Units

← Older revision		Revision as of 12:28, 21 February 2022
Line 606:		Line 606:
	\|name = UnitEnteredLos		\|name = UnitEnteredLos
	\|args = unitID, unitTeam, allyTeam, unitDefID		\|args = unitID, unitTeam, allyTeam, unitDefID
	\|info = Called when a unit enters LOS of an allyteam.		\|info = Called when a unit enters LOS of an allyteam. Its called after the unit is in LOS, so you can query that unit.
	}}		}}

Line 612:		Line 612:
	\|name = UnitLeftLos		\|name = UnitLeftLos
	\|args = unitID, unitTeam, allyTeam, unitDefID		\|args = unitID, unitTeam, allyTeam, unitDefID
	\|info = Called when a unit leaves LOS of an allyteam.		\|info = Called when a unit leaves LOS of an allyteam. For widgets, this one is called just before the unit leaves los, so you can still get the position of a unit that left los.
	}}		}}

Line 618:		Line 618:
	\|name = UnitEnteredRadar		\|name = UnitEnteredRadar
	\|args = unitID, unitTeam, allyTeam, unitDefID		\|args = unitID, unitTeam, allyTeam, unitDefID
	\|info = Called when a unit enters radar of an allyteam.		\|info = Called when a unit enters radar of an allyteam. Also called when a unit enters LOS without any radar coverage.
	}}		}}

Line 624:		Line 624:
	\|name = UnitLeftRadar		\|name = UnitLeftRadar
	\|args = unitID, unitTeam, allyTeam, unitDefID		\|args = unitID, unitTeam, allyTeam, unitDefID
	\|info = Called when a unit leaves radar of an allyteam.		\|info = Called when a unit leaves radar of an allyteam. For widgets, this is called just after a unit leaves radar coverage, so widgets cannot get the position of units that left their radar.
	}}		}}

Maddox: Added Spring.SendLuaUIMsg as possible sender for RecvLuaMsg (tested and works, got the info from DavetheBrave)

2022-02-17T16:52:20Z

Added Spring.SendLuaUIMsg as possible sender for RecvLuaMsg (tested and works, got the info from DavetheBrave)

← Older revision		Revision as of 17:52, 17 February 2022
Line 840:		Line 840:
	\|name = RecvLuaMsg		\|name = RecvLuaMsg
	\|args = msg, playerID		\|args = msg, playerID
	\|info = Receives messages from unsynced sent via [[Lua_UnsyncedCtrl#SendLuaMessage\|Spring.SendLuaRulesMsg]].		\|info = Receives messages from unsynced sent via [[Lua_UnsyncedCtrl#SendLuaMessage\|Spring.SendLuaRulesMsg]] or [[Lua_UnsyncedCtrl#SendLuaMessage\|Spring.SendLuaUIMsg]].
	}}		}}

Maddox: after -> when

2022-02-07T21:17:21Z

after -> when

← Older revision		Revision as of 22:17, 7 February 2022
Line 534:		Line 534:
	\|name = UnitHarvestStorageFull		\|name = UnitHarvestStorageFull
	\|args = unitID, unitDefID, unitTeam		\|args = unitID, unitDefID, unitTeam
	\|info = Called ~~after~~ a unit's harvestStorage is full (according to its unitDef's entry).		\|info = Called when a unit's harvestStorage is full (according to its unitDef's entry).
	}}		}}

Maddox: Added UnitHarvestStorageFull description (was undocumented)

2022-02-07T21:15:57Z

Added UnitHarvestStorageFull description (was undocumented)

← Older revision		Revision as of 22:15, 7 February 2022
Line 529:		Line 529:
	\|args = colliderID, collideeID		\|args = colliderID, collideeID
	\|info = Called when a unit collides with a feature. The unit must be registered with [[Lua_System#Synced\|Script.SetWatchUnit]] and the feature registered with [[Lua_System#Synced\|Script.SetWatchFeature]].		\|info = Called when a unit collides with a feature. The unit must be registered with [[Lua_System#Synced\|Script.SetWatchUnit]] and the feature registered with [[Lua_System#Synced\|Script.SetWatchFeature]].
			}}

			{{LuaCallin
			\|name = UnitHarvestStorageFull
			\|args = unitID, unitDefID, unitTeam
			\|info = Called after a unit's harvestStorage is full (according to its unitDef's entry).
	}}		}}

Beherith: /* Synced Only */

2021-11-25T14:35:19Z

Synced Only

← Older revision		Revision as of 15:35, 25 November 2021
Line 738:		Line 738:
	\|args = builderID, builderTeam, featureID, featureDefID, part		\|args = builderID, builderTeam, featureID, featureDefID, part
	\|return = {{type\|bool}} allow		\|return = {{type\|bool}} allow
	\|info = Called just before a feature progresses its build percentage, the boolean return value determines whether or not the progress change is permitted.		\|info = Called just before a feature progresses its build percentage, the boolean return value determines whether or not the progress change is permitted. Note that this is also called for resurrecting features, and for refilling features with resources before resurrection. On reclaim the part values are negative, and on refill and reclaim they are positive.
	}}		}}

Rafal99: Add info about enabling DrawProjectile.

2021-09-17T01:12:12Z

Add info about enabling DrawProjectile.

← Older revision		Revision as of 02:12, 17 September 2021
Line 381:		Line 381:
	\|args = projectileID, drawMode		\|args = projectileID, drawMode
	\|return = {{type\|bool}} suppressEngineDraw		\|return = {{type\|bool}} suppressEngineDraw
	\|info = For custom rendering of weapon (& other) projectiles.		\|info = For custom rendering of weapon (& other) projectiles, [[Lua_UnitRendering#Lua.27s_DrawXYZ-Callin\|enabled here]].
	}}		}}