Trigger API Reference DCEI Events Region0 - BLKTower/TestWiki GitHub Wiki

Table of Contents

Trigger API Reference\DCEI Events\Region {Trigger-API-ReferenceDCEI-EventsRegion}

void TriggerAddUnitEnterRegionEvent(unit unit, Region region, TypedCallback trigger) {void-TriggerAddUnitEnterRegionEventunit-unit-Region-region-TypedCallback-trigger}

void 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. Use DCEI.UnitAny to trigger this event for any unit.
  • Region region the region for the unit to enter. Use DCEI.RegionAny to trigger this event for any region.
  • object 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.RegionName(r)
    if region_name = "goal_region" then
        SCORE = SCORE + 1
    end
end

DCEI.TriggerAddUnitEnterRegionEvent(DCEI.UnitAny, DCEI.RegionAny, OnRegionEnter)

Related

void TriggerAddUnitLeaveRegionEvent(unit unit, Region region, TypedCallback trigger) {void-TriggerAddUnitLeaveRegionEventunit-unit-Region-region-TypedCallback-trigger}

void 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. Use DCEI.UnitAny to trigger this event for any unit.
  • Region region the region for the unit to leave. Use DCEI.RegionAny to trigger this event for any region.
  • object trigger the callback function that is called when the event is triggered.

Example Usage

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

DCEI.TriggerAddUnitLeaveRegionEvent(DCEI.UnitAny, region, OnRegionLeave)

Related

⚠️ **GitHub.com Fallback** ⚠️