Interface TriggerAreaEventsSystem

Hierarchy

TriggerAreaEventsSystem

Index

Methods

onTriggerEnter onTriggerExit onTriggerStay removeOnTriggerEnter removeOnTriggerExit removeOnTriggerStay

Methods

onTriggerEnter

onTriggerEnter(entity: Entity, cb: TriggerAreaEventSystemCallback): void
Execute callback when an entity enters the Trigger Area
Parameters
- entity: Entity
  
  The entity that already has the TriggerArea component
- cb: TriggerAreaEventSystemCallback
  
  Function to execute the 'Enter' type of result is detected
Returns void
- Defined in ecs/dist/systems/triggerArea.d.ts:17

onTriggerExit

onTriggerExit(entity: Entity, cb: TriggerAreaEventSystemCallback): void
Execute callback when an entity exits the Trigger Area
Parameters
- entity: Entity
  
  The entity that already has the TriggerArea component
- cb: TriggerAreaEventSystemCallback
  
  Function to execute the 'Exit' type of result is detected
Returns void
- Defined in ecs/dist/systems/triggerArea.d.ts:43

onTriggerStay

onTriggerStay(entity: Entity, cb: TriggerAreaEventSystemCallback): 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
Returns void
- Defined in ecs/dist/systems/triggerArea.d.ts:30

removeOnTriggerEnter

removeOnTriggerEnter(entity: Entity): void
Remove the callback for Trigger Area 'Enter' type of result
Parameters
- entity: Entity
  
  Entity where the Trigger Area was attached
Returns void
- Defined in ecs/dist/systems/triggerArea.d.ts:23

removeOnTriggerExit

removeOnTriggerExit(entity: Entity): void
Remove the callback for Trigger Area 'Exit' type of result
Parameters
- entity: Entity
  
  Entity where the Trigger Area was attached
Returns void
- Defined in ecs/dist/systems/triggerArea.d.ts:49

removeOnTriggerStay

removeOnTriggerStay(entity: Entity): void
Remove the callback for Trigger Area 'Stay' type of result
Parameters
- entity: Entity
  
  Entity where the Trigger Area was attached
Returns void
- Defined in ecs/dist/systems/triggerArea.d.ts:36