Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KeyboardEvent

A KeyboardEvent is dispatched in response to user input through a keyboard.

This is Starling's version of the Flash KeyboardEvent class. It contains the same properties as the Flash equivalent.

To be notified of keyboard events, add an event listener to any display object that is part of your display tree. Starling has no concept of a "Focus" like native Flash.

@see starling.display.Stage

Hierarchy

Index

Constructors

constructor

  • new KeyboardEvent(type: string, charCode?: number, keyCode?: number, keyLocation?: number, ctrlKey?: boolean, altKey?: boolean, shiftKey?: boolean): KeyboardEvent

Properties

altKey

altKey: boolean

Indicates whether the Alt key is active on Windows or Linux; indicates whether the Option key is active on Mac OS.

bubbles

bubbles: boolean

Indicates if event will bubble.

charCode

charCode: number

Contains the character code of the key.

ctrlKey

ctrlKey: boolean

Indicates whether the Ctrl key is active on Windows or Linux; indicates whether either the Ctrl or the Command key is active on Mac OS.

currentTarget

currentTarget: EventDispatcher

The object the event is currently bubbling at.

data

data: any

Arbitrary data that is attached to the event.

keyCode

keyCode: number

The key code of the key.

keyLocation

keyLocation: number

Indicates the location of the key on the keyboard. This is useful for differentiating keys that appear more than once on a keyboard. @see Keylocation

shiftKey

shiftKey: boolean

Indicates whether the Shift key modifier is active (true) or inactive (false).

target

The object that dispatched the event.

type

type: string

A string that identifies the event.

Static ADDED

ADDED: string

Event type for a display object that is added to a parent.

Static ADDED_TO_STAGE

ADDED_TO_STAGE: string

Event type for a display object that is added to the stage

Static CANCEL

CANCEL: string

An event type to be utilized in custom events. Not used by Starling right now.

Static CHANGE

CHANGE: string

An event type to be utilized in custom events. Not used by Starling right now.

Static CLOSE

CLOSE: string

An event type to be utilized in custom events. Not used by Starling right now.

Static COMPLETE

COMPLETE: string

Event type that may be used whenever something finishes.

Static CONTEXT3D_CREATE

CONTEXT3D_CREATE: string

Event type for a (re)created stage3D rendering context.

Static ENTER_FRAME

ENTER_FRAME: string

Event type for a display object that is entering a new frame.

Static FATAL_ERROR

FATAL_ERROR: string

Event type that is dispatched by the Starling instance when it encounters a problem from which it cannot recover, e.g. a lost device context.

Static IO_ERROR

IO_ERROR: string

Event type that is dispatched by the AssetManager when a file/url cannot be loaded.

Static KEY_DOWN

KEY_DOWN: string

Event type for a key that was pressed.

Static KEY_UP

KEY_UP: string

Event type for a key that was released.

Static OPEN

OPEN: string

An event type to be utilized in custom events. Not used by Starling right now.

Static PARSE_ERROR

PARSE_ERROR: string

Event type that is dispatched by the AssetManager when an xml or json file couldn't be parsed.

Static READY

READY: string

An event type to be utilized in custom events. Not used by Starling right now.

Static REMOVED

REMOVED: string

Event type for a display object that is removed from its parent.

Static REMOVED_FROM_STAGE

REMOVED_FROM_STAGE: string

Event type for a display object that is removed from the stage.

Static REMOVE_FROM_JUGGLER

REMOVE_FROM_JUGGLER: string

Event type for an animated object that requests to be removed from the juggler.

Static RENDER

RENDER: string

Event type that is dispatched by the Starling instance directly before rendering.

Static RESIZE

RESIZE: string

Event type for a resized Flash Player.

Static ROOT_CREATED

ROOT_CREATED: string

Event type that indicates that the root DisplayObject has been created.

Static SCROLL

SCROLL: string

An event type to be utilized in custom events. Not used by Starling right now.

Static SECURITY_ERROR

SECURITY_ERROR: string

Event type that is dispatched by the AssetManager when a file/url cannot be loaded.

Static SELECT

SELECT: string

An event type to be utilized in custom events. Not used by Starling right now.

Static TEXTURES_RESTORED

TEXTURES_RESTORED: string

Event type that is dispatched by the AssetManager after a context loss.

Static TRIGGERED

TRIGGERED: string

Event type for a triggered button.

Static UPDATE

UPDATE: string

An event type to be utilized in custom events. Not used by Starling right now.

Methods

Protected get_altKey

  • get_altKey(): boolean

Protected get_charCode

  • get_charCode(): number

Protected get_ctrlKey

  • get_ctrlKey(): boolean

Protected get_keyCode

  • get_keyCode(): number

Protected get_keyLocation

  • get_keyLocation(): number

Protected get_shiftKey

  • get_shiftKey(): boolean

isDefaultPrevented

  • isDefaultPrevented(): boolean

preventDefault

  • preventDefault(): void

stopImmediatePropagation

  • stopImmediatePropagation(): void

stopPropagation

  • stopPropagation(): void

toString

  • toString(): string

Generated using TypeDoc