Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventListener


The base class of event listener.
If you need custom listener which with different callback, you need to inherit this class.
For instance, you could refer to EventListenerAcceleration, EventListenerKeyboard,
EventListenerTouchOneByOne, EventListenerCustom.


封装用户的事件处理逻辑。
注意:这是一个抽象类,开发者不应该直接实例化这个类,请参考 create

Hierarchy

Index

Constructors

constructor

  • newEventListener(type: number, listenerID: string, callback: function | null): EventListener

Properties

Private _fixedPriority

_fixedPriority: number = 0

Private _isEnabled

_isEnabled: boolean = true

Private _listenerID

_listenerID: string

Private _node

_node: any = null

Protected onEvent

onEvent: function | null

Private _paused

_paused: boolean = true

Optional _previousIn

_previousIn: undefined | false | true = false

Private _registered

_registered: boolean = false

_target

_target: any = null

Private _type

_type: number

mask

mask: IListenerMask | null = null

owner

owner: Object | null = null

Static ACCELERATION

ACCELERATION: number = 6

The type code of acceleration event listener.

Static CUSTOM

CUSTOM: number = 8

The type code of custom event listener.

Static KEYBOARD

KEYBOARD: number = 3

The type code of keyboard event listener.

Static MOUSE

MOUSE: number = 4

The type code of mouse event listener.

Static TOUCH_ALL_AT_ONCE

TOUCH_ALL_AT_ONCE: number = 2

The type code of all at once touch event listener.

Static TOUCH_ONE_BY_ONE

TOUCH_ONE_BY_ONE: number = 1

The type code of one by one touch event listener.

Static UNKNOWN

UNKNOWN: number = 0

The type code of unknown event listener.

Accessors

onEvent

  • get onEvent(): null | function

Methods

getFixedPriority

  • _getFixedPriority(): number

getListenerID

  • _getListenerID(): string

getSceneGraphPriority

  • _getSceneGraphPriority(): any

getType

  • _getType(): number

isPaused

  • _isPaused(): boolean

Private isRegistered

  • _isRegistered(): boolean

setFixedPriority

  • setFixedPriority(fixedPriority: number): void
  • Sets the fixed priority for this listener
    note: This method is only used for fixed priority listeners,
    it needs to access a non-zero value. 0 is reserved for scene graph priority listeners

    Parameters

    • fixedPriority: number

    Returns void

setPaused

  • setPaused(paused: boolean): void

  • Sets paused state for the listener
    The paused state is only used for scene graph priority listeners.
    `EventDispatcher::resumeAllEventListenersForTarget(node)` will set the paused state to `true`,
    while `EventDispatcher::pauseAllEventListenersForTarget(node)` will set it to `false`.
    @note 1) Fixed priority listeners will never get paused. If a fixed priority doesn't want to receive events,
    call `setEnabled(false)` instead.
    2) In `Node`'s onEnter and onExit, the `paused state` of the listeners
    which associated with that node will be automatically updated.


    Parameters

    • paused: boolean

    Returns void

setRegistered

  • setRegistered(registered: boolean): void

setSceneGraphPriority

  • setSceneGraphPriority(node: any): void

checkAvailable

  • checkAvailable(): boolean

clone

isEnabled

  • isEnabled(): boolean

setEnabled

  • setEnabled(enabled: boolean): void
  • Enables or disables the listener
    note: Only listeners with enabled state will be able to receive events.
    When an listener was initialized, it's enabled by default.
    An event listener can receive events when it is enabled and is not paused.
    paused state is always false when it is a fixed priority listener.

    Parameters

    • enabled: boolean

    Returns void

Static create

  • Create a EventListener object with configuration including the event type, handlers and other parameters.
    In handlers, this refer to the event listener object itself.
    You can also pass custom parameters in the configuration object,
    all custom parameters will be polyfilled into the event listener object and can be accessed in handlers.

    Parameters

    Returns EventListener

Object literals

Static ListenerID

ListenerID: object

ACCELERATION

ACCELERATION: string = "__cc_acceleration"

KEYBOARD

KEYBOARD: string = "__cc_keyboard"

MOUSE

MOUSE: string = "__cc_mouse"

TOUCH_ALL_AT_ONCE

TOUCH_ALL_AT_ONCE: string = "__cc_touch_all_at_once"

TOUCH_ONE_BY_ONE

TOUCH_ONE_BY_ONE: string = "__cc_touch_one_by_one"

Generated using TypeDoc