Snippet RemoveUnitEx

[TriggerHappy]

RemoveUnitEx​

by TriggerHappy187​

Introduction:

The script idea originally by Ammorth, though it did not work on units that have decayed and been removed.
This event registers when a unit is removed by the included RemoveUnitEx function. My script (hopefully) functions whether or not the unit has decayed.
I have tested it, though I could have been wrong, I set all the decay times in the gameplay constants to 0.50 then TSA'd 20 seconds and called RemoveUnitEx, and it still worked. Any other testing would be great

An example use of this would look like.

function test takes nothing returns nothing
    call BJDebugMsg("Unit Removed")
endfunction

//===========================================================================
function InitTrig_Untitled_Trigger_001 takes nothing returns nothing
    local trigger t = CreateTrigger()
    call TriggerRegisterRemoveUnitEvent(t, gg_unit_hfoo_0001)
    call TriggerAddAction(t, function test)
endfunction

The script

library RemoveUnitEx

globals
    private integer count = 0
    private unit lastRemovedUnit = null
endglobals

private struct index

    trigger t
    unit u

    static method create takes trigger t, unit u returns index
        local index i = index.allocate()
        set i.u = u
        set i.t = t
        return i
    endmethod
    
endstruct

function TriggerRegisterRemoveUnitEvent takes trigger whichTrigger, unit whichUnit returns nothing 
    local index i = index.create(whichTrigger, whichUnit)
    set count = count + 1
endfunction

function RemoveUnitEx takes unit u returns nothing
    local integer i = count
    local index d = i
    loop
        exitwhen i <= 0
        if u == d.u then
            call TriggerExecute(d.t)
            call d.destroy()
        endif
        set i = i - 1
        set d = i
    endloop
    set lastRemovedUnit = u
    call RemoveUnit(u)
endfunction

function GetLastRemovedUnit takes nothing returns unit
    return lastRemovedUnit
endfunction

endlibrary

 

[Azlier]

Why not make lastRemovedUnit non-private? Using GetLastRemovedUnit() just to get at a variable is just like using GetLastCreatedUnit() when we can use bj_lastCreatedUnit.

 

[TriggerHappy]

function GetLastRemovedUnit takes nothing returns unit
    return lastRemovedUnit
endfunction

Is inlined when jasshelper compiles.

I'd rather people not mess the global.

 

[Darius34]

The script idea originally by Ammorth, though it did not work on units that have decayed and been removed.

I think you've misunderstood - this doesn't fix the problem with Ammorth's original incarnation of the script. I can't see how units automatically removed by the game upon decaying would fire events with the code above.

Surely you tested Ammorth's version?

Side note: why would you want to remove a decayed, and hence already removed, unit? (That's a double-free, if I'm not mistaken - something you'd actually want to avoid, not encourage...)

 

[Flare]

You're never decreasing count when a struct instance is being destroyed, so your loop would constantly be getting larger

        if u == d.u then
            call TriggerExecute(d.t)
            call d.destroy()
            set count = count - 1 //here <img src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" class="smilie smilie--sprite smilie--sprite8" alt=":D" title="Big Grin    :D" loading="lazy" data-shortname=":D" />
        endif

I'd rather people not mess the global.

Well, it's not your responsibility to care for utter stupidity

Also, the fact that the event only works when you call RemoveUnitEx is a bit meh. If it'd work when a unit has fully decayed naturally, it might be much more useful

 

[AceHart]

> This event registers when a unit is removed by the included RemoveUnitEx function

So, this calls a function when I called RemoveUnitEx, and sets a global to the unit I passed?
Uhm... I clearly missed something here...

What is this doing?
And why would I need this?

 

[Tom_Kazansky]

At first glance, I think this would be useful for me because all units in my map have a struct attached to them. If I want to destroy the struct, I can only use the "unit dies" event, wait some times for decaying and destroy the struct, but I still worry about the "does not decay" units.
Well, but:

it did not work on units that have decayed

-----
"animated dead" units also considered as "removed" when they dies right ? also units who have their corpse used for "raise dead" are considered as "removed", right ?