类 Event

En

Event is a collection of event types. Generally, when an event occurs, the Event object is passed as a parameter to the event listener.

Zh

Event 是事件类型的集合。一般当发生事件时,Event 对象将作为参数传递给事件侦听器。

索引

构造函数

constructor

new Event(): Event
返回 Event
- 定义于 src/layaAir/laya/events/Event.ts:455

属性

button

button: number = 0

En

The mouse button.

0: Main button, usually the left button
1: Auxiliary button, usually the middle button (wheel button)
2: Secondary button, usually the right button
3: Fourth button, typically the browser Back button
4: Fifth button, typically the browser Forward button

Zh

鼠标按键，

0：主按键，通常指鼠标左键
1：辅助按键，通常指鼠标滚轮中键
2：次按键，通常指鼠标右键
3：第四个按钮，通常指浏览器后退按钮
4：第五个按钮，通常指浏览器的前进按钮

currentTarget

currentTarget: any

En

The current propagation object of the event.

Zh

事件当前冒泡对象。

delta

delta: number = 0

En

The scroll wheel increments.

Zh

滚轮滑动增量。

isDblClick

isDblClick: boolean

En

Specifies whether this is a double-click.

Zh

是否双击。

nativeEvent

nativeEvent:
    | MouseEvent
    | TouchEvent
    | WheelEvent
    | KeyboardEvent

En

The original browser event.

Zh

原生浏览器事件。

target

target: any

En

The triggering object of the event.

Zh

事件目标触发对象。

touchId

touchId: number = 0

En

Unique identifier assigned to the touch point (as an int).

Zh

分配给触摸点的唯一标识号（作为 int）。

`只读`touchPos

touchPos: Point

En

The clicked position.

Zh

点击坐标。

type

type: string

En

The event type.

Zh

事件类型。

`静态` `只读`ADDED

ADDED = "added"

En

Defines the value of the type property of an added event object.

Zh

定义 added 事件对象的 type 属性值。

`静态` `只读`BLUR

BLUR = "blur"

En

Defines the value of the type property of a blur event object.

Zh

定义 blur 事件对象的 type 属性值。

`静态` `只读`CHANGE

CHANGE = "change"

En

Defines the value of the type property of a change event object.

Zh

定义 change 事件对象的 type 属性值。

`静态` `只读`CHANGED

CHANGED = "changed"

En

Defines the value of the type property of a changed event object.

Zh

定义 changed 事件对象的 type 属性值。

`静态` `只读`CLICK

CLICK = "click"

En

Defines the value of the type property of a click event object, triggered when a mouse click completes on a display object.

Zh

定义 click 事件对象的 type 属性值，用于鼠标点击对象后触发。

`静态` `只读`CLOSE

CLOSE = "close"

En

Defines the value of the type property of a close event object.

Zh

定义 close 事件对象的 type 属性值。

`静态` `只读`COLLISION_ENTER

COLLISION_ENTER = "collisionenter"

En

3DPhysical collision start.

Zh

3D物理碰撞开始。

`静态` `只读`COLLISION_EXIT

COLLISION_EXIT = "collisionexit"

En

3DPhysical collision end.

Zh

3D物理碰撞结束。

`静态` `只读`COLLISION_STAY

COLLISION_STAY = "collisionstay"

En

3DPhysical collision continues.

Zh

3D物理碰撞持续。

`静态` `只读`COMPLETE

COMPLETE = "complete"

En

Defines the value of the type property of a complete event object.

Zh

定义 complete 事件对象的 type 属性值。

`静态` `只读`DEVICE_LOST

DEVICE_LOST = "devicelost"

En

Triggered when the GPU device is lost.

Zh

显卡设备丢失时触发

`静态` `只读`DISPLAY

DISPLAY = "display"

En

Defines the value of the type property of a display event object.

Zh

定义 display 事件对象的 type 属性值。

`静态` `只读`DOUBLE_CLICK

DOUBLE_CLICK = "doubleclick"

En

Defines the value of the type property of a doubleclick event object.

Zh

定义 doubleclick 事件对象的 type 属性值。

`静态` `只读`DRAG_END

DRAG_END = "dragend"

En

Defines the value of the type property of a dragend event object, triggered when drag end.

Zh

定义 dragend 事件对象的 type 属性值，用于拖动结束后触发。

`静态` `只读`DRAG_MOVE

DRAG_MOVE = "dragmove"

En

Defines the value of the type property of a dragmove event object, triggered when dragging.

Zh

定义 dragmove 事件对象的 type 属性值，用于拖动中触发。

`静态` `只读`DRAG_START

DRAG_START = "dragstart"

En

Defines the value of the type property of a dragstart event object, triggered when drag start.

Zh

定义 dragstart 事件对象的 type 属性值，用于开始拖动后触发。

`静态` `只读`DROP

DROP = "drop"

En

Defines the value of the type property of a drop event object, triggered when drop occured.

Zh

定义 drop 事件对象的 type 属性值，用于拖动放置后触发。

`静态` `只读`EMPTY

EMPTY: Readonly<Event> = ...

En

An empty Event object. Used for event dispatch transfer.

Zh

一个空的 Event 对象。用于事件派发中转使用。

`静态` `只读`END

END = "end"

En

Defines the value of the type property of an end event object.

Zh

定义 end 事件对象的 type 属性值。

`静态` `只读`ENTER

ENTER = "enter"

En

Defines the value of the type property of an enter event object.

Zh

定义 enter 事件对象的 type 属性值。

`静态` `只读`ERROR

ERROR = "error"

En

Defines the value of the type property of an error event object.

Zh

定义 error 事件对象的 type 属性值。

`静态` `只读`FOCUS

FOCUS = "focus"

En

Defines the value of the type property of a focus event object.

Zh

定义 focus 事件对象的 type 属性值。

`静态` `只读`FOCUS_CHANGE

FOCUS_CHANGE = "focuschange"

En

Defines the value of the type property of a focuschange event object.

Zh

定义 focuschange 事件对象的 type 属性值。

`静态` `只读`FRAME

FRAME = "enterframe"

En

Defines the value of the type property of a enterframe event object.

Zh

定义 enterframe 事件对象的 type 属性值。

`静态` `只读`FULL_SCREEN_CHANGE

FULL_SCREEN_CHANGE = "fullscreenchange"

En

Triggered when the full screen state changes in the browser.

Zh

浏览器全屏更改时触发

`静态` `只读`INPUT

INPUT = "input"

En

Defines the value of the type property of an input event object.

Zh

定义 input 事件对象的 type 属性值。

`静态` `只读`JOINT_BREAK

JOINT_BREAK = "jointbreak"

En

Joint destruction.

Zh

关节破坏。

`静态` `只读`KEY_DOWN

KEY_DOWN = "keydown"

En

Defines the value of the type property of a keydown event object.

Zh

定义 keydown 事件对象的 type 属性值。

`静态` `只读`KEY_PRESS

KEY_PRESS = "keypress"

En

Defines the value of the type property of a keypress event object.

Zh

定义 keypress 事件对象的 type 属性值。

`静态` `只读`KEY_UP

KEY_UP = "keyup"

En

Defines the value of the type property of a keyup event object.

Zh

定义 keyup 事件对象的 type 属性值。

`静态` `只读`LABEL

LABEL = "label"

En

Defines the value of the type property of a label event object.

Zh

定义 label 事件对象的 type 属性值。

`静态` `只读`LAYER_CHANGE

LAYER_CHANGE = "layerChange"

En

Triggered when a 3D layer changes.

Zh

3D layer改变时触发。

`静态` `只读`LINK

LINK = "link"

En

Defines the value of the type property of a link event object.

Zh

定义 link 事件对象的 type 属性值。

`静态` `只读`LOADED

LOADED = "loaded"

En

Defines the value of the type property of a loaded event object.

Zh

定义 loaded 事件对象的 type 属性值。

`静态` `只读`MESSAGE

MESSAGE = "message"

En

Defines the value of the type property of a message event object.

Zh

定义 message 事件对象的 type 属性值。

`静态` `只读`MOUSE_DOWN

MOUSE_DOWN = "mousedown"

En

Defines the value of the type property of a mousedown event object, triggered when pressed on a display object.

Zh

定义 mousedown 事件对象的 type 属性值，用于在显示对象上按下后触发。

`静态` `只读`MOUSE_DRAG

MOUSE_DRAG = "mousedrag"

En

Defines the value of the type property of a mousedrag event object.

Zh

定义 mousedrag 事件对象的 type 属性值。

`静态` `只读`MOUSE_DRAG_END

MOUSE_DRAG_END = "mousedragend"

En

Defines the value of the type property of a mousedragend event object.

Zh

定义 mousedragend 事件对象的 type 属性值。

`静态` `只读`MOUSE_MOVE

MOUSE_MOVE = "mousemove"

En

Defines the value of the type property of a mousemove event object, triggered when mouse moves over a display object.

Zh

定义 mousemove 事件对象的 type 属性值，用于鼠标在对象身上进行移动后触发。

`静态` `只读`MOUSE_OUT

MOUSE_OUT = "mouseout"

En

Defines the value of the type property of a mouseout event object.

Zh

定义 mouseout 事件对象的 type 属性值。

`静态` `只读`MOUSE_OVER

MOUSE_OVER = "mouseover"

En

Defines the value of the type property of a mouseover event object.

Zh

定义 mouseover 事件对象的 type 属性值。

`静态` `只读`MOUSE_UP

MOUSE_UP = "mouseup"

En

Defines the value of the type property of a mouseup event object, triggered when released on a display object.

Zh

定义 mouseup 事件对象的 type 属性值，用于在显示对象抬起后触发。

`静态` `只读`MOUSE_WHEEL

MOUSE_WHEEL = "mousewheel"

En

Defines the value of the type property of a mousewheel event object.

Zh

定义 mousewheel 事件对象的 type 属性值。

`静态` `只读`MOVED

MOVED = "moved"

En

Defines the value of the type property of a moved event object.

Zh

定义 moved 事件对象的 type 属性值。

`静态` `只读`OPEN

OPEN = "open"

En

Defines the value of the type property of an open event object.

Zh

定义 open 事件对象的 type 属性值。

`静态` `只读`ORIENTATION_CHANGE

ORIENTATION_CHANGE = "orientationchange"

En

Defines the value of the type property of a orientationchange event object.

Zh

定义 orientationchange 事件对象的 type 属性值。

`静态` `只读`PAUSED

PAUSED = "paused"

En

Defines the value of the type property of a paused event object.

Zh

定义 paused 事件对象的 type 属性值。

`静态` `只读`PLAYED

PLAYED = "played"

En

Defines the value of the type property of a played event object.

Zh

定义 played 事件对象的 type 属性值。

`静态` `只读`PROGRESS

PROGRESS = "progress"

En

Defines the value of the type property of a progress event object.

Zh

定义 progress 事件对象的 type 属性值。

`静态` `只读`READY

READY = "ready"

En

Defines the value of the type property of a ready event object.

Zh

定义 ready 事件对象的 type 属性值。

`静态` `只读`REMOVED

REMOVED = "removed"

En

Defines the value of the type property of a removed event object.

Zh

定义 removed 事件对象的 type 属性值。

`静态` `只读`RENDER

RENDER = "render"

En

Defines the value of the type property of a render event object.

Zh

定义 render 事件对象的 type 属性值。

`静态` `只读`RESIZE

RESIZE = "resize"

En

Defines the value of the type property of a resize event object.

Zh

定义 resize 事件对象的 type 属性值。

`静态` `只读`RIGHT_CLICK

RIGHT_CLICK = "rightclick"

En

Defines the value of the type property of a rightclick event object.

Zh

定义 rightclick 事件对象的 type 属性值。

`静态` `只读`RIGHT_MOUSE_DOWN

RIGHT_MOUSE_DOWN = "rightmousedown"

En

Defines the value of the type property of a rightmousedown event object.

Zh

定义 rightmousedown 事件对象的 type 属性值。

`静态` `只读`RIGHT_MOUSE_UP

RIGHT_MOUSE_UP = "rightmouseup"

En

Defines the value of the type property of a rightmouseup event object.

Zh

定义 rightmouseup 事件对象的 type 属性值。

`静态` `只读`ROLL_OUT

ROLL_OUT = "mouseout"

En

Defines the value of the type property of a mouseout event object, triggered when mouse leaves a display object.

Zh

定义 mouseout 事件对象的 type 属性值，用于鼠标离开对象后触发。

`静态` `只读`ROLL_OVER

ROLL_OVER = "mouseover"

En

Defines the value of the type property of a mouseover event object.

Zh

定义 mouseover 事件对象的 type 属性值。

`静态` `只读`SELECT

SELECT = "select"

En

Defines the value of the type property of a select event object.

Zh

定义 select 事件对象的 type 属性值。

`静态` `只读`START

START = "start"

En

Defines the value of the type property of a start event object.

Zh

定义 start 事件对象的 type 属性值。

`静态` `只读`STATIC_MASK

STATIC_MASK = "staticMask"

En

Triggered when 3D Static changes.

Zh

3D Static改变时触发。

`静态` `只读`STOPPED

STOPPED = "stopped"

En

Defines the value of the type property of a stopped event object.

Zh

定义 stopped 事件对象的 type 属性值。

`静态` `只读`TRANSFORM_CHANGED

TRANSFORM_CHANGED = "transformchanged"

En

Triggered when the world matrix is updated.

Zh

世界矩阵更新时触发。

`静态` `只读`TRIGGER_ENTER

TRIGGER_ENTER = "triggerenter"

En

For 2D physics collision or 3D physics trigger start.

Zh

2D物理碰撞或3D物理触发开始。

`静态` `只读`TRIGGER_EXIT

TRIGGER_EXIT = "triggerexit"

En

For 2D physics collision or 3D physics trigger end.

Zh

2D物理碰撞或3D物理触发结束。

`静态` `只读`TRIGGER_STAY

TRIGGER_STAY = "triggerstay"

En

For 2D physics collision or 3D physics trigger continues.

Zh

2D物理碰撞或3D物理触发持续。

`静态` `只读`UNDISPLAY

UNDISPLAY = "undisplay"

En

Defines the value of the type property of an undisplay event object.

Zh

定义 undisplay 事件对象的 type 属性值。

`静态` `只读`UPDATE_PHY_EVENT_FILTER

UPDATE_PHY_EVENT_FILTER = "physics3dEventFilter"

Zh

激活物理3D事件过滤器。

En

Activate the physics 3D event filter.

`静态` `只读`VISIBILITY_CHANGE

VISIBILITY_CHANGE = "visibilitychange"

En

Defines the value of the type property of a visibilitychange event object.

Zh

定义 visibilitychange 事件对象的 type 属性值。

`静态` `只读`WILL_RESIZE

WILL_RESIZE = "willResize"

En

Defines the value of the type property of a willResize event object.

Zh

定义 willResize 事件对象的 type 属性值。

访问器

altKey

get altKey(): boolean
返回 boolean
En
Indicates whether the Alt key is active (true) or inactive (false).

Zh
表示 Alt 键是处于活动状态 (true) 还是非活动状态 (false)。
- 定义于 src/layaAir/laya/events/Event.ts:507

charCode

get charCode(): string
返回 string
En
Contains the character code value of the key pressed or released. The character code value is for English keyboard.

Zh
包含按下或释放的键的字符代码值。字符代码值为英文键盘值。
- 定义于 src/layaAir/laya/events/Event.ts:555

ctrlKey

get ctrlKey(): boolean
返回 boolean
En
Indicates whether the Ctrl key is active (true) or inactive (false).

Zh
表示 Ctrl 键是处于活动状态 (true) 还是非活动状态 (false)。
- 定义于 src/layaAir/laya/events/Event.ts:515

key

get key(): string
返回 string
En
The event name.

Zh
事件名称。
- 定义于 src/layaAir/laya/events/Event.ts:539

keyCode

get keyCode(): number
返回 number
En
The event name index.

Zh
事件名称索引。
- 定义于 src/layaAir/laya/events/Event.ts:547

keyLocation

get keyLocation(): number
返回 number
En
Indicates the location of the key on the keyboard. This is useful for differentiating keys that appear more than once on the keyboard. For example, you can use this property to distinguish between the left and right Shift keys: the value of KeyLocation.LEFT for the left Shift key and the value of KeyLocation.RIGHT for the right Shift key. Another example is distinguishing between a key pressed on the standard keyboard (KeyLocation.STANDARD) and the same key pressed on the numeric keypad (KeyLocation.NUM_PAD).

Zh
表示键在键盘上的位置。这对于区分在键盘上多次出现的键非常有用。例如，您可以根据此属性的值来区分左 Shift 键和右 Shift 键：左 Shift 键的值为 KeyLocation.LEFT，右 Shift 键的值为 KeyLocation.RIGHT。另一个示例是区分标准键盘 (KeyLocation.STANDARD) 与数字键盘 (KeyLocation.NUM_PAD) 上按下的数字键。
- 定义于 src/layaAir/laya/events/Event.ts:565

metaKey

get metaKey(): boolean
返回 boolean
En
Indicates whether the Meta key is active (true) or inactive (false). It is Command key on the Mac, and the Windows key on Windows.

Zh
表示 Meta 键是处于活动状态 (true) 还是非活动状态 (false)。在 Mac 上是 Command 键，在 Windows 上是 Windows 键。
- 定义于 src/layaAir/laya/events/Event.ts:531

shiftKey

get shiftKey(): boolean
返回 boolean
En
Indicates whether the Shift key is active (true) or inactive (false).

Zh
表示 Shift 键是处于活动状态 (true) 还是非活动状态 (false)。
- 定义于 src/layaAir/laya/events/Event.ts:523

stageX

get stageX(): number
返回 number
En
The X axis coordinate of the mouse on the Stage.

Zh
鼠标在 Stage 上的 X 轴坐标。
- 定义于 src/layaAir/laya/events/Event.ts:576

stageY

get stageY(): number
返回 number
En
The Y axis coordinate of the mouse on the Stage.

Zh
鼠标在 Stage 上的 Y 轴坐标。
- 定义于 src/layaAir/laya/events/Event.ts:584

touches

get touches(): readonly Readonly<ITouchInfo>[]
返回 readonly Readonly<ITouchInfo>[]
En
The list of touch points.

Zh
触摸点列表。
- 定义于 src/layaAir/laya/events/Event.ts:499

方法

preventDefault

preventDefault(): void
返回 void
En
Cancels the event's default behavior.

Zh
禁止事件的默认行为
- 定义于 src/layaAir/laya/events/Event.ts:491

setTo

setTo(type, currentTarget, target): Event
参数
- type: string
  The type of the event.
- currentTarget: any
  The triggering object of the event.
- target: any
  The current propagation object of the event.
返回 Event
The current Event object.

En
Sets the event data.

Zh
设置事件数据。
- 定义于 src/layaAir/laya/events/Event.ts:471

stopPropagation

stopPropagation(): void
返回 void
En
Prevents processing of all event listeners on the current node in the event flow after the current one. This method does not affect any event listeners on the current node (currentTarget).

Zh
阻止对事件流中当前节点的后续节点中的所有事件侦听器进行处理。此方法不会影响当前节点 (currentTarget) 中的任何事件侦听器。
- 定义于 src/layaAir/laya/events/Event.ts:483

`静态`isMouseEvent

isMouseEvent(type): boolean
参数
- type: string
  The type of the event.
返回 boolean
True if the specified event type is a mouse event; otherwise, false.

En
Checks whether the specified event type is a mouse event.

Zh
检测指定事件类型是否是鼠标事件。
- 定义于 src/layaAir/laya/events/Event.ts:386

类 Event

En

Zh

索引

构造函数

属性

访问器

方法

构造函数

constructor

返回 Event

属性

button

En

Zh

currentTarget

En

Zh

delta

En

Zh

isDblClick

En

Zh

nativeEvent

En

Zh

target

En

Zh

touchId

En

Zh

只读touchPos

En

Zh

type

En

Zh

静态 只读ADDED

En

Zh

静态 只读BLUR

En

Zh

静态 只读CHANGE

En

Zh

静态 只读CHANGED

En

Zh

静态 只读CLICK

En

Zh

静态 只读CLOSE

En

Zh

静态 只读COLLISION_ENTER

En

Zh

静态 只读COLLISION_EXIT

En

Zh

静态 只读COLLISION_STAY

En

Zh

静态 只读COMPLETE

En

Zh

静态 只读DEVICE_LOST

En

Zh

静态 只读DISPLAY

En

Zh

静态 只读DOUBLE_CLICK

En

Zh

静态 只读DRAG_END

En

`只读`touchPos

`静态` `只读`ADDED

`静态` `只读`BLUR

`静态` `只读`CHANGE

`静态` `只读`CHANGED

`静态` `只读`CLICK

`静态` `只读`CLOSE

`静态` `只读`COLLISION_ENTER

`静态` `只读`COLLISION_EXIT

`静态` `只读`COLLISION_STAY

`静态` `只读`COMPLETE

`静态` `只读`DEVICE_LOST

`静态` `只读`DISPLAY

`静态` `只读`DOUBLE_CLICK

`静态` `只读`DRAG_END

`静态` `只读`DRAG_MOVE

`静态` `只读`DRAG_START

`静态` `只读`DROP

`静态` `只读`EMPTY

`静态` `只读`END

`静态` `只读`ENTER

`静态` `只读`ERROR

`静态` `只读`FOCUS

`静态` `只读`FOCUS_CHANGE

`静态` `只读`FRAME

`静态` `只读`FULL_SCREEN_CHANGE

`静态` `只读`INPUT

`静态` `只读`JOINT_BREAK

`静态` `只读`KEY_DOWN

`静态` `只读`KEY_PRESS

`静态` `只读`KEY_UP

`静态` `只读`LABEL

`静态` `只读`LAYER_CHANGE

`静态` `只读`LINK

`静态` `只读`LOADED

`静态` `只读`MESSAGE

`静态` `只读`MOUSE_DOWN

`静态` `只读`MOUSE_DRAG