API Docs for: 2.2.1
Show:

Event Class

Extends Object
Defined in: pixi/utils/Event.hx:6

Creates an homogenous object for tracking events so users can know what to expect.

Constructor

Event

(
  • target
  • name
  • [data]
)

Defined in pixi/utils/Event.hx:6

Parameters:

  • target Object

    The target object that the event is called on

  • name String

    The string name of the event that was triggered

  • [data] Object optional

    Arbitrary event data to pass along

Methods

stopImmediatePropagation

()

Defined in pixi/utils/Event.hx:25

Stops the propagation of events to sibling listeners (no longer calls any listeners).

stopPropagation

()

Defined in pixi/utils/Event.hx:18

Stops the propagation of events up the scene graph (prevents bubbling).

Properties

data

Object

Defined in pixi/utils/Event.hx:72

The data that was passed in with this event.

stopped

Bool private

Defined in pixi/utils/Event.hx:32

Tracks the state of bubbling propagation. Do not set this directly, instead use event.stopPropagation()

stoppedImmediate

Bool private

Defined in pixi/utils/Event.hx:43

Tracks the state of sibling listener propagation. Do not set this directly, instead use event.stopImmediatePropagation()

target

Dynamic

Defined in pixi/utils/Event.hx:54

The original target the event triggered on.

timeStamp

Number

Defined in pixi/utils/Event.hx:84

The timestamp when the event occurred.

type

String

Defined in pixi/utils/Event.hx:63

The string name of the event that this represents.