Interface PointerEventsSystem

Hierarchy

PointerEventsSystem

Index

Methods

onPointerDown onPointerHoverEnter onPointerHoverLeave onPointerUp onProximityDown onProximityEnter onProximityLeave onProximityUp removeOnPointerDown removeOnPointerHoverEnter removeOnPointerHoverLeave removeOnPointerUp removeOnProximityDown removeOnProximityEnter removeOnProximityLeave removeOnProximityUp

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 packages/@dcl/ecs/dist/systems/events.d.ts:81
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 packages/@dcl/ecs/dist/systems/events.d.ts:91

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 packages/@dcl/ecs/dist/systems/events.d.ts:115

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 packages/@dcl/ecs/dist/systems/events.d.ts:125

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 packages/@dcl/ecs/dist/systems/events.d.ts:98
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 packages/@dcl/ecs/dist/systems/events.d.ts:108

onProximityDown

onProximityDown(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user presses the proximity button on 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 packages/@dcl/ecs/dist/systems/events.d.ts:135

onProximityEnter

onProximityEnter(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the entity enters the proximity zone of the user
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 event fires
Returns void
- Defined in packages/@dcl/ecs/dist/systems/events.d.ts:155

onProximityLeave

onProximityLeave(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the entity leaves the proximity zone of the user
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 event fires
Returns void
- Defined in packages/@dcl/ecs/dist/systems/events.d.ts:165

onProximityUp

onProximityUp(pointerData: {
entity: Entity;
opts?: Partial<EventSystemOptions>;
}, cb: EventSystemCallback): void
Execute callback when the user releases the proximity button on 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 event fires
Returns void
- Defined in packages/@dcl/ecs/dist/systems/events.d.ts:145

removeOnPointerDown

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

removeOnPointerHoverEnter

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

removeOnPointerHoverLeave

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

removeOnPointerUp

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

removeOnProximityDown

removeOnProximityDown(entity: Entity): void
Remove the callback for onProximityDown event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in packages/@dcl/ecs/dist/systems/events.d.ts:56

removeOnProximityEnter

removeOnProximityEnter(entity: Entity): void
Remove the callback for onProximityEnter event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in packages/@dcl/ecs/dist/systems/events.d.ts:68

removeOnProximityLeave

removeOnProximityLeave(entity: Entity): void
Remove the callback for onProximityLeave event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in packages/@dcl/ecs/dist/systems/events.d.ts:74

removeOnProximityUp

removeOnProximityUp(entity: Entity): void
Remove the callback for onProximityUp event
Parameters
- entity: Entity
  
  Entity where the callback was attached
Returns void
- Defined in packages/@dcl/ecs/dist/systems/events.d.ts:62

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

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

onProximityDown

Parameters

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

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

onProximityEnter

Parameters

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

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

onProximityLeave

Parameters

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

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

onProximityUp

Parameters

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

entity: Entity

Optional opts?: Partial<EventSystemOptions>

cb: EventSystemCallback

Returns void

removeOnPointerDown

Parameters

entity: Entity

Returns void

removeOnPointerHoverEnter

Parameters

entity: Entity

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>

`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>