Interface TriggerAreaEventsSystem

Hierarchy

  • TriggerAreaEventsSystem

Methods

  • Execute callback when an entity enters the Trigger Area

    Parameters

    Returns void

  • Execute callback when an entity exits the Trigger Area

    Parameters

    Returns void

  • Execute callback when an entity stays in the Trigger Area

    Parameters

    • entity: Entity

      The entity that already has the TriggerArea component

    • cb: TriggerAreaEventSystemCallback

      Function to execute the 'Stay' type of result is detected

      Note: stay callbacks are synthesized by the SDK on every tick between a wire ENTER and a wire EXIT. Wire-level TAET_STAY events (still emitted by legacy Explorers) are ignored entirely — they neither fire callbacks nor mutate state. The SDK is the sole source of onTriggerStay dispatches, driven from the ENTER/EXIT state machine.

    Returns void

  • Remove the callback for Trigger Area 'Enter' type of result

    Parameters

    • entity: Entity

      Entity where the Trigger Area was attached

    Returns void

  • Remove the callback for Trigger Area 'Exit' type of result

    Parameters

    • entity: Entity

      Entity where the Trigger Area was attached

    Returns void

  • Remove the callback for Trigger Area 'Stay' type of result

    Parameters

    • entity: Entity

      Entity where the Trigger Area was attached

    Returns void