ZepetoinputControl
类型 | 说明 |
|---|---|
处理移动、跳跃、二段跳等玩家专属操作。 | |
管理 ZEPETO World 内与摄像机相关的输入操作。 | |
UIActions | 处理与 UI 相关的各类输入操作。 |
玩家操作的接口。 | |
摄像机操作的接口。 | |
IUIActions | UI 操作的接口。 |
PlayerActions
class
处理移动、跳跃、二段跳等玩家专属操作。
属性
名称 | 类型 | 说明 |
|---|---|---|
Move | InputAction | 获取玩家移动对应的输入操作。 |
Jump | InputAction | 获取玩家跳跃对应的输入操作。 |
DoubleJump | InputAction | 获取玩家二段跳对应的输入操作。 |
enabled | boolean | 表示玩家输入操作当前的启用状态。 |
方法
Get
Get() → InputActionMap
获取与玩家操作关联的 InputActionMap。
返回值： InputActionMap — 玩家操作的 InputActionMap。
Enable
Enable() → void
启用玩家的 Action Map，使玩家输入操作可用。
Disable
Disable() → void
禁用玩家的 Action Map，使玩家输入操作不可用。
SetCallbacks
SetCallbacks(instance: IPlayerActions) → void
将 instance 中的回调方法关联到对应的玩家操作。
参数 | 类型 | 说明 |
|---|---|---|
instance | 实现了 IPlayerActions 接口的对象。 |
CameraActions
class
管理 ZEPETO World 内与摄像机相关的输入操作。
属性
名称 | 类型 | 说明 |
|---|---|---|
Scroll | InputAction | 返回摄像机滚动对应的输入操作。 |
PrimaryTouchPosition | InputAction | 返回用于获取第一触点位置的输入操作。 |
PrimaryTouchContact | InputAction | 返回用于检测第一触点接触状态的输入操作。 |
SecondaryTouchPosition | InputAction | 返回用于获取第二触点位置的输入操作。 |
SecondaryTouchContact | InputAction | 返回用于检测第二触点接触状态的输入操作。 |
TertiaryTouchPosition | InputAction | 返回用于获取第三触点位置的输入操作。 |
TertiaryTouchContact | InputAction | 返回用于检测第三触点接触状态的输入操作。 |
enabled | boolean | 表示摄像机 Action Map 内的输入操作当前是否已启用。 |
方法
Get
Get() → InputActionMap
从 ZepetoInputControl 中获取与摄像机操作关联的 InputActionMap。
返回值： InputActionMap — 返回一个 InputActionMap 对象，即摄像机相关输入操作的集合。
Enable
Enable() → void
启用摄像机 Action Map 内的所有输入操作。
Disable
Disable() → void
禁用摄像机 Action Map 内的所有输入操作。
SetCallbacks
SetCallbacks(instance: ICameraActions) → void
设置摄像机操作的回调接口，以便在外部实现操作处理程序。
参数 | 类型 | 说明 |
|---|---|---|
instance | 实现了 ICameraActions 接口的对象。 |
UIActions
class
处理与 UI 相关的各类输入操作。
属性
名称 | 类型 | 说明 |
|---|---|---|
Navigate | InputAction | 该操作用于处理菜单、列表等 UI 元素之间的导航，通常使用方向键、摇杆操作、滑动手势等方向输入。 |
Submit | InputAction | 表示确认或选中当前高亮 UI 元素的操作，相当于“Enter”或“OK”命令。 |
Cancel | InputAction | 该操作对应取消或“返回”命令，可让用户返回上一级菜单或关闭当前 UI 窗口。 |
Point | InputAction | 处理 UI 中的指向机制，类似于移动鼠标光标或触摸屏上的手指接触点。 |
Click | InputAction | 表示点击 UI 元素的操作，相当于鼠标点击或屏幕轻触。 |
ScrollWheel | InputAction | 该操作用于获取滚动输入，例如来自鼠标滚轮或触控板手势的输入。 |
MiddleClick | InputAction | 表示按下鼠标中键的操作。 |
RightClick | InputAction | 对应鼠标右键点击操作，常用于打开上下文菜单或执行次级操作。 |
TrackedDevicePosition | InputAction | 获取被追踪设备的位置数据，例如 VR 控制器或动作追踪设备。 |
TrackedDeviceOrientation | InputAction | 追踪设备的朝向，通常用于 VR 或 AR 场景中检测设备所指向或面向的方向。 |
enabled | boolean | 表示 UI 操作当前是否处于激活状态并可响应输入。 |
方法
Get
Get() → InputActionMap
返回与 UI 操作关联的 InputActionMap。
返回值： InputActionMap — 返回的 InputActionMap 包含 ZepetoInputControl 类中为 UI 交互定义的所有输入操作。
Enable
Enable() → void
启用 UI 输入操作，使其可响应用户输入。
Disable
Disable() → void
禁用 UI 输入操作，使其不再响应用户输入。
SetCallbacks
SetCallbacks(instance: IUIActions) → void
注册 UI 操作的回调方法。该方法按照 instance 所实现的 IUIActions 接口中的定义，将各操作与对应的事件处理程序关联起来。
参数 | 类型 | 说明 |
|---|---|---|
instance | IUIActions | 实现了 IUIActions 接口的对象。 |
IPlayerActions
interface
玩家操作的接口。
方法
OnMove
OnMove(context: CallbackContext) → void
移动时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnJump
OnJump(context: CallbackContext) → void
跳跃时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnDoubleJump
OnDoubleJump(context: CallbackContext) → void
二段跳时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
ICameraActions
interface
摄像机操作的接口。
方法
OnScroll
OnScroll(context: CallbackContext) → void
滚动时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnPrimaryTouchPosition
OnPrimaryTouchPosition(context: CallbackContext) → void
第一触点位置变化时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnPrimaryTouchContact
OnPrimaryTouchContact(context: CallbackContext) → void
第一触点发生接触时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnSecondaryTouchPosition
OnSecondaryTouchPosition(context: CallbackContext) → void
滚动时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnSecondaryTouchContact
OnSecondaryTouchContact(context: CallbackContext) → void
第二触点发生接触时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnTertiaryTouchPosition
OnTertiaryTouchPosition(context: CallbackContext) → void
第三触点位置变化时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnTertiaryTouchContact
OnTertiaryTouchContact(context: CallbackContext) → void
第三触点发生接触时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
IUIActions
interface
UI 操作的接口。
方法
OnNavigate
OnNavigate(context: CallbackContext) → void
导航时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnSubmit
OnSubmit(context: CallbackContext) → void
确认时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnCancel
OnCancel(context: CallbackContext) → void
取消时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnPoint
OnPoint(context: CallbackContext) → void
指向时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnClick
OnClick(context: CallbackContext) → void
点击时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnScrollWheel
OnScrollWheel(context: CallbackContext) → void
使用滚轮时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnMiddleClick
OnMiddleClick(context: CallbackContext) → void
点击中键时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnRightClick
OnRightClick(context: CallbackContext) → void
点击右键时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnTrackedDevicePosition
OnTrackedDevicePosition(context: CallbackContext) → void
被追踪设备位置变化时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |
OnTrackedDeviceOrientation
OnTrackedDeviceOrientation(context: CallbackContext) → void
被追踪设备朝向变化时调用。
参数 | 类型 | 说明 |
|---|---|---|
context | CallbackContext | 回调上下文。 |