Lua CMDs

2012-09-04T16:08:19Z

Cubex: /* Insert/Remove Commands */

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

== Options ==
CMD.OPT_ALT 
CMD.OPT_CTRL 
CMD.OPT_SHIFT 
CMD.OPT_RIGHT 
CMD.OPT_INTERNAL 
CMD.OPT_META

== Waitcodes ==
CMD.WAITCODE_TIME 
CMD.WAITCODE_DEATH 
CMD.WAITCODE_SQUAD 
CMD.WAITCODE_GATHER

== Insert/Remove Commands ==
First, said "tags" 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.) 
To receive those "tags" you can do the following:
local cmdQueue = Spring.GetUnitCommands(unitID);
if (#cmdQueue>0) then
local cmdTag = cmdQueue[1].tag
..
end

CMD.INSERT
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]

example:
Spring.GiveOrderToUnit(unitID,
CMD.INSERT,
{-1,CMD.ATTACK,''CMD.OPT_SHIFT'',''unitID2''},
{"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}


Note: If you didn't already notice, the command params and
the command options are twisted in the array (compared to GiveOrder)!

Note2: The command options in the array/table is a number value!
You have to use CMD.OPT_* in this case.

CMD.REMOVE
options.ALT -> use the parameters as commandIDs
options.CONTROL -> use the build queue for factories
params[0 ... N-1] = tags or commandIDs to remove

== Commands ==
Note, the CMD[] table is bidirectional. That means: CMD[CMD.STOP] := "CMD_STOP"

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

CMD.INTERNAL
used in different ways

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

== CommandTypes ==
Note, the CMDTYPE[] table is bidirectional. That means: CMDTYPE[CMDTYPE.ICON] := "CMDTYPE_ICON"

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

CMDTYPE.CUSTOM
used with CMD_INTERNAL
CMDTYPE.NEXT next command page
used with CMD_INTERNAL
CMDTYPE.PREV previous command page
used with CMD_INTERNAL

[[category: Lua]]

Spring - User contributions [en]

Lua CMDs