void TriggerAddUnitSelectedEvent(unit unit, TypedCallback trigger)

This event is triggered when a unit is selected.

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered.

local function OnUnitSelected()
    local unit = DCEI.TriggeringUnit
    local unit_name = DCEI.UnitName(unit)
    DCEI.LogMessage(unit_name .. " has been selected.")
end
    
DCEI.TriggerAddUnitSelectedEvent(DCEI.UnitAny, OnUnitSelected)

• UnitAny
• TriggeringUnit

void TriggerAddUnitDeselectedEvent(unit unit, TypedCallback trigger)

This event is triggered when a unit is deselected.

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered.

local function OnUnitDeselected()
    local unit = DCEI.TriggeringUnit
    local unit_name = DCEI.UnitName(unit)
    DCEI.LogMessage(unit_name .. " has been deselected.")
end

DCEI.TriggerAddUnitDeselectedEvent(DCEI.UnitAny, OnUnitDeselected)

• UnitAny
• TriggeringUnit

void TriggerAddUnitDamageEvent(unit unit, TypedCallback<float, unit> trigger, CriticalFilter filter)

This event is triggered when a unit is damaged. Inputs the damage done to the unit into the trigger as the first parameter, and passes the target unit to the second parameter.

Note: DCEI.Wait is explicitly disabled in callbacks for TriggerAddUnitDamageEvent, TriggerAddUnitCriticalDamageEvent, TriggerAddUnitHealEvent as these triggers may each fire multiple times per second and DCEI.Wait is relatively costly. To circumvent this, you should wrap trigger into a DCEI.TriggerAddTimerEventElapsed (or core.GameTimer).

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered.
• CriticalFilter filter whether this event is triggered on all damage event, or just critical ones, or just non-critical ones.

• Single amount
• Unit target_unit

local function OnUnitDamaged(damage, target_unit)
    local context = DCEI.TriggeringEffectContext
    local effect = DCEI.TriggeringEffectName
    local caster_name = DCEI.UnitName(context.caster)
    local source_name = DCEI.UnitName(context.source)
    local target_name = DCEI.UnitName(context.target)
    -- Alternatively;
    -- local target_name = DCEI.UnitName(target_unit)
    DCEI.LogMessage(target_name .. " was damaged for " .. damage .. " by " .. caster_name .. " via " .. source_name .. " through the use of " .. effect .. ".")
end

DCEI.TriggerAddUnitDamageEvent(DCEI.UnitAny, OnUnitDamaged, {critical_only = true})

• UnitAny
• TriggeringUnit
• TriggeringEffectContext
• TriggeringEffectId
• TriggeringEffectName

void TriggerAddUnitCriticalDamageEvent(unit unit, TypedCallback<float, unit> trigger)

This event is triggered when a unit is damaged by a critical hit from a weapon. Inputs the damage done to the unit into the trigger as the first parameter, and passes the target unit to the second parameter.

Note: DCEI.Wait is explicitly disabled in callbacks for TriggerAddUnitDamageEvent, TriggerAddUnitCriticalDamageEvent, TriggerAddUnitHealEvent as these triggers may each fire multiple times per second and DCEI.Wait is relatively costly. To circumvent this, you should wrap trigger into a DCEI.TriggerAddTimerEventElapsed (or core.GameTimer).

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered.

• Single amount
• Unit target_unit

local function OnUnitCriticalDamaged(damage, target_unit)
    local context = DCEI.TriggeringEffectContext
    local effect = DCEI.TriggeringEffectName
    local caster_name = DCEI.UnitName(context.caster)
    local source_name = DCEI.UnitName(context.source)
    local target_name = DCEI.UnitName(context.target)
    -- Alternatively;
    -- local target_name = DCEI.UnitName(target_unit)
    DCEI.LogMessage(target_name .. " was damaged for " .. damage .. " by " .. caster_name .. " via " .. source_name .. " through the use of " .. effect .. ".")
end

DCEI.TriggerAddUnitCriticalDamageEvent(DCEI.UnitAny, OnUnitCriticalDamaged)

• UnitAny
• TriggeringUnit
• TriggeringEffectContext
• TriggeringEffectId
• TriggeringEffectName

void TriggerAddUnitHealEvent(unit unit, TypedCallback<float, unit> trigger)

This event is triggered when a unit is healed. Inputs the amount healed by the unit into the trigger as the first parameter, and passes the target unit to the second parameter.

Note: DCEI.Wait is explicitly disabled in callbacks for TriggerAddUnitDamageEvent, TriggerAddUnitCriticalDamageEvent, TriggerAddUnitHealEvent as these triggers may each fire multiple times per second and DCEI.Wait is relatively costly. To circumvent this, you should wrap trigger into a DCEI.TriggerAddTimerEventElapsed (or core.GameTimer).

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered.

• Single amount
• Unit target_unit

local function OnUnitHealed(amount, target_unit)
    local context = DCEI.TriggeringEffectContext
    local effect = DCEI.TriggeringEffectName
    local caster_name = DCEI.UnitName(context.caster)
    local source_name = DCEI.UnitName(context.source)
    local target_name = DCEI.UnitName(context.target)
    -- Alternatively;
    -- local target_name = DCEI.UnitName(target_unit)
    DCEI.LogMessage(target_name .. " was healed for " .. amount .. " by " .. caster_name .. " via " .. source_name .. " through the use of " .. effect .. ".")
end

DCEI.TriggerAddUnitHealEvent(DCEI.UnitAny, OnUnitHealed)

• UnitAny
• TriggeringUnit

void TriggerAddUnitSpawnEvent(unit unit, TypedCallback trigger, bool simple)

This event is triggered when a unit is spawned.

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered.
• bool simple this flag reduces overhead by preventing the usage of DCEI.Wait() within the trigger. You should only set this to true if the trigger does not utilize DCEI.Wait() at all.

local function OnUnitSpawned()
    local unit = DCEI.TriggeringUnit
    local name = DCEI.UnitName(unit)
    DCEI.LogMessage(name .. " was spawned.")
end

DCEI.TriggerAddUnitSpawnEvent(DCEI.UnitAny, OnUnitSpawned)

• UnitAny
• TriggeringUnit

void TriggerAddUnitDiedEvent(unit unit, TypedCallback<unit> trigger, bool simple)

This event is triggered when a unit dies.

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered. This function can also pass the killing unit as a parameter to the callback function.

• Unit killing_unit

local function OnUnitDeath(killing_unit)
    local unit = DCEI.TriggeringUnit
    local name = DCEI.UnitName(unit)
    local killing_unit_name = DCEI.UnitName(killing_unit)
    DCEI.LogMessage(killing_unit_name .. " has killed " .. name)
end

DCEI.TriggerAddUnitDiedEvent(DCEI.UnitAny, OnUnitDeath)

• UnitAny
• TriggeringUnit
• TriggerAddUnitRemovedEvent()

void TriggerAddUnitMoveCommandEvent(unit unit, TypedCallback<Float2> trigger)

This event is triggered when a unit starts moving. Inputs the destination into the first parameter of the trigger as a float2 value.

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered.

• Float2 target_position

local function OnUnitMoveCommand(destination)
    local unit = DCEI.TriggeringUnit
    local unit_name = DCEI.UnitName(unit)
    local position = DCEI.GetUnitPosition2D(unit)

    local message = string.format("%q is moving to (%.2f, %.2f) from (%.2f, %.2f).", unit_name, destination.x, destination.y, position.x, position.y)
    DCEI.LogMessage(message)
end

DCEI.TriggerAddUnitMoveCommandEvent(DCEI.UnitAny, OnUnitMoveCommand)

• UnitAny
• TriggeringUnit
• GetUnitPosition2D()

void TriggerAddOnUnitIdleEvent(unit unit, TypedCallback trigger)

This event is triggered when a unit goes into the idle state (no commands queued).

Note: The unit must be set, DCEI.UnitAny does not work for this event.

• unit unit the unit that triggers this event.
• object trigger the callback function that is run when the event is triggered.

local team_id = 1
local player_id = 1
local unit_type = "Standard MeleeUnit"
local x, y = 16, 16
local test_subject = DCEI.CreateUnitAsync(team_id, player_id, unit_type, x, y)

local function OnUnitIdle()
    local unit = DCEI.TriggeringUnit
    local unit_name = DCEI.UnitName(unit)

    DCEI.LogMessage(unit_name .. " has become idle.")
end

DCEI.TriggerAddOnUnitIdleEvent(test_subject, OnUnitIdle)

• UnitAny
• TriggeringUnit

void TriggerAddUnitRemovedEvent(unit unit, TypedCallback trigger, bool simple)

This event is triggered when a unit is removed.

• unit unit the unit that triggers this event. Use DCEI.UnitAny to trigger this event for any unit.
• object trigger the callback function that is run when the event is triggered.
• bool simple this flag reduces overhead by preventing the usage of DCEI.Wait() within the trigger. You should only set this to true if the trigger does not utilize DCEI.Wait() at all.

local function OnUnitRemoved()
    local unit = DCEI.TriggeringUnit
    local unit_name = DCEI.UnitName(unit)

    DCEI.LogMessage(unit_name .. " has been removed.")
end

DCEI.TriggerAddUnitRemovedEvent(DCEI.UnitAny, OnUnitRemoved)

• UnitAny
• TriggeringUnit
• TriggerAddUnitDiedEvent()