---

Trigger API Reference\DCEI Events\Region

RegionUnitTriggerHandle TriggerAddUnitEnterRegionEvent(unit unit, Region region, TypedCallback trigger)

RegionUnitTriggerHandle TriggerAddUnitEnterRegionEvent(unit unit, Region region, TypedCallback trigger)

Description

This event is triggered when the specified unit enters the specified region. You can use DCEI.TriggeringUnit/DCEI.TriggeringRegion to get the event unit/region in the trigger callback.

Parameters

• unit unit the unit to trigger the event.
• Region region the region for the unit to enter. Use DCEI.RegionAny to trigger this event for any region.
• TypedCallback trigger the callback function that is called when the event is triggered.

Example Usage

function OnRegionEnter()
    local u = DCEI.TriggeringUnit
    local r = DCEI.TriggeringRegion

    local region_name = DCEI.GetRegionName(r)
    if region_name = "goal_region" then
        SCORE = SCORE + 1
    end
end

DCEI.TriggerAddUnitEnterRegionEvent(DCEI.CreateUnitFilter({name = DCEI.Unit("Test Unit")}), DCEI.RegionAny, OnRegionEnter)

#### Related

• RemoveRegion
• GetRegionName
• RevealRegion
• MoveRegion
  

RegionUnitTriggerHandle TriggerAddUnitLeaveRegionEvent(unit unit, Region region, TypedCallback trigger)

RegionUnitTriggerHandle TriggerAddUnitLeaveRegionEvent(unit unit, Region region, TypedCallback trigger)

Description

This event is triggered when the specified unit leaves the specified region. You can use DCEI.TriggeringUnit/DCEI.TriggeringRegion to get the event unit/region in the trigger callback.

Parameters

• unit unit the unit to trigger the event.
• Region region the region for the unit to leave. Use DCEI.RegionAny to trigger this event for any region.
• TypedCallback trigger the callback function that is called when the event is triggered.

Example Usage

function OnRegionLeave()
    local r = DCEI.TriggeringRegion
    DCEI.RemoveRegion(r)
end

DCEI.TriggerAddUnitLeaveRegionEvent(DCEI.CreateUnitFilter({name = DCEI.Unit("Test Unit")}), region, OnRegionLeave)

#### Related

• CreateRegion
• RemoveRegion
• HideRegion