LuaCallinReturn - Revision history

Maddox: Added params and description to AllowFeatureBuildStep

2022-05-24T19:52:46Z

Added params and description to AllowFeatureBuildStep

← Older revision		Revision as of 20:52, 24 May 2022
Line 74:		Line 74:
	<font color=#55ee99>AllowFeatureCreation()</font> --> "featureDefID, teamID, x, y, z"		<font color=#55ee99>AllowFeatureCreation()</font> --> "featureDefID, teamID, x, y, z"

	<font color=#55ee99>AllowFeatureBuildStep()</font> --> ~~unknown~~, ~~please document~~.		<font color=#55ee99>AllowFeatureBuildStep()</font> --> "builderID, builderTeam, featureID, featureDefID, part"</font><br>
			<font color=#dd9944>Called just before a feature updates its build percentage. Returns a bool to allow the change.</font>

	<font color=#55ee99>AllowResourceLevel()</font> --> "teamID, res, level"		<font color=#55ee99>AllowResourceLevel()</font> --> "teamID, res, level"

Raaar: /* Game Events: */

2019-12-25T03:02:00Z

Game Events:

← Older revision		Revision as of 04:02, 25 December 2019
Line 287:		Line 287:

	FIXME: apparently the above is incorrect and parameters are AllowStartPosition(playerID, teamID, readyState, cx, cy, cz, rx, ry, rz)		FIXME: apparently the above is incorrect and parameters are AllowStartPosition(playerID, teamID, readyState, cx, cy, cz, rx, ry, rz)

	clampedPos = coordinates clamped into startbox, rawPickPos = where player tried to start		clampedPos = coordinates clamped into startbox, rawPickPos = where player tried to start

Raaar: /* Game Events: */ added a note about AllowStartPosition parameters

2019-12-25T03:01:01Z

Game Events:: added a note about AllowStartPosition parameters

← Older revision		Revision as of 04:01, 25 December 2019
Line 286:		Line 286:
	number rawPickPos.x, number rawPickPos.y, number rawPickPos.z		number rawPickPos.x, number rawPickPos.y, number rawPickPos.z

			FIXME: apparently the above is incorrect and parameters are AllowStartPosition(playerID, teamID, readyState, cx, cy, cz, rx, ry, rz)
	clampedPos = coordinates clamped into startbox, rawPickPos = where player tried to start		clampedPos = coordinates clamped into startbox, rawPickPos = where player tried to start

Maddox at 05:15, 11 December 2018

2018-12-11T05:15:12Z

← Older revision		Revision as of 06:15, 11 December 2018
Line 59:		Line 59:
	<font color=#55ee99>MapDrawCmd()</font> --> "playerID, cmdType, px, py, pz, labeltext"		<font color=#55ee99>MapDrawCmd()</font> --> "playerID, cmdType, px, py, pz, labeltext"

	<font color=#55ee99>AllowCommand()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"		<font color=#55ee99>AllowCommand()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"<br />
	<font color=#dd9944>~~Gadget~~ only.</font>		<font color=#dd9944>Synced only.</font>

	<font color=#55ee99>CommandFallback()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"		<font color=#55ee99>CommandFallback()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

Maddox at 05:11, 11 December 2018

2018-12-11T05:11:44Z

← Older revision		Revision as of 06:11, 11 December 2018
Line 60:		Line 60:

	<font color=#55ee99>AllowCommand()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"		<font color=#55ee99>AllowCommand()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag, synced"
			<font color=#dd9944>Gadget only.</font>

	<font color=#55ee99>CommandFallback()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"		<font color=#55ee99>CommandFallback()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdParams, cmdOptions, cmdTag"

Maddox: * Styling fixes

2018-11-28T01:31:10Z

* Styling fixes

← Older revision		Revision as of 02:31, 28 November 2018
Line 111:		Line 111:
	<font color=#dd9944>Spring.SetExperienceGrade must be called first to determine how often it is called</font>		<font color=#dd9944>Spring.SetExperienceGrade must be called first to determine how often it is called</font>

	<font color=#55ee99>UnitCreated()</font> --> "unitID, unitDefID, teamID, builderID"		<font color=#55ee99>UnitCreated()</font> --> "unitID, unitDefID, teamID, builderID"<br>
	<font color=#dd9944>Unit started being built (it's in wireframe mode)</font>		<font color=#dd9944>Unit started being built (it's in wireframe mode)</font>

Line 126:		Line 126:
	<font color=#dd9944>Unit now belongs to new team</font>		<font color=#dd9944>Unit now belongs to new team</font>

	<font color=#55ee99>UnitIdle()</font> --> "unitID, unitDefID, teamID"		<font color=#55ee99>UnitIdle()</font> --> "unitID, unitDefID, teamID"<br>
	<font color=#dd9944>No commands in this unit's queue. Beware, might be fired while 'guarding'.</font>		<font color=#dd9944>No commands in this unit's queue. Beware, might be fired while 'guarding'.</font>

Maddox: Added some details to unitcreated and unitidle

2018-11-28T01:30:13Z

Added some details to unitcreated and unitidle

← Older revision		Revision as of 02:30, 28 November 2018
Line 112:		Line 112:

	<font color=#55ee99>UnitCreated()</font> --> "unitID, unitDefID, teamID, builderID"		<font color=#55ee99>UnitCreated()</font> --> "unitID, unitDefID, teamID, builderID"
			<font color=#dd9944>Unit started being built (it's in wireframe mode)</font>

	<font color=#55ee99>UnitFinished()</font> --> "unitID, unitDefID, teamID"		<font color=#55ee99>UnitFinished()</font> --> "unitID, unitDefID, teamID"
Line 126:		Line 127:

	<font color=#55ee99>UnitIdle()</font> --> "unitID, unitDefID, teamID"		<font color=#55ee99>UnitIdle()</font> --> "unitID, unitDefID, teamID"
			<font color=#dd9944>No commands in this unit's queue. Beware, might be fired while 'guarding'.</font>

	<font color=#55ee99>UnitCommand()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams, cmdTag" <span class="warning">(cmdTag only available from version 95.0)</span>		<font color=#55ee99>UnitCommand()</font> --> "unitID, unitDefID, unitTeam, cmdID, cmdOpts, cmdParams, cmdTag" <span class="warning">(cmdTag only available from version 95.0)</span>

Picassoct: /* Unit-Specific: */ Do not want to be that grumpy guy- but please do not look into gadgets.lua for the content of callin arguments. Look at the source: https://github.com/spring/spring/blob/d085e297416bd963ec25eaa3dbf0796ba22a3582/rts/Lua/LuaHandleSynce

2018-03-25T11:32:05Z

Unit-Specific:: Do not want to be that grumpy guy- but please do not look into gadgets.lua for the content of callin arguments. Look at the source: https://github.com/spring/spring/blob/d085e297416bd963ec25eaa3dbf0796ba22a3582/rts/Lua/LuaHandleSynce

← Older revision		Revision as of 12:32, 25 March 2018
Line 165:		Line 165:
	<span class="warning">(as of 95.0)</span>		<span class="warning">(as of 95.0)</span>

	<font color=#55ee99>ShieldPreDamaged()</font> --> "proID~~, proOwnerID~~, shieldEmitterWeaponNum, shieldCarrierUnitID, ~~bounceProjectile~~"		<font color=#55ee99>ShieldPreDamaged()</font> --> "proID, shieldEmitterWeaponNum, shieldCarrierUnitID, boolBounceProjectile, beamEmitterWaponNumber, beamCarrierUnitID, startx, starty, startz, hitx, hity, hitz"

	<font color=#55ee99>UnitUnitCollision(colliderID, collideeID)</font> -- needs SetWatchUnit enabled for both parties		<font color=#55ee99>UnitUnitCollision(colliderID, collideeID)</font> -- needs SetWatchUnit enabled for both parties

Flozi: category lua - > deprecated, use Lua:Callins instead

2017-12-26T12:24:19Z

category lua - > deprecated, use Lua:Callins instead

← Older revision		Revision as of 13:24, 26 December 2017
Line 316:		Line 316:
	<br><font color=#dd9944>Only called for weaponDefIDs registered via Script.SetWatchWeapon</font>		<br><font color=#dd9944>Only called for weaponDefIDs registered via Script.SetWatchWeapon</font>

	[[Category:~~Lua~~]]		[[Category:Deprecated]]

Maddox: /* What is a callin anyway? */

2017-08-20T03:21:29Z

What is a callin anyway?

← Older revision		Revision as of 04:21, 20 August 2017
Line 10:		Line 10:

	==What is a callin anyway?==		==What is a callin anyway?==
	Call-ins are calls from the engine, into the gadget or widget script. In other words, these functions are called when a particular ~~â€œeventâ€~~ happens.		Call-ins are calls from the engine, into the gadget or widget script. In other words, these functions are called when a particular ''event'' happens.
	Some call-in functions can return values to the engine.		Some call-in functions can return values to the engine.
	===Blocking events with return values===		===Blocking events with return values===