Lua CMDs - Revision history

Thinksome: bad argument #2 to 'GetCommandQueue' (number expected, got no value)

2019-05-10T17:00:09Z

bad argument #2 to 'GetCommandQueue' (number expected, got no value)

← Older revision		Revision as of 18:00, 10 May 2019
Line 21:		Line 21:
	'''Spring.GetUnitCommands''' <br/>		'''Spring.GetUnitCommands''' <br/>
	'''Spring.GetCommandQueue''' <span class="note">(Alias)</span>		'''Spring.GetCommandQueue''' <span class="note">(Alias)</span>
	( number unitID, number count ~~= 0~~ ) -> nil \| number commandQueueSize {{new\|96}}		( number unitID, number count ) -> nil \| number commandQueueSize {{new\|96}}
	~~( number unitID [, number count = -1] )~~
	-> nil \| table commandQueueTable = {		-> nil \| table commandQueueTable = {
	[1] = {		[1] = {
Line 39:		Line 38:
	}		}

			Use count = -1 to get all commands.

	<span class=note>First, said "tags" aka "id" are unique command identifiers, so each command that gets inserted into a unit's command		<span class=note>First, said "tags" aka "id" are unique command identifiers, so each command that gets inserted into a unit's command

2019-04-05T05:59:38Z

adding command amount req param to getunitcommands

← Older revision		Revision as of 06:59, 5 April 2019
Line 46:		Line 46:
	<br>		<br>
	To look at those "tags" you can do the following:		To look at those "tags" you can do the following:
	local cmdQueue = Spring.GetUnitCommands(unitID);		local cmdQueue = Spring.GetUnitCommands(unitID, 100);
	if (#cmdQueue>0) then		if (#cmdQueue>0) then
	local cmdTag = cmdQueue[1].tag		local cmdTag = cmdQueue[1].tag

2018-11-07T09:34:00Z

IDs => CmdIDs (to ease search from Google)

← Older revision		Revision as of 10:34, 7 November 2018
Line 267:		Line 267:
	used with CMD_INTERNAL		used with CMD_INTERNAL

	== ~~IDs~~ ==		== CmdIDs ==
	Below is a table of all CMD table entries and their IDs:		Below is a table of all CMD table entries and their IDs:

2018-04-15T10:34:17Z

IDs

← Older revision		Revision as of 11:34, 15 April 2018
Line 268:		Line 268:

	== IDs ==		== IDs ==
	Below is a table of all ~~commands~~ and their IDs:		Below is a table of all CMD table entries and their IDs:

	{\|class="wikitable sortable"		{\|class="wikitable sortable"

2018-04-15T10:33:47Z

Add ID table

@@ Line 266: / Line 266: @@
 <b id=CMDTYPE.PREV>CMDTYPE.PREV</b> <font color="#55ee99">previous command page</font>
    used with CMD_INTERNAL
 [[category: Lua]]

2018-01-31T05:37:18Z

Fixing syntax highlight in CMD.REMOVE & CMD.INSERT examples

← Older revision		Revision as of 06:37, 31 January 2018
Line 67:		Line 67:
	params[3 ... N+2] = insertCmd params[0 ... N-1]		params[3 ... N+2] = insertCmd params[0 ... N-1]

	<~~font color~~="~~#55ee99~~">~~example:~~		Example:
			<syntaxhighlight lang="lua">
	Spring.GiveOrderToUnit(unitID,		Spring.GiveOrderToUnit(unitID,
	CMD.INSERT,		CMD.INSERT,
Line 73:		Line 74:
	{"alt"}		{"alt"}
	);		);
			</syntaxhighlight>

	Command structure dissection:		Command structure dissection:

Line 120:		Line 123:
	params[0 ... N-1] = tags or commandIDs to remove		params[0 ... N-1] = tags or commandIDs to remove

	No clues what the above mean translated, but here is a working example of how to delete a buildorder from a factory: <~~font color~~="~~#55ee99~~">		No clues what the above mean translated, but here is a working example of how to delete a buildorder from a factory:
			<syntaxhighlight lang="lua">
	local facCmds = Spring.GetFactoryCommands(factoryID)		local facCmds = Spring.GetFactoryCommands(factoryID)

	if facCmds then -- nil check		if facCmds then -- nil check
	local cmd = facCmds[1]		local cmd = facCmds[1]
	Spring.GiveOrderToUnit(factoryID, CMD.REMOVE, {i,cmd.tag}, {"ctrl"})		Spring.GiveOrderToUnit(factoryID, CMD.REMOVE, {i,cmd.tag}, {"ctrl"})
			end
	end		</syntaxhighlight>
	</~~font color="#55ee99"~~>

	== Commands ==		== Commands ==

2015-09-25T05:56:09Z

Commands

← Older revision		Revision as of 06:56, 25 September 2015
Line 222:		Line 222:
	<font color="#55ee99">Spring.GiveOrderToUnit(unitID, <b>-UnitDefNames["unitname"].id</b>, {x,y,z(,facing)}, {"shift"})</font>		<font color="#55ee99">Spring.GiveOrderToUnit(unitID, <b>-UnitDefNames["unitname"].id</b>, {x,y,z(,facing)}, {"shift"})</font>
	<b>'facing'</b> is an optional integer parameter that controls unit's facing when placed.		<b>'facing'</b> is an optional integer parameter that controls unit's facing when placed.
	The values of (x,y,z) must <i>all</i> be number values (like "0"), ~~placeholder symbols such as "_" will break~~ the build order.		The values of (x,y,z) must <i>all</i> be number values (like the number "0"), or the build order will break.

	== CommandTypes ==		== CommandTypes ==

2015-09-25T05:54:30Z

← Older revision		Revision as of 06:54, 25 September 2015
Line 221:		Line 221:
	alternatively:		alternatively:
	<font color="#55ee99">Spring.GiveOrderToUnit(unitID, <b>-UnitDefNames["unitname"].id</b>, {x,y,z(,facing)}, {"shift"})</font>		<font color="#55ee99">Spring.GiveOrderToUnit(unitID, <b>-UnitDefNames["unitname"].id</b>, {x,y,z(,facing)}, {"shift"})</font>
	<b>'facing'</b> is an integer parameter that controls unit's facing when placed.		<b>'facing'</b> is an optional integer parameter that controls unit's facing when placed.
			The values of (x,y,z) must <i>all</i> be number values (like "0"), placeholder symbols such as "_" will break the build order.

	== CommandTypes ==		== CommandTypes ==

2015-09-25T05:09:17Z

← Older revision		Revision as of 06:09, 25 September 2015
Line 216:		Line 216:
	<b>A negative number means build command</b><br>		<b>A negative number means build command</b><br>
	The number is -unitDefID of the unittype that this command orders to be built.		The number is -unitDefID of the unittype that this command orders to be built.
			This means that build orders have no convenient CMD._____ string.
			The command id for build orders must always be a "minus" sign <i>appended to an integer value</i>.
			<font color="#55ee99">Spring.GiveOrderToUnit(unitID, <b>-(unitDefID)</b>, {x,y,z(,facing)}, {"shift"})</font>
			alternatively:
			<font color="#55ee99">Spring.GiveOrderToUnit(unitID, <b>-UnitDefNames["unitname"].id</b>, {x,y,z(,facing)}, {"shift"})</font>
			<b>'facing'</b> is an integer parameter that controls unit's facing when placed.

	== CommandTypes ==		== CommandTypes ==

2015-01-05T23:53:55Z

CommandQueues

← Older revision		Revision as of 00:53, 6 January 2015
Line 112:		Line 112:
	Note2: The command options in the array/table is a number value!		Note2: The command options in the array/table is a number value!
	You have to use CMD.OPT_* in this case.		You have to use CMD.OPT_* in this case.
			</font><font color="red">
			Note3: The inserted command doesn't go through allowcommand callins, only CMD.INSERT does.
	</font>		</font>
	<b id=CMD.REMOVE>CMD.REMOVE</b>		<b id=CMD.REMOVE>CMD.REMOVE</b>