Input

Input

Namespaces

Gamepad
Keyboard

Type Definitions

EventData

Since:
  • 3.15.1
Properties:
Name Type Attributes Default Description
cancelled boolean <optional>
false 此事件的取消状态.
stopPropagation function 调用此方法以阻止此事件在事件链中进一步传递.
相位器输入事件数据对象. 此对象被传递给已注册的事件侦听器,并允许您停止任何进一步的传播.
Type:
  • object

HitAreaCallback(hitArea, x, y, gameObject) → {boolean}

Since:
  • 3.0.0
Parameters:
Name Type Description
hitArea any The hit area object.
x number The translated x coordinate of the hit test event.
y number The translated y coordinate of the hit test event.
gameObject Phaser.GameObjects.GameObject The Game Object that invoked the hit test.
Returns:
`true` if the coordinates fall within the space of the hitArea, otherwise `false`.
Type
boolean

InputConfiguration

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
hitArea any <optional>
用作命中区域的对象/形状.如果没有给出,它将尝试创建一个基于纹理框架的矩形.
hitAreaCallback Phaser.Types.Input.HitAreaCallback <optional>
确定指针是否在命中区域形状内的回调.
draggable boolean <optional>
false 如果`拖动`,交互式对象将被设置为可拖动并发出拖动事件.
dropZone boolean <optional>
false 如果`拖动`,交互式对象将被设置为可拖动对象的拖放区.
useHandCursor boolean <optional>
false 如果 `true` ,当指针在上面时,交互式对象将设置 `pointer` 指针光标.这是设置 `cursor:pointer` 的捷径.
cursor string <optional>
光标在此交互式对象上时使用的CSS字符串.
pixelPerfect boolean <optional>
false 如果 `true` ,将为命中区域回调设置一个像素完美函数.仅适用于基于图像纹理的游戏对象,不适用于渲染纹理.
alphaTolerance number <optional>
1 如果设置了 `pixelPerfect` ,这是回调中使用的阿尔法容差阈值.
Type:
  • object

InputPluginContainer

Since:
  • 3.0.0
Properties:
Name Type Attributes Description
key string 输入插件缓存中该插件的唯一名称.
plugin function 要存储的插件.应该是源对象,而不是实例化的.
mapping string <optional>
如果这个插件将被注入到输入插件中,这是所使用的属性键映射.
Type:
  • object

InteractiveObject

Since:
  • 3.0.0
Properties:
Name Type Attributes Description
gameObject Phaser.GameObjects.GameObject 此交互式对象绑定到的游戏对象.
enabled boolean 当前是否为输入事件启用了此交互式对象?
alwaysEnabled boolean 即使父对象不可见或不呈现,一个`始终启用`的交互对象也将接收输入.
draggable boolean 这个交互式对象是可拖动的吗?用 `InputPlugin.setDraggable` 启用.
dropZone boolean 这个交互式对象是拖放区吗?设置创建对象的时间.
cursor boolean | string 这个交互式对象应该在结束时改变光标吗?(仅桌面)
target Phaser.GameObjects.GameObject <nullable>
可拖动交互式对象的可选放置目标.
camera Phaser.Cameras.Scene2D.Camera 根据此交互式对象测试的最新相机.
hitArea any 这个交互式对象的命中区域.通常是几何形状,如矩形或圆形.
hitAreaCallback Phaser.Types.Input.HitAreaCallback 点击区域形状将用于所有点击测试的 `contains` 检查回调.
hitAreaDebug Phaser.GameObjects.Shape 如果此交互式对象已通过`InputPlugin.enableDebug`启用调试,则此属性保持其调试形状.
customHitArea boolean 这个交互式对象的点击区域是基于纹理大小(错误)还是自定义形状创建的?(真)
localX number 指针与该对象交互的x坐标,相对于游戏对象的左上角位置.
localY number 指针与该对象交互的y坐标,相对于游戏对象的左上角位置.
dragState 0 | 1 | 2 此交互式对象的当前拖动状态.0 =未被拖动,1 =被检查拖动,或2 =被主动拖动.
dragStartX number 拖动开始时拥有该交互式对象的游戏对象的x坐标.
dragStartY number 拖动开始时拥有该交互式对象的游戏对象的y坐标.
dragStartXGlobal number 指针开始拖动此交互式对象的x坐标.
dragStartYGlobal number 指针开始拖动此交互式对象的y坐标.
dragX number 此交互式对象当前被拖动到的x坐标.
dragY number 此交互式对象当前被拖动到的y坐标.
Type:
  • object