--- title: ZepetoInputControl slug: world-sdk-guide/zepetoinputcontrol docTags: createdAt: 2026-08-28T01:33:55.367Z --- | Type | Description | | ----------------------------------- | -------------------------------------------------------------------------------------------- | | [PlayerActions](./#playeractions) | Responsible for handling player-specific actions like movement, jumping, and double jumping. | | [CameraActions](./#cameraactions) | Manages camera-related input actions within the ZEPETO World. | | [UIActions](./#uiactions) | Handles various UI-related input actions. | | [IPlayerActions](./#iplayeractions) | Interface for player actions. | | [ICameraActions](./#icameraactions) | Interface for camera actions. | | [IUIActions](./#iuiactions) | Interface for UI actions. | ## PlayerActions `class` Responsible for handling player-specific actions like movement, jumping, and double jumping. ### Properties | Name | Type | Description | | ---------- | ------------- | ---------------------------------------------------------------------- | | Move | `InputAction` | Retrieves the input action for player movement. | | Jump | `InputAction` | Retrieves the input action for player jump. | | DoubleJump | `InputAction` | Retrieves the input action for player double jump. | | enabled | `boolean` | Indicates the current activation status of the player's input actions. | ### Methods ### Get `Get() → InputActionMap` Retrieves `InputActionMap` associated with player actions. **Returns:** `InputActionMap` — `InputActionMap` for player actions. ### Enable `Enable() → void` Activates the player action map, enabling player input actions. ### Disable `Disable() → void` Deactivates the player action map, disabling player input actions. ### SetCallbacks `SetCallbacks(instance: IPlayerActions) → void` Associates callback methods from instance with the respective player actions. | Parameter | Type | Description | | --------- | ----------------------------------- | --------------------------------------------------------- | | instance | [IPlayerActions](./#iplayeractions) | An object that implements the `IPlayerActions` interface. | ## CameraActions `class` Manages camera-related input actions within the ZEPETO World. ### Properties | Name | Type | Description | | ---------------------- | ------------- | --------------------------------------------------------------------------------------- | | Scroll | `InputAction` | Returns the input action for scrolling the camera. | | PrimaryTouchPosition | `InputAction` | Returns the input action for capturing the position of the primary touch. | | PrimaryTouchContact | `InputAction` | Returns the input action for detecting contact on the primary touch. | | SecondaryTouchPosition | `InputAction` | Returns the input action for capturing the position of the secondary touch. | | SecondaryTouchContact | `InputAction` | Returns the input action for detecting contact on the secondary touch. | | TertiaryTouchPosition | `InputAction` | Returns the input action for capturing the position of the tertiary touch. | | TertiaryTouchContact | `InputAction` | Returns the input action for detecting contact on the tertiary touch. | | enabled | `boolean` | Indicates whether the input actions within the camera action map are currently enabled. | ### Methods ### Get `Get() → InputActionMap` Retrieves the InputActionMap associated with camera actions from the ZepetoInputControl. **Returns:** `InputActionMap` — Returns an InputActionMap object, a collection of camera-related input actions. ### Enable `Enable() → void` Enables all the input actions within the camera action map. ### Disable `Disable() → void` Disables all the input actions within the camera action map. ### SetCallbacks `SetCallbacks(instance: ICameraActions) → void` Sets the callback interface for the camera actions, allowing external implementation of action handlers. | Parameter | Type | Description | | --------- | ----------------------------------- | ------------------------------------------------- | | instance | [ICameraActions](./#icameraactions) | Object implements the `ICameraActions` interface. | ## UIActions `class` Handles various UI-related input actions. ### Properties | Name | Type | Description | | ------------------------ | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Navigate | `InputAction` | This action handles navigation through UI elements, such as menus or lists, typically using directional inputs like arrow keys, joystick movement, or swipe gestures. | | Submit | `InputAction` | Represents the action of confirming or selecting a highlighted UI element, equivalent to a 'Enter' or 'OK' command. | | Cancel | `InputAction` | This action corresponds to a cancellation or 'back' command, allowing users to return to a previous menu or close a current UI window. | | Point | `InputAction` | Handles the pointing mechanism in UI, similar to moving a mouse cursor or a finger touch point on touchscreens. | | Click | `InputAction` | Represents the action of clicking a UI element, akin to mouse clicks or screen taps. | | ScrollWheel | `InputAction` | This action is used to capture scrolling input, such as from a mouse wheel or a touchpad gesture. | | MiddleClick | `InputAction` | Represents the action of pressing the middle mouse button. | | RightClick | `InputAction` | Corresponds to the action of right-clicking with a mouse, often used to open context menus or perform secondary actions. | | TrackedDevicePosition | `InputAction` | Captures the positional data of a tracked device, like a VR controller or a motion tracking device. | | TrackedDeviceOrientation | `InputAction` | Tracks the orientation of a device, typically used in VR or AR setups to detect the direction in which a device is pointed or facing. | | enabled | `boolean` | Indicates whether the UI actions are currently active and responsive to input. | ### Methods ### Get `Get() → InputActionMap` Returns the InputActionMap associated with UI actions. **Returns:** `InputActionMap` — The returned InputActionMap includes all the input actions defined for UI interactions within the ZepetoInputControl class. ### Enable `Enable() → void` Activates the UI input actions, making them responsive to user input. ### Disable `Disable() → void` Deactivates the UI input actions, rendering them unresponsive to user input. ### SetCallbacks `SetCallbacks(instance: IUIActions) → void` Registers callback methods for the UI actions. It links the actions to their respective event handlers as defined in the `IUIActions` interface implemented by the instance. | Parameter | Type | Description | | --------- | --------------------------- | ----------------------------------------------------- | | instance | [IUIActions](./#iuiactions) | An object that implements the `IUIActions` interface. | ## IPlayerActions `interface` Interface for player actions. ### Methods ### OnMove `OnMove(context: CallbackContext) → void` On move. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnJump `OnJump(context: CallbackContext) → void` On jump. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnDoubleJump `OnDoubleJump(context: CallbackContext) → void` On double jump. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ## ICameraActions `interface` Interface for camera actions. ### Methods ### OnScroll `OnScroll(context: CallbackContext) → void` On scroll. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnPrimaryTouchPosition `OnPrimaryTouchPosition(context: CallbackContext) → void` On primary touch position. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnPrimaryTouchContact `OnPrimaryTouchContact(context: CallbackContext) → void` On primary touch contact. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnSecondaryTouchPosition `OnSecondaryTouchPosition(context: CallbackContext) → void` On scroll. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnSecondaryTouchContact `OnSecondaryTouchContact(context: CallbackContext) → void` On secondary touch contact. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnTertiaryTouchPosition `OnTertiaryTouchPosition(context: CallbackContext) → void` On tertiary touch position. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnTertiaryTouchContact `OnTertiaryTouchContact(context: CallbackContext) → void` On tertiary touch contact. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ## IUIActions `interface` Interface for UI actions. ### Methods ### OnNavigate `OnNavigate(context: CallbackContext) → void` On navigate. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnSubmit `OnSubmit(context: CallbackContext) → void` On submit. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnCancel `OnCancel(context: CallbackContext) → void` On cancel. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnPoint `OnPoint(context: CallbackContext) → void` On point. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnClick `OnClick(context: CallbackContext) → void` On click. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnScrollWheel `OnScrollWheel(context: CallbackContext) → void` On scroll wheel. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnMiddleClick `OnMiddleClick(context: CallbackContext) → void` On middle click. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnRightClick `OnRightClick(context: CallbackContext) → void` On right click. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnTrackedDevicePosition `OnTrackedDevicePosition(context: CallbackContext) → void` On tracked device position. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. | ### OnTrackedDeviceOrientation `OnTrackedDeviceOrientation(context: CallbackContext) → void` On tracked device orientation. | Parameter | Type | Description | | --------- | ----------------- | ----------------- | | context | `CallbackContext` | Callback context. |