BlzUnitCancelTimedLife

Parameters

whichUnit

unit

comment

Removes a unit's timed life, therefore killing it.

Does nothing when used on a regular unit.

note

Internally the code is similar to UnitRemoveAbility.

note

Example (Lua):

-- creates a permanent water elemental, without timed life
waterElem = CreateUnit(Player(0), FourCC("hwat"), -30, 0, 90)

-- applies 30 second timed life
UnitApplyTimedLife(waterElem, FourCC("BHwe"), 30)

-- removes and kills the elemental
BlzUnitCancelTimedLife(waterElem)

note

See: UnitApplyTimedLife, UnitPauseTimedLife

patch

1.29.2.9231

Source

common.j (raise an issue to discuss on Github or submit a PR)

return type

nothing

Source code

native BlzUnitCancelTimedLife                      takes unit whichUnit returns nothing