[Snippet] UnitRallyPoint

[Magtheridon96]

This resource provides you with 2 nifty functions that return the coordinates of a unit's rally point.

/*******************************************
*
*   UnitRallyPoint
*   v1.0.0.0
*   By Magtheridon96
*
*   - Provides GetUnitRallyPointX and GetUnitRallyPointY
*
*   API:
*   ----
*
*       - function GetUnitRallyPointX takes unit u returns real
*           - Returns the x coordinate of the rally point for a given unit
*       - function GetUnitRallyPointY takes unit u returns real
*           - Returns the y coordinate of the rally point for a given unit
*
*******************************************/
library UnitRallyPoint
    
    globals
        private location loc
    endglobals
    
    function GetUnitRallyPointX takes unit u returns real
        local real x
        set loc = GetUnitRallyPoint(u)
        set x = GetLocationX(loc)
        call RemoveLocation(loc)
        return x
    endfunction
    
    function GetUnitRallyPointY takes unit u returns real
        local real y
        set loc = GetUnitRallyPoint(u)
        set y = GetLocationY(loc)
        call RemoveLocation(loc)
        return y
    endfunction
    
endlibrary

Short, sweet and simple.
Feel free to comment..

 

[Bribe]

Not a good idea because the user would do better to create the location once, then get the x,y from the same location. Maybe you could do like TerrainPathability did and make TerrainPathability_X/Y

Also this belongs in SCS (Small Code Snippets)

 

[Magtheridon96]

Not a good idea because the user would do better to create the location once, then get the x,y from the same location.

Well, that didn't occur to me D:
I should've thought twice before posting this :c

Also this belongs in SCS (Small Code Snippets)

Or the graveyard

 

[WaterKnight]

Not a good idea because the user would do better to create the location once, then get the x,y from the same location.

The cost is ridiculously minor, how would you need it frequently? You could also save the rally point via order event. If it was for performance, I would hardly import any library/snippet.

 

[Magtheridon96]

You could also save the rally point via order event.

That's exactly what I did at first, but then I thought:

how would you need it frequently?

And thus, I realized that the overhead is extremely large when compared to how often this function will be used

edit
Either way, I'll put this in the SCS.

edit
Ok, TO THE GRAVEYARD WITH THIS.