Key

.Input.Keyboard. Key

可以传递给过程函数的通用键对象(等等) 键码必须是整数

Constructor

new Key(plugin, keyCode)

Since:
  • 3.0.0
Parameters:
Name Type Description
plugin Phaser.Input.Keyboard.KeyboardPlugin 拥有此键对象的键盘插件实例.
keyCode number 这个键的键码.

Extends

Members

altKey :boolean

Since:
  • 3.0.0
Default Value:
  • false
如果与此键同时按下,ALT键的向下状态.
Type:
  • boolean

ctrlKey :boolean

Since:
  • 3.0.0
Default Value:
  • false
如果与此键同时按下,CTRL键的向下状态.
Type:
  • boolean

duration :number

Since:
  • 3.0.0
Default Value:
  • 0
在之前的上下顺序中,该键被按下的毫秒数. 这个值不会在每一个游戏步骤中更新,只有当键改变状态时才会更新. 要获取当前持续时间,请使用 `getDuration` 方法.
Type:
  • number

emitOnRepeat :boolean

Since:
  • 3.16.0
Default Value:
  • false
当一个键被按下时,它是否应该在每次重复时持续触发 `down` 事件? 默认情况下,它只会发出一次 `down` 事件,但如果您希望接收该事件 对于每次重复,也启用此属性.
Type:
  • boolean

enabled :boolean

Since:
  • 3.0.0
Default Value:
  • true
这个密钥可以处理吗?
Type:
  • boolean

isDown :boolean

Since:
  • 3.0.0
Default Value:
  • false
钥匙的`向下`状态.只要键盘认为这个键被按下,它就会一直保持 `true` .
Type:
  • boolean

isUp :boolean

Since:
  • 3.0.0
Default Value:
  • true
钥匙的`向上`状态.只要键盘认为这个键是向上的,它就会一直保持 `true` .
Type:
  • boolean

keyCode :number

Since:
  • 3.0.0
这个键的键码.
Type:
  • number

location :number

Since:
  • 3.0.0
Default Value:
  • 0
修饰键的位置.0表示标准(或未知),1表示左侧,2表示右侧,3表示numpad.
Type:
  • number

metaKey :boolean

Since:
  • 3.16.0
Default Value:
  • false
如果与此键同时按下,元键的向下状态. 在苹果电脑上,元键是命令键.在Windows键盘上,是Windows键.
Type:
  • boolean

originalEvent :KeyboardEvent

Since:
  • 3.0.0
原DOM事件.
Type:
  • KeyboardEvent

plugin :Phaser.Input.Keyboard.KeyboardPlugin

Since:
  • 3.17.0
拥有此键对象的键盘插件实例.
Type:

repeats :number

Since:
  • 3.0.0
Default Value:
  • 0
如果一个键被按下,这个键会按下键 `repeated` 的次数.
Type:
  • number

shiftKey :boolean

Since:
  • 3.0.0
Default Value:
  • false
如果与此键同时按下,SHIFT键的向下状态.
Type:
  • boolean

timeDown :number

Since:
  • 3.0.0
Default Value:
  • 0
上次按键时的时间戳.
Type:
  • number

timeUp :number

Since:
  • 3.0.0
Default Value:
  • 0
上次释放密钥的时间戳.
Type:
  • number

Methods

addListener(event, fn, contextopt) → {this}

Since:
  • 3.0.0
Inherited From:
为给定事件添加侦听器.
Parameters:
Name Type Attributes Default Description
event string | symbol 事件名称.
fn function 侦听器函数.
context * <optional>
this 用来调用侦听器的上下文.
Returns:
`this`.
Type
this

destroy()

Since:
  • 3.16.0
Overrides:
移除任何绑定的事件处理程序并移除本地引用.

emit(event, …argsopt) → {boolean}

Since:
  • 3.0.0
Inherited From:
调用为给定事件注册的每个侦听器.
Parameters:
Name Type Attributes Description
event string | symbol 事件名称.
args * <optional>
<repeatable>
将传递给事件处理程序的附加参数.
Returns:
`true` 如果事件有侦听器,则为 `false` .
Type
boolean

eventNames() → {Array.<(string|symbol)>}

Since:
  • 3.0.0
Inherited From:
返回一个数组,列出发射器已注册侦听器的事件.
Returns:
Type
Array.<(string|symbol)>

getDuration() → {number}

Since:
  • 3.17.0
返回按键按下的持续时间,以毫秒为单位. 如果键当前没有按下,它将返回零. 获取在上一个上下循环中按键被按下的持续时间, 请改用 `Key.duration` 属性值.
Returns:
如果当前按键被按下,按键被按下的持续时间(毫秒).
Type
number

listenerCount(event) → {number}

Since:
  • 3.0.0
Inherited From:
返回监听给定事件的侦听器数量.
Parameters:
Name Type Description
event string | symbol 事件名称.
Returns:
侦听器的数量.
Type
number

listeners(event) → {Array.<function()>}

Since:
  • 3.0.0
Inherited From:
返回为给定事件注册的侦听器.
Parameters:
Name Type Description
event string | symbol 事件名称.
Returns:
注册的听众.
Type
Array.<function()>

off(event, fnopt, contextopt, onceopt) → {this}

Since:
  • 3.0.0
Inherited From:
移除给定事件的侦听器.
Parameters:
Name Type Attributes Description
event string | symbol 事件名称.
fn function <optional>
仅移除与此函数匹配的侦听器.
context * <optional>
仅移除具有此上下文的侦听器.
once boolean <optional>
仅删除一次性侦听器.
Returns:
`this`.
Type
this

on(event, fn, contextopt) → {this}

Since:
  • 3.0.0
Inherited From:
为给定事件添加侦听器.
Parameters:
Name Type Attributes Default Description
event string | symbol 事件名称.
fn function 侦听器函数.
context * <optional>
this 用来调用侦听器的上下文.
Returns:
`this`.
Type
this

once(event, fn, contextopt) → {this}

Since:
  • 3.0.0
Inherited From:
为给定事件添加一次性侦听器.
Parameters:
Name Type Attributes Default Description
event string | symbol 事件名称.
fn function 侦听器函数.
context * <optional>
this 用来调用侦听器的上下文.
Returns:
`this`.
Type
this

onDown(event)

Since:
  • 3.16.0
处理该键的按键操作. 由键盘插件自动调用.
Parameters:
Name Type Description
event KeyboardEvent 本机DOM键盘事件.
Fires:

onUp(event)

Since:
  • 3.16.0
处理该键的向上键操作. 由键盘插件自动调用.
Parameters:
Name Type Description
event KeyboardEvent 本机DOM键盘事件.
Fires:

removeAllListeners(eventopt) → {this}

Since:
  • 3.0.0
Inherited From:
移除所有侦听器或指定事件的侦听器.
Parameters:
Name Type Attributes Description
event string | symbol <optional>
事件名称.
Returns:
`this`.
Type
this

removeListener(event, fnopt, contextopt, onceopt) → {this}

Since:
  • 3.0.0
Inherited From:
移除给定事件的侦听器.
Parameters:
Name Type Attributes Description
event string | symbol 事件名称.
fn function <optional>
仅移除与此函数匹配的侦听器.
context * <optional>
仅移除具有此上下文的侦听器.
once boolean <optional>
仅删除一次性侦听器.
Returns:
`this`.
Type
this

reset() → {this}

Since:
  • 3.6.0
将该键对象重置回其默认未按下状态.
Returns:
此密钥实例.
Type
this

setEmitOnRepeat(value) → {this}

Since:
  • 3.16.0
控制该键在被按下时是否会持续发出`down`事件(真), 或者在第一次按下时只发出一次事件,然后跳过以后的事件(false).
Parameters:
Name Type Description
value boolean 重复按键动作时发出 `down` 事件,还是只发出一次?
Returns:
此密钥实例.
Type
this

shutdown()

Since:
  • 3.0.0
Inherited From: