@orillusion/core

---

Class: KeyEvent

Defined in: src/event/eventConst/KeyEvent.ts:7

enum keyboard eventInputSystem

Extends

• CEvent

Constructors

Constructor

new KeyEvent(eventType?, data?): KeyEvent

Defined in: src/event/CEvent.ts:102

Create a new event, with type and data

Parameters

eventType?

string = null

{any} eventType

data?

any = null

{any} param

Returns

KeyEvent

Inherited from

CEvent.constructor

Properties

target

target: Object3D

Defined in: src/event/CEvent.ts:13

Event target, it's usually event dispatcher

Inherited from

CEvent.target

---

currentTarget

currentTarget: CEventListener

Defined in: src/event/CEvent.ts:18

Current event target, it's current bubble object

Inherited from

CEvent.currentTarget

---

type

type: string

Defined in: src/event/CEvent.ts:23

event type, it's registered string of key

Inherited from

CEvent.type

---

data?

optional data?: any

Defined in: src/event/CEvent.ts:28

extra data.Used for the transmission process of events, carrying data

Inherited from

CEvent.data

---

param

param: any

Defined in: src/event/CEvent.ts:34

The param data when event is registered

Inherited from

CEvent.param

---

time

time: number = 0

Defined in: src/event/CEvent.ts:40

the time when event is

Inherited from

CEvent.time

---

delay

delay: number = 0

Defined in: src/event/CEvent.ts:46

the delay time when event is dispatched.

Inherited from

CEvent.delay

---

mouseCode

mouseCode: number = 0

Defined in: src/event/CEvent.ts:52

mouse code, see

Mouse Code

MouseCode

Inherited from

CEvent.mouseCode

---

ctrlKey

ctrlKey: boolean

Defined in: src/event/CEvent.ts:57

Is Ctrl key pressed when the event occurs

Inherited from

CEvent.ctrlKey

---

metaKey

metaKey: boolean

Defined in: src/event/CEvent.ts:62

Is Meta key pressed when the event occurs

Inherited from

CEvent.metaKey

---

altKey

altKey: boolean

Defined in: src/event/CEvent.ts:67

Is Alt key pressed when the event occurs

Inherited from

CEvent.altKey

---

shiftKey

shiftKey: boolean

Defined in: src/event/CEvent.ts:72

Is Shift key pressed when the event occurs

Inherited from

CEvent.shiftKey

---

targetTouches

targetTouches: TouchData[]

Defined in: src/event/CEvent.ts:77

Collection of finger touch points, which registered

Inherited from

CEvent.targetTouches

---

changedTouches

changedTouches: TouchData[]

Defined in: src/event/CEvent.ts:82

Collection of finger touch points changed

Inherited from

CEvent.changedTouches

---

touches

touches: TouchData[]

Defined in: src/event/CEvent.ts:87

Collection of finger touch points

Inherited from

CEvent.touches

---

view

view: View3D

Defined in: src/event/CEvent.ts:94

binded view3D object in event.

Inherited from

CEvent.view

---

KEY_DOWN

static KEY_DOWN: string = 'onKeyDown'

Defined in: src/event/eventConst/KeyEvent.ts:15

Constant Definition Key Press Event Identification Event response status: Responds every time the keyboard is pressed. Response event parameters: keyboard key

Platform

Web,Native

---

KEY_UP

static KEY_UP: string = 'onKeyUp'

Defined in: src/event/eventConst/KeyEvent.ts:24

Constant Definition Key up Event Identification Event response status: Responds every time the keyboard is released. Response event parameters: keyboard key

Platform

Web,Native

---

keyCode

keyCode: number = 0

Defined in: src/event/eventConst/KeyEvent.ts:32

Key code value, enumeration type see KeyCode KeyCode

Default

0

Platform

Web,Native

Accessors

isStopImmediatePropagation

Get Signature

get isStopImmediatePropagation(): boolean

Defined in: src/event/CEvent.ts:125

Returns stopImmediatePropagation value

Returns

boolean

Inherited from

CEvent.isStopImmediatePropagation

Methods

stopImmediatePropagation()

stopImmediatePropagation(): void

Defined in: src/event/CEvent.ts:110

Prevent bubbling of all event listeners in subsequent nodes of the current node in the event flow.

Returns

void

Inherited from

CEvent.stopImmediatePropagation