GetIssuedOrderId

comment

Returns the numeric order ID constant of the currently issued unit order.

note

See: OrderId, OrderId2String, GetOrderedUnit, GetOrderPointX, GetOrderTargetUnit.

note

See the list of all known order IDs https://www.hiveworkshop.com/threads/list-of-order-ids.350361/.

note

Example (Lua):

The code below creates a unit and registers all issued order events for debugging.

function printOrderInfo()
    local orderId = GetIssuedOrderId()
    local unitName = GetUnitName(GetTriggerUnit())
    assert(GetOrderedUnit() == GetTriggerUnit(), "GetOrderedUnit() expected to equal GetTriggerUnit()")
    print("For: ".. unitName ..", Order: ".. orderId ..", oName:".. OrderId2String(orderId))
end
function printIssuedOrder()
    print("Next is an Issued Order:")
    printOrderInfo()
end
function printIssuedTargetOrder()
    local widget = GetOrderTarget()
    local destr = GetOrderTargetDestructable()
    local item = GetOrderTargetItem()
    local unit = GetOrderTargetUnit()

    local targetIsText = "Target is a '"
    if widget then targetIsText = targetIsText .. "widget," end
    if destr then targetIsText = targetIsText .. "destructable" end
    if item then targetIsText = targetIsText .. "item" end
    if unit then targetIsText = targetIsText .. "unit" end
    targetIsText = targetIsText .."'"

    print("Next is an Issued Target Order:")
    print(targetIsText)
    printOrderInfo()
end
function printIssuedPointOrder()
    local loc = GetOrderPointLoc()
    local x,y,z = GetLocationX(loc),GetLocationY(loc),GetLocationZ(loc)
    -- GetOrderPointX(),GetOrderPointY() is identical to location...
    -- if you only wanted (x,y)
    print("Next is an Issued Point Order at:", x,y,z)
    printOrderInfo()
end

footman = CreateUnit(Player(0), FourCC("hfoo"), -30, 0, 90)
peasant = CreateUnit(Player(0), FourCC("hpea"), 30, 0, 90)
item = CreateItem(FourCC("war2"), 64, 128)
destructable = CreateDestructable(FourCC("LTbr"), 96, 0, 180, 1, 0)

whichIssuedOrderTrig = CreateTrigger()
whichIssuedTargetOrderTrig = CreateTrigger()
whichIssuedPointOrderTrig = CreateTrigger()

whichOrderTrigEvent = 
    TriggerRegisterUnitEvent(whichIssuedOrderTrig,       footman, EVENT_UNIT_ISSUED_ORDER)

whichIssuedTargetOrderTrigEvent =
    TriggerRegisterUnitEvent(whichIssuedTargetOrderTrig, footman, EVENT_UNIT_ISSUED_TARGET_ORDER)

whichIssuedPointOrderTrigEvent =
    TriggerRegisterUnitEvent(whichIssuedPointOrderTrig,  footman, EVENT_UNIT_ISSUED_POINT_ORDER)


whichIssuedOrderTrigAct = TriggerAddAction(      whichIssuedOrderTrig,       printIssuedOrder)
whichIssuedTargetOrderTrigAct = TriggerAddAction(whichIssuedTargetOrderTrig, printIssuedTargetOrder)
whichIssuedPointOrderTrigAct = TriggerAddAction( whichIssuedPointOrderTrig,  printIssuedPointOrder)

event

EVENT_PLAYER_UNIT_ISSUED_ORDER

event

EVENT_PLAYER_UNIT_ISSUED_UNIT_ORDER

event

EVENT_PLAYER_UNIT_ISSUED_POINT_ORDER

event

EVENT_PLAYER_UNIT_ISSUED_TARGET_ORDER

event

EVENT_UNIT_ISSUED_ORDER

event

EVENT_UNIT_ISSUED_POINT_ORDER

event

EVENT_UNIT_ISSUED_TARGET_ORDER

patch

1.00

Source

common.j

return type

integer

Source code

constant native GetIssuedOrderId takes nothing returns integer