Interface: FederatedEventTarget

PIXI.FederatedEventTarget

Describes the shape for a PIXI.FederatedEvent's' eventTarget.

Properties:
Name Type Description
children ReadonlyArray<PIXI.FederatedEventTarget>

The children of this event target.

cursor Cursor | string

The cursor preferred when the mouse pointer is hovering over.

eventMode PIXI.EventMode

The mode of interaction for this object

hitArea IHitArea | null

The hit-area specifies the area for which pointer events should be captured by this event target.

interactive boolean

Whether this event target should fire UI events.

interactiveChildren boolean

Whether this event target has any children that need UI events. This can be used optimize event propagation.

isInteractive () => boolean

Returns true if the DisplayObject has interactive 'static' or 'dynamic'

onclick PIXI.FederatedEventHandler | null

Handler for 'click' event

onglobalmousemove PIXI.FederatedEventHandler | null

Handler for 'globalmousemove' event

onglobalpointermove PIXI.FederatedEventHandler | null

Handler for 'globalpointermove' event

onglobaltouchmove PIXI.FederatedEventHandler | null

Handler for 'globaltouchmove' event

onmousedown PIXI.FederatedEventHandler | null

Handler for 'mousedown' event

onmouseenter PIXI.FederatedEventHandler | null

Handler for 'mouseenter' event

onmouseleave PIXI.FederatedEventHandler | null

Handler for 'mouseleave' event

onmousemove PIXI.FederatedEventHandler | null

Handler for 'mousemove' event

onmouseout PIXI.FederatedEventHandler | null

Handler for 'mouseout' event

onmouseover PIXI.FederatedEventHandler | null

Handler for 'mouseover' event

onmouseup PIXI.FederatedEventHandler | null

Handler for 'mouseup' event

onmouseupoutside PIXI.FederatedEventHandler | null

Handler for 'mouseupoutside' event

onpointercancel PIXI.FederatedEventHandler | null

Handler for 'pointercancel' event

onpointerdown PIXI.FederatedEventHandler | null

Handler for 'pointerdown' event

onpointerenter PIXI.FederatedEventHandler | null

Handler for 'pointerenter' event

onpointerleave PIXI.FederatedEventHandler | null

Handler for 'pointerleave' event

onpointermove PIXI.FederatedEventHandler | null

Handler for 'pointermove' event

onpointerout PIXI.FederatedEventHandler | null

Handler for 'pointerout' event

onpointerover PIXI.FederatedEventHandler | null

Handler for 'pointerover' event

onpointertap PIXI.FederatedEventHandler | null

Handler for 'pointertap' event

onpointerup PIXI.FederatedEventHandler | null

Handler for 'pointerup' event

onpointerupoutside PIXI.FederatedEventHandler | null

Handler for 'pointerupoutside' event

onrightclick PIXI.FederatedEventHandler | null

Handler for 'rightclick' event

onrightdown PIXI.FederatedEventHandler | null

Handler for 'rightdown' event

onrightup PIXI.FederatedEventHandler | null

Handler for 'rightup' event

onrightupoutside PIXI.FederatedEventHandler | null

Handler for 'rightupoutside' event

ontap PIXI.FederatedEventHandler | null

Handler for 'tap' event

ontouchcancel PIXI.FederatedEventHandler | null

Handler for 'touchcancel' event

ontouchend PIXI.FederatedEventHandler | null

Handler for 'touchend' event

ontouchendoutside PIXI.FederatedEventHandler | null

Handler for 'touchendoutside' event

ontouchmove PIXI.FederatedEventHandler | null

Handler for 'touchmove' event

ontouchstart PIXI.FederatedEventHandler | null

Handler for 'touchstart' event

onwheel PIXI.FederatedEventHandler<PIXI.FederatedWheelEvent> | null

Handler for 'wheel' event

parent PIXI.FederatedEventTarget

The parent of this event target.

Extends

  • utils.EventEmitter
  • EventTarget

Members

children ReadonlyArray<PIXI.FederatedEventTarget> readonly

The children of this event target.

cursor Cursor | string

The cursor preferred when the mouse pointer is hovering over.

eventMode PIXI.EventMode

The mode of interaction for this object

hitArea IHitArea | null

The hit-area specifies the area for which pointer events should be captured by this event target.

interactive boolean

Whether this event target should fire UI events.

interactiveChildren boolean

Whether this event target has any children that need UI events. This can be used optimize event propagation.

isInteractive () => boolean

Returns true if the DisplayObject has interactive 'static' or 'dynamic'

Handler for 'click' event

onglobalmousemove PIXI.FederatedEventHandler | null

Handler for 'globalmousemove' event

onglobalpointermove PIXI.FederatedEventHandler | null

Handler for 'globalpointermove' event

onglobaltouchmove PIXI.FederatedEventHandler | null

Handler for 'globaltouchmove' event

onmousedown PIXI.FederatedEventHandler | null

Handler for 'mousedown' event

onmouseenter PIXI.FederatedEventHandler | null

Handler for 'mouseenter' event

onmouseleave PIXI.FederatedEventHandler | null

Handler for 'mouseleave' event

onmousemove PIXI.FederatedEventHandler | null

Handler for 'mousemove' event

onmouseout PIXI.FederatedEventHandler | null

Handler for 'mouseout' event

onmouseover PIXI.FederatedEventHandler | null

Handler for 'mouseover' event

onmouseup PIXI.FederatedEventHandler | null

Handler for 'mouseup' event

onmouseupoutside PIXI.FederatedEventHandler | null

Handler for 'mouseupoutside' event

onpointercancel PIXI.FederatedEventHandler | null

Handler for 'pointercancel' event

onpointerdown PIXI.FederatedEventHandler | null

Handler for 'pointerdown' event

onpointerenter PIXI.FederatedEventHandler | null

Handler for 'pointerenter' event

onpointerleave PIXI.FederatedEventHandler | null

Handler for 'pointerleave' event

onpointermove PIXI.FederatedEventHandler | null

Handler for 'pointermove' event

onpointerout PIXI.FederatedEventHandler | null

Handler for 'pointerout' event

onpointerover PIXI.FederatedEventHandler | null

Handler for 'pointerover' event

onpointertap PIXI.FederatedEventHandler | null

Handler for 'pointertap' event

onpointerup PIXI.FederatedEventHandler | null

Handler for 'pointerup' event

onpointerupoutside PIXI.FederatedEventHandler | null

Handler for 'pointerupoutside' event

onrightclick PIXI.FederatedEventHandler | null

Handler for 'rightclick' event

onrightdown PIXI.FederatedEventHandler | null

Handler for 'rightdown' event

onrightup PIXI.FederatedEventHandler | null

Handler for 'rightup' event

onrightupoutside PIXI.FederatedEventHandler | null

Handler for 'rightupoutside' event

Handler for 'tap' event

ontouchcancel PIXI.FederatedEventHandler | null

Handler for 'touchcancel' event

ontouchend PIXI.FederatedEventHandler | null

Handler for 'touchend' event

ontouchendoutside PIXI.FederatedEventHandler | null

Handler for 'touchendoutside' event

ontouchmove PIXI.FederatedEventHandler | null

Handler for 'touchmove' event

ontouchstart PIXI.FederatedEventHandler | null

Handler for 'touchstart' event

Handler for 'wheel' event

parent PIXI.FederatedEventTarget readonly

The parent of this event target.

Methods

removeAllListeners (event) this

Remove all listeners, or those of the specified event.

Name Type Attributes Description
event string | Symbol <optional>
Returns:
Type Description
this