[Snippet] Order Event

[Bribe]

Like SpellEffectEvent, but this one is for catching orders. Also like SpellEffectEvent, this is pretty much as lightweight as it gets.

Thanks to Azlier for the number 0xD0000.

Jass:

//============================================================================
// OrderEvent by Bribe, special thanks to Nestharus and Azlier, version 2.1.0.0
//
// API
// ---
//     RegisterOrderEvent(integer orderId, code eventFunc)
//     RegisterAnyOrderEvent(code eventFunc) //Runs for point/target/instant for any order
//
// Requires
// --------
//     RegisterPlayerUnitEvent: hiveworkshop.com/forums/showthread.php?t=203338
//
library OrderEvent requires RegisterPlayerUnitEvent
 
globals
    private trigger array t
endglobals
 
//============================================================================
function RegisterOrderEvent takes integer orderId, code c returns nothing
    set orderId = orderId - 851968
    if t[orderId] == null then
        set t[orderId] = CreateTrigger()
    endif
    call TriggerAddCondition(t[orderId], Filter(c))
endfunction
 
//============================================================================
function RegisterAnyOrderEvent takes code c returns nothing
    call RegisterPlayerUnitEvent(EVENT_PLAYER_UNIT_ISSUED_ORDER, c)
    call RegisterPlayerUnitEvent(EVENT_PLAYER_UNIT_ISSUED_TARGET_ORDER, c)
    call RegisterPlayerUnitEvent(EVENT_PLAYER_UNIT_ISSUED_POINT_ORDER, c)
endfunction
 
//============================================================================
private function OnOrder takes nothing returns nothing
    call TriggerEvaluate(t[GetIssuedOrderId() - 851968])
endfunction
 
//============================================================================
private module M
    private static method onInit takes nothing returns nothing
        call RegisterAnyOrderEvent(function OnOrder)
    endmethod
endmodule
private struct S extends array
    implement M
endstruct
 
endlibrary

[Bribe]

Made this thing really tight and added in Nestharus' wise input that I can just subtract 0xD0000 instead of hashing the values in a hashtable.

Shortened the API significantly and this should be very easy to pick up on.

[Nestharus]

Add thanks to azlier for finding that number as well (I got it from him).

Otherwise looks a lot better =)

[Magtheridon96]

0XD00000? :D
I was trying to find that number for days :D
This snippet is very useful ^^

[Bribe]

Updated to use RegisterPlayerUnitEvent.

[Magtheridon96]

*Votes for approval*

[Dirac]

It would be great if this library provided with something such as GetUnitCurrentOrderX() and Y() to know where the unit is heading.

[Bribe]

That has nothing to do with this library. That has more to do with the LastOrder library on wc3c.net.

[Magtheridon96]

LastOrder? :D
I have been inspired ^^

[azlier]

Like RegisterPlayerUnitEvent, I think this can benefit from this post.

[Bribe]

Updated, code is much shorter now.

[Bribe]

Re-Added RegisterAnyOrderEvent. Is this fit for approval?

[watermelon_1234]

I can't think of a situation when I want to have an event detecting a specific order for all three cases of being immediate, point, or target and making me have to manually differentiate between them.
Because of this, I'm not sure when I would want to use this over RegisterPlayerUnitEvent and just filter out specific order ids.

Of course, I would be open to suggestions. :P

[Bribe]

What if you only wanted to detect Undefend, or only detect a "stop" or "attack" order?

[Troll-Brain]

I don't get why you talked about the stop and undefend order, i mean they obviously are a not target order.
Now, it quite makes sense for the attack order, since it can be a target or point order.

Or am i missing something ?