View source for Lua CMDs

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}

== Options ==
<b id=CMD.OPT_ALT>CMD.OPT_ALT</b><br>
<b id=CMD.OPT_CTRL>CMD.OPT_CTRL</b><br>
<b id=CMD.OPT_SHIFT>CMD.OPT_SHIFT</b><br>
<b id=CMD.OPT_RIGHT>CMD.OPT_RIGHT</b><br>
<b id=CMD.OPT_INTERNAL>CMD.OPT_INTERNAL</b><br>
<b id=CMD.OPT_META>CMD.OPT_META</b>

== Waitcodes ==
<b id=CMD.WAITCODE_TIME>CMD.WAITCODE_TIME</b><br>
<b id=CMD.WAITCODE_DEATH>CMD.WAITCODE_DEATH</b><br>
<b id=CMD.WAITCODE_SQUAD>CMD.WAITCODE_SQUAD</b><br>
<b id=CMD.WAITCODE_GATHER>CMD.WAITCODE_GATHER</b>

== Insert/Remove Commands ==
To get the commandqueue use the following lua-call

=== CommandQueues ===
'''Spring.GetUnitCommands''' <br/>
'''Spring.GetCommandQueue''' <span class="note">(Alias)</span>
  ( number unitID, number count = 0 ) -> nil | number commandQueueSize {{new|96}}
  ( number unitID [, number count = -1] ) 
  -> nil | table commandQueueTable = {
     [1] = {
       "id"      = number,
       "params"  = { [1] = number, ...},
       "options" = {
         "coded"    = number,
         "alt"      = boolean,
         "ctrl"     = boolean,
         "shift"    = boolean,
         "right"    = boolean,
         "internal" = boolean,
         "meta"    = boolean
       }
     }, ...
   }



<span class=note>First, said "tags" aka "id" are unique command identifiers, so each command that gets inserted into a unit's command 
queue gets its unique "tag" number. (It is used to ''sync'' command queue operations, also it makes things much easier.)
Editors Note: I fucking hate it when open source devs use the word easy. It is a clear indicator that someone spends a whole day finding out about a well hidden simple concept. Well at least we are on this journey together :)
<br>
To look at those "tags" you can do the following:
   local cmdQueue = Spring.GetUnitCommands(unitID);
   if (#cmdQueue>0) then 
      local cmdTag = cmdQueue[1].tag
      Spring.Echo(cmdTag)
      ..
   end</span>





<b id=CMD.INSERT>CMD.INSERT</b>

  options.ALT     -> treat param0 as a position instead of a tag 
  options.CONTROL -> use the build queue for factories 
  params[0] = command tag or position (negative numbers to reference
  the back of the queue and 0 the first)
  params[1] = insertCmd id 
  params[2] = insertCmd options (shift,alt,right click,etc.)
  params[3 ... N+2] = insertCmd params[0 ... N-1]

  <font color="#55ee99">example:
    Spring.GiveOrderToUnit(unitID,
      CMD.INSERT,
      {-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
      {"alt"}
    );
	Command structure dissection:

	'''What to do with the command - in our case insert:'''

		'CMD.INSERT'

	'''Place in the queue to insert:'''

		'-1'

	'''Type of command to insert:'''

		'CMD.ATTACK'

	'''Additional Information:'''

	If the unit is working down a shift queue, add it seemless into it

		'CMD.OPT_SHIFT'

	'''TargetID or Position:'''

		'unitID2'

	'''I have no Idea what that does:'''

		'{"alt"}'


  if you insert cmd in pos 2 for example the rest of commands starting
  from 2 will be pushed back. 
  Ilustration: {cmdA, cmdB, cmdC, cmdD} => {cmdA, cmdB, NewCmd, cmdC, cmdD}

  </font><font color="red">
  Note: If you didn't already notice, the command params and
        the command options are twisted in the array (compared to GiveOrder)!
  </font><font color="red">
  Note2: The command options in the array/table is a number value!
         You have to use CMD.OPT_* in this case.
  </font>
<b id=CMD.REMOVE>CMD.REMOVE</b>
  options.ALT     -> use the parameters as commandIDs 
  options.CONTROL -> use the build queue for factories 
  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">     
 local facCmds = Spring.GetFactoryCommands(factoryID)
 
      if facCmds then -- nil check
		local cmd = facCmds[1]
         Spring.GiveOrderToUnit(factoryID, CMD.REMOVE, {i,cmd.tag}, {"ctrl"})

      end
 </font color="#55ee99">

== Commands ==
<font color="#55ee99">Note, the CMD[] table is bidirectional. That means: CMD[CMD.STOP] := "CMD_STOP"</font>

<b id=CMD.STOP>CMD.STOP</b>
  type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
<b id=CMD.WAIT>CMD.WAIT</b>
  type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
<b id=CMD.TIMEWAIT>CMD.TIMEWAIT</b>
  type [[Lua_CMDs#CMDTYPE.NUMBER|CMDTYPE.NUMBER]]
<b id=CMD.DEATHWAIT>CMD.DEATHWAIT</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_RECTANGLE|CMDTYPE.ICON_UNIT_OR_RECTANGLE]]
<b id=CMD.SQUADWAIT>CMD.SQUADWAIT</b>
  type [[Lua_CMDs#CMDTYPE.NUMBER|CMDTYPE.NUMBER]]
<b id=CMD.GATHERWAIT>CMD.GATHERWAIT</b>
  type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
<b id=CMD.MOVE>CMD.MOVE</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
<b id=CMD.PATROL>CMD.PATROL</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
<b id=CMD.FIGHT>CMD.FIGHT</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
<b id=CMD.ATTACK>CMD.ATTACK</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_MAP|CMDTYPE.ICON_UNIT_OR_MAP]]
<b id=CMD.AREA_ATTACK>CMD.AREA_ATTACK</b>
  type [[Lua_CMDs#CMDTYPE.ICON_AREA|CMDTYPE.ICON_AREA]]
<b id=CMD.GUARD>CMD.GUARD</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT|CMDTYPE.ICON_UNIT]]
<b id=CMD.AISELECT>CMD.AISELECT</b>
  type [[Lua_CMDs#CMDTYPE.COMBO_BOX|CMDTYPE.COMBO_BOX]]
<b id=CMD.GROUPSELECT>CMD.GROUPSELECT</b>
  type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
<b id=CMD.GROUPADD>CMD.GROUPADD</b>
  type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
<b id=CMD.GROUPCLEAR>CMD.GROUPCLEAR</b>
  type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
<b id=CMD.REPAIR>CMD.REPAIR</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_AREA|CMDTYPE.ICON_UNIT_OR_AREA]]
<b id=CMD.FIRE_STATE>CMD.FIRE_STATE</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.MOVE_STATE>CMD.MOVE_STATE</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.SELFD>CMD.SELFD</b>
  type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
<b id=CMD.LOAD_UNITS>CMD.LOAD_UNITS</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_AREA|CMDTYPE.ICON_UNIT_OR_AREA]]
<b id=CMD.LOAD_ONTO>CMD.LOAD_ONTO</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT|CMDTYPE.ICON_UNIT]]
<b id=CMD.UNLOAD_UNITS>CMD.UNLOAD_UNITS</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_AREA|CMDTYPE.ICON_UNIT_OR_AREA]]
<b id=CMD.UNLOAD_UNIT>CMD.UNLOAD_UNIT</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
<b id=CMD.ONOFF>CMD.ONOFF</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.RECLAIM>CMD.RECLAIM</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT_FEATURE_OR_AREA|CMDTYPE.ICON_UNIT_FEATURE_OR_AREA]]
<b id=CMD.CLOAK>CMD.CLOAK</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.STOCKPILE>CMD.STOCKPILE</b>
  type [[Lua_CMDs#CMDTYPE.ICON|CMDTYPE.ICON]]
<b id=CMD.DGUN>CMD.DGUN</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MAP|CMDTYPE.ICON_MAP]]
<b id=CMD.RESTORE>CMD.RESTORE</b>
  type [[Lua_CMDs#CMDTYPE.ICON_AREA|CMDTYPE.ICON_AREA]]
<b id=CMD.REPEAT>CMD.REPEAT</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.TRAJECTORY>CMD.TRAJECTORY</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.RESURRECT>CMD.RESURRECT</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT_FEATURE_OR_AREA|CMDTYPE.ICON_UNIT_FEATURE_OR_AREA]]
<b id=CMD.CAPTURE>CMD.CAPTURE</b>
  type [[Lua_CMDs#CMDTYPE.ICON_UNIT_OR_AREA|CMDTYPE.ICON_UNIT_OR_AREA]]
<b id=CMD.AUTOREPAIRLEVEL>CMD.AUTOREPAIRLEVEL</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.LOOPBACKATTACK>CMD.LOOPBACKATTACK</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.IDLEMODE>CMD.IDLEMODE</b>
  type [[Lua_CMDs#CMDTYPE.ICON_MODE|CMDTYPE.ICON_MODE]]
<b id=CMD.SET_WANTED_MAX_SPEED>CMD.SET_WANTED_MAX_SPEED</b>
  type [[Lua_CMDs#CMDTYPE.NUMBER|CMDTYPE.NUMBER]]
<b id=CMD.SETBASE>CMD.SETBASE</b>

<b id=CMD.INTERNAL>CMD.INTERNAL</b>
  used in different ways

<b>A negative number means build command</b><br>
The number is -unitDefID of the unittype that this command orders to be built.

== CommandTypes ==
<font color="#55ee99">Note, the CMDTYPE[] table is bidirectional. That means: CMDTYPE[CMDTYPE.ICON] := "CMDTYPE_ICON"</font>

<b id=CMDTYPE.ICON>CMDTYPE.ICON</b>
  expect 0 parameters in return
<b id=CMDTYPE.ICON_MODE>CMDTYPE.ICON_MODE</b>
  expect 1 parameter in return (number selected mode)
<b id=CMDTYPE.ICON_MAP>CMDTYPE.ICON_MAP</b>
  expect 3 parameters in return (mappos)
<b id=CMDTYPE.ICON_AREA>CMDTYPE.ICON_AREA</b>
  expect 4 parameters in return (mappos+radius)
<b id=CMDTYPE.ICON_UNIT>CMDTYPE.ICON_UNIT</b>
  expect 1 parameters in return (unitid)
<b id=CMDTYPE.ICON_UNIT_OR_MAP>CMDTYPE.ICON_UNIT_OR_MAP</b>
  expect 1 parameters in return (unitid) or 3 parameters in return (mappos)
<b id=CMDTYPE.ICON_FRONT>CMDTYPE.ICON_FRONT</b>
  expect 3 or 6 parameters in return (middle and right side of front if a front was defined)
<b id=CMDTYPE.COMBO_BOX>CMDTYPE.COMBO_BOX</b>
  expect 1 parameter in return (number selected option)
<b id=CMDTYPE.ICON_UNIT_OR_AREA>CMDTYPE.ICON_UNIT_OR_AREA</b>
  expect 1 parameter in return (unitid) or 4 parameters in return (mappos+radius)
<b id=CMDTYPE.ICON_UNIT_FEATURE_OR_AREA>CMDTYPE.ICON_UNIT_FEATURE_OR_AREA</b>
  expect 1 parameter in return (unitid or [[Lua_ConstGame#Engine|Game.maxUnits]]+featureid)
      or 4 parameters in return (mappos+radius)
<b id=CMDTYPE.ICON_BUILDING>CMDTYPE.ICON_BUILDING</b>
  expect 3 parameters in return (mappos)
<b id=CMDTYPE.ICON_UNIT_OR_RECTANGLE>CMDTYPE.ICON_UNIT_OR_RECTANGLE</b>
  expect 1 parameter in return (unitid)
      or 3 parameters in return (mappos)
      or 6 parameters in return (startpos+endpos)
<b id=CMDTYPE.NUMBER>CMDTYPE.NUMBER</b>
  expect 1 parameter in return (number)

<b id=CMDTYPE.CUSTOM>CMDTYPE.CUSTOM</b>
  used with CMD_INTERNAL
<b id=CMDTYPE.NEXT>CMDTYPE.NEXT</b> <font color="#55ee99">next command page</font>
  used with CMD_INTERNAL
<b id=CMDTYPE.PREV>CMDTYPE.PREV</b> <font color="#55ee99">previous command page</font>
  used with CMD_INTERNAL

[[category: Lua]]