Interface PointerEventsSystem

Hierarchy

PointerEventsSystem

Index

Methods

onPointerDown onPointerDrag onPointerDragEnd onPointerDragLocked onPointerHoverEnter onPointerHoverLeave onPointerUp removeOnPointerDown removeOnPointerDrag removeOnPointerDragEnd removeOnPointerDragLocked removeOnPointerHoverEnter removeOnPointerHoverLeave removeOnPointerUp

Methods

onPointerDown

onPointerDown(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user press the InputButton pointing at the entity
Parameters
- pointerData: {
  entity: Entity;
  opts?: Partial<EventSystemOptions>;
  }
  
  Entity to attach the callback, Opts to trigger Feedback and Button
  - entity: Entity
  - Optional opts?: Partial<EventSystemOptions>
- cb: EventSystemCallback
  
  Function to execute when click fires
Returns void
- Defined in ecs/dist/systems/events.d.ts:73
onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void
Deprecated
Use onPointerDown with (pointerData, cb)
Parameters
- entity: Entity
  
  Entity to attach the callback
- cb: EventSystemCallback
  
  Function to execute when click fires
- Optional opts: Partial<EventSystemOptions>
  
  Opts to trigger Feedback and Button
Returns void
- Defined in ecs/dist/systems/events.d.ts:83

onPointerDrag

onPointerDrag(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user clicks and drags the pointer from inside the entity
Parameters
- pointerData: {
  entity: Entity;
  opts?: Partial<EventSystemOptions>;
  }
  
  Entity to attach the callback - Opts to trigger Feedback and Button
  - entity: Entity
  - Optional opts?: Partial<EventSystemOptions>
- cb: EventSystemCallback
  
  Function to execute when click fires
Returns void
- Defined in ecs/dist/systems/events.d.ts:127

onPointerDragEnd

onPointerDragEnd(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user releases the button after a drag
Parameters
- pointerData: {
  entity: Entity;
  opts?: Partial<EventSystemOptions>;
  }
  
  Entity to attach the callback - Opts to trigger Feedback and Button
  - entity: Entity
  - Optional opts?: Partial<EventSystemOptions>
- cb: EventSystemCallback
  
  Function to execute when click fires
Returns void
- Defined in ecs/dist/systems/events.d.ts:148

onPointerDragLocked

onPointerDragLocked(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user clicks and drags the pointer from inside the entity, locking the cursor in place
Parameters
- pointerData: {
  entity: Entity;
  opts?: Partial<EventSystemOptions>;
  }
  
  Entity to attach the callback - Opts to trigger Feedback and Button
  - entity: Entity
  - Optional opts?: Partial<EventSystemOptions>
- cb: EventSystemCallback
  
  Function to execute when click fires
Returns void
- Defined in ecs/dist/systems/events.d.ts:138

onPointerHoverEnter

onPointerHoverEnter(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user place the pointer over the entity
Parameters
- pointerData: {
  entity: Entity;
  opts?: Partial<EventSystemOptions>;
  }
  
  Entity to attach the callback - Opts to trigger Feedback and Button
  - entity: Entity
  - Optional opts?: Partial<EventSystemOptions>
- cb: EventSystemCallback
  
  Function to execute when click fires
Returns void
- Defined in ecs/dist/systems/events.d.ts:107

onPointerHoverLeave

onPointerHoverLeave(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user take the pointer out of the entity
Parameters
- pointerData: {
  entity: Entity;
  opts?: Partial<EventSystemOptions>;
  }
  
  Entity to attach the callback - Opts to trigger Feedback and Button
  - entity: Entity
  - Optional opts?: Partial<EventSystemOptions>
- cb: EventSystemCallback
  
  Function to execute when click fires
Returns void
- Defined in ecs/dist/systems/events.d.ts:117

onPointerUp

onPointerUp(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user releases the InputButton pointing at the entity
Parameters
- pointerData: {
  entity: Entity;
  opts?: Partial<EventSystemOptions>;
  }
  
  Entity to attach the callback - Opts to trigger Feedback and Button
  - entity: Entity
  - Optional opts?: Partial<EventSystemOptions>
- cb: EventSystemCallback
  
  Function to execute when click fires
Returns void
- Defined in ecs/dist/systems/events.d.ts:90
onPointerUp(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void
Deprecated
Use onPointerUp with (pointerData, cb)
Parameters
- entity: Entity
  
  Entity to attach the callback
- cb: EventSystemCallback
  
  Function to execute when click fires
- Optional opts: Partial<EventSystemOptions>
  
  Opts to trigger Feedback and Button
Returns void
- Defined in ecs/dist/systems/events.d.ts:100

removeOnPointerDown

removeOnPointerDown(entity: Entity): void
Remove the callback for onPointerDown event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in ecs/dist/systems/events.d.ts:30

removeOnPointerDrag

removeOnPointerDrag(entity: Entity): void
Remove the callback for onPointerDrag event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in ecs/dist/systems/events.d.ts:54

removeOnPointerDragEnd

removeOnPointerDragEnd(entity: Entity): void
Remove the callback for onPointerDragEnd event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in ecs/dist/systems/events.d.ts:66

removeOnPointerDragLocked

removeOnPointerDragLocked(entity: Entity): void
Remove the callback for onPointerDragLocked event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in ecs/dist/systems/events.d.ts:60

removeOnPointerHoverEnter

removeOnPointerHoverEnter(entity: Entity): void
Remove the callback for onPointerHoverEnter event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in ecs/dist/systems/events.d.ts:42

removeOnPointerHoverLeave

removeOnPointerHoverLeave(entity: Entity): void
Remove the callback for onPointerHoverLeave event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in ecs/dist/systems/events.d.ts:48

removeOnPointerUp

removeOnPointerUp(entity: Entity): void
Remove the callback for onPointerUp event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in ecs/dist/systems/events.d.ts:36

Interface PointerEventsSystem

Hierarchy

Index

Methods

Methods

onPointerDown

Parameters

pointerData: { entity: Entity; opts?: Partial<EventSystemOptions>; }

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

Deprecated

Parameters

entity: Entity

cb: EventSystemCallback

Optional opts: Partial<EventSystemOptions>

Returns void

onPointerDrag

Parameters

pointerData: { entity: Entity; opts?: Partial<EventSystemOptions>; }

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

onPointerDragEnd

Parameters

pointerData: { entity: Entity; opts?: Partial<EventSystemOptions>; }

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

onPointerDragLocked

Parameters

pointerData: { entity: Entity; opts?: Partial<EventSystemOptions>; }

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

onPointerHoverEnter

Parameters

pointerData: { entity: Entity; opts?: Partial<EventSystemOptions>; }

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

onPointerHoverLeave

Parameters

pointerData: { entity: Entity; opts?: Partial<EventSystemOptions>; }

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

onPointerUp

Parameters

pointerData: { entity: Entity; opts?: Partial<EventSystemOptions>; }

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

Deprecated

Parameters

entity: Entity

cb: EventSystemCallback

Optional opts: Partial<EventSystemOptions>

Returns void

removeOnPointerDown

Parameters

entity: Entity

Returns void

removeOnPointerDrag

Parameters

entity: Entity

Returns void

removeOnPointerDragEnd

Parameters

entity: Entity

Returns void

removeOnPointerDragLocked

Parameters

pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}

`Optional` opts?: Partial<EventSystemOptions>

`Optional` opts: Partial<EventSystemOptions>

pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}

`Optional` opts?: Partial<EventSystemOptions>

pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}

`Optional` opts?: Partial<EventSystemOptions>

pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}

`Optional` opts?: Partial<EventSystemOptions>

pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}

`Optional` opts?: Partial<EventSystemOptions>

pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}

`Optional` opts?: Partial<EventSystemOptions>

pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}

`Optional` opts?: Partial<EventSystemOptions>

`Optional` opts: Partial<EventSystemOptions>