---
title: ZEPETO.Character.Controller
slug: world-sdk-guide-ja/Oge4-zepetocharactercontroller
docTags: 
createdAt: 2026-09-04T06:55:09.633Z
---

| 型                                                                | 説明                                                                                                           |
| ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| [ZepetoPlayers](./#zepetoplayers)                                | ZEPETO プレイヤーと ZEPETO キャラクターの両方を制御するためのマネージャークラス。                                                             |
| [SpawnInfo](./#spawninfo)                                        | ZEPETO キャラクターのスポーン位置を表します。                                                                                   |
| [ZepetoCharacter](./#zepetocharacter)                            | ZEPETO World 内で読み込み、制御できる ZEPETO キャラクターを表します。                                                                |
| [CameraData](./#cameradata)                                      | `ZepetoCamera` の初期設定を表します。                                                                                   |
| [CharacterData](./#characterdata)                                | `ZepetoCharacter` の初期設定を表します。                                                                                |
| [ControllerData](./#controllerdata)                              | `ZepetoPlayerControl` の設定を表します。                                                                              |
| [FloatingUIData](./#floatinguidata)                              | キャラクター関連の UI 設定を管理するクラス。                                                                                     |
| [LocalPlayer](./#localplayer)                                    | 移動、コスチュームのカスタマイズ、ZEPETO カメラの操作など、ローカルプレイヤーのアクションを管理するためのクラス。                                                 |
| [ZepetoCamera](./#zepetocamera)                                  | ZEPETO Character Controller 内で使用するために設計されたカメラ制御クラス。                                                          |
| [ZepetoPlayer](./#zepetoplayer)                                  | ZEPETO プレイヤーを表します。                                                                                           |
| [ZepetoPlayerControl](./#zepetoplayercontrol)                    | ZEPETO プレイヤーの入力制御を管理します。                                                                                     |
| [ZepetoCameraControl](./#zepetocameracontrol)                    | カメラの移動やズームの入力処理を含め、ZEPETO 環境におけるカメラ操作を管理します。                                                                 |
| [CharacterState](./#characterstate)                              | ZEPETO キャラクターの状態を表します。                                                                                       |
| [CharacterMoveState](./#charactermovestate)                      | ZEPETO キャラクターの詳細な移動状態を表します。                                                                                  |
| [CharacterJumpState](./#characterjumpstate)                      | ZEPETO キャラクターの詳細なジャンプ状態を表します。                                                                                |
| [CharacterLandingState](./#characterlandingstate)                | ZEPETO キャラクターの詳細な着地状態を表します。                                                                                  |
| [KnowSockets](./#knowsockets)                                    | キャラクター上の既知のアタッチメントポイント（ソケット）のセットを定義します。                                                                      |
| [MotionState](./#motionstate)                                    | キャラクターのモーション状態と設定を管理するクラス。                                                                                   |
| [CharacterStateMachine](./#characterstatemachine)                | ZEPETO キャラクターのキャラクター状態と Animator を同期させるクラス。                                                                  |
| [StateMachine](./#statemachine)                                  | `StateMachine` は `States`、`Transitions`、`Events` を管理します。指定された条件と経過時間に応じて状態を更新することで、オブジェクトのさまざまな状態を定義し制御できます。 |
| [StateStatus](./#statestatus)                                    | ステートマシン内におけるステートの取り得るステータスを表し、ステートのライフサイクルの現在の段階を示します。                                                       |
| [CustomMotionData](./#custommotiondata)                          | キャラクターモーションのカスタム設定を表します。                                                                                     |
| [CharacterShadow](./#charactershadow)                            | ZEPETO キャラクターの影を管理するクラス。                                                                                     |
| [CameraState](./#camerastate)                                    | `ZepetoCamera` の状態を表します。                                                                                     |
| [ZepetoScreenStick](./#zepetoscreenstick)                        | ZEPETO 環境におけるスティック操作を処理するためのクラス。                                                                             |
| [ZepetoScreenControl](./#zepetoscreencontrol)                    | ZEPETO 環境で UI コントロールを作成するための抽象クラス。                                                                           |
| [ZepetoScreenButton](./#zepetoscreenbutton)                      | ZEPETO 環境におけるボタン操作を処理するためのクラス。                                                                               |
| [ZepetoScreenTouchpad](./#zepetoscreentouchpad)                  | ZEPETO 環境におけるタッチパッド操作を処理するためのクラス。                                                                            |
| [UIZepetoPlayerControl](./#uizepetoplayercontrol)                | ローカルプレイヤーのキャラクターを UI で操作する機能を提供するクラス。                                                                        |
| [InputHelper](./#inputhelper)                                    | 入力処理を補助するためのユーティリティクラス。                                                                                      |
| [EventReceiver](./#eventreceiver)                                | ZEPETO World 内のキャラクター関連イベントや一般的なイベントを処理するクラス。                                                                |
| [TransitionBase](./#transitionbase)                              | ステートマシンにおけるステート間の遷移を定義するための基底クラス。                                                                            |
| [State](./#state)                                                | ステートマシン内のステートを表します。                                                                                          |
| [Transition](./#transition)                                      | ステートマシンにおけるステート間の遷移を定義するためのジェネリッククラス。                                                                        |
| [ZepetoCharacter.LoadingStatus](./#zepetocharacterloadingstatus) | ZEPETO キャラクターの読み込み状態。                                                                                        |
| [PlayerControlMode](./#playercontrolmode)                        | *enum*                                                                                                       |

## ZepetoPlayers

`class`

ZEPETO プレイヤーと ZEPETO キャラクターの両方を制御するためのマネージャークラス。

### プロパティ

| 名前                | 型                                   | 説明                             |
| ----------------- | ----------------------------------- | ------------------------------ |
| cameraData        | [CameraData](./#cameradata)         | `ZepetoCamera` の設定。            |
| characterData     | [CharacterData](./#characterdata)   | `ZepetoCharacter` の設定。         |
| controllerData    | [ControllerData](./#controllerdata) | `ZepetoPlayerControl` の設定。     |
| floatingUIData    | [FloatingUIData](./#floatinguidata) | キャラクター関連の UI 設定。               |
| instance (static) | [ZepetoPlayers](./#zepetoplayers)   | `ZepetoPlayers` のシングルトンインスタンス。 |
| LocalPlayer       | [LocalPlayer](./#localplayer)       | ローカルプレイヤー。                     |
| ZepetoCamera      | [ZepetoCamera](./#zepetocamera)     | ZEPETO カメラ。                    |

### イベント

| 名前                 | 型                    | 説明                                 |
| ------------------ | -------------------- | ---------------------------------- |
| OnAddedLocalPlayer | `UnityEvent`         | ローカルプレイヤーのインスタンスが作成されたときに発生するイベント。 |
| OnAddedPlayer      | `UnityEvent<string>` | プレイヤーのインスタンスが作成されたときに発生するイベント。     |
| OnRemovedPlayer    | `UnityEvent<string>` | プレイヤーのインスタンスが削除されたときに発生するイベント。     |

### メソッド

### add\_onInitialized

`static add_onInitialized(value: Action) → void`

`ZepetoPlayers` が初期化されたときに呼び出されるイベントにハンドラー関数を追加します。

| パラメーター | 型        |
| ------ | -------- |
| value  | `Action` |

### remove\_onInitialized

`static remove_onInitialized(value: Action) → void`

`ZepetoPlayers` が初期化されたときに呼び出されるイベントからハンドラー関数を削除します。

| パラメーター | 型        |
| ------ | -------- |
| value  | `Action` |

### HasPlayer

`HasPlayer(id: string) → boolean`

指定したセッション ID に紐づくプレイヤーインスタンスが存在するかどうかを確認します。

| パラメーター | 型        | 説明       |
| ------ | -------- | -------- |
| id     | `string` | セッション ID |

**戻り値:** `boolean`

### GetPlayer

`GetPlayer(id: string) → ZepetoPlayer`

指定したセッション ID に紐づくプレイヤーインスタンスを取得します。

| パラメーター | 型        | 説明       |
| ------ | -------- | -------- |
| id     | `string` | セッション ID |

**戻り値:** [ZepetoPlayer](./#zepetoplayer) — 指定した ID に紐づくプレイヤーオブジェクト。
指定した ID のプレイヤーが存在しない場合は `null` を返します。

### GetPlayerWithUserId

`GetPlayerWithUserId(userId: string) → ZepetoPlayer`

指定したユーザー ID に紐づくプレイヤーインスタンスを取得します。

| パラメーター | 型        | 説明      |
| ------ | -------- | ------- |
| userId | `string` | ユーザー ID |

**戻り値:** [ZepetoPlayer](./#zepetoplayer) — 指定したユーザー ID に紐づくプレイヤーオブジェクト。

### RemovePlayer

`RemovePlayer(id: string) → void`

指定したセッション ID に紐づくプレイヤーインスタンスを削除します。

| パラメーター | 型        | 説明       |
| ------ | -------- | -------- |
| id     | `string` | セッション ID |

### DeformDefaultCostume

`DeformDefaultCostume() → void`

すべてのプレイヤーのキャラクターが着用しているボディ変形アイテムを削除します。
デフォルトの体型に戻し、デフォルトの ZEPETO 衣装を適用します。

### DeformDefaultProperties

`DeformDefaultProperties() → void`

すべてのプレイヤーのキャラクターが着用しているボディ変形アイテムを削除します。

## SpawnInfo

`class`

ZEPETO キャラクターのスポーン位置を表します。

### プロパティ

| 名前               | 型                         | 説明                       |
| ---------------- | ------------------------- | ------------------------ |
| Default (static) | [SpawnInfo](./#spawninfo) | デフォルトのスポーン位置。            |
| position         | `Vector3`                 | スポーン時の ZEPETO キャラクターの位置。 |
| rotation         | `Quaternion`              | スポーン時の ZEPETO キャラクターの回転。 |

## ZepetoCharacter

`class`

ZEPETO World 内で読み込み、制御できる ZEPETO キャラクターを表します。

### プロパティ

| 名前                  | 型                                                 | 説明                                  |
| ------------------- | ------------------------------------------------- | ----------------------------------- |
| additionalWalkSpeed | `number`                                          | 追加の歩行速度を取得します。                      |
| additionalRunSpeed  | `number`                                          | 追加の走行速度を取得します。                      |
| additionalJumpPower | `number`                                          | 追加のジャンプ力を取得します。                     |
| constraintRotation  | `boolean`                                         | キャラクターの回転を制限するかどうかを決定します。           |
| ZepetoAnimator      | `Animator`                                        | ZEPETO キャラクターの Animator。            |
| WalkSpeed           | `number`                                          | 基本速度と追加速度の合計である歩行速度の合計値を取得します。      |
| RunSpeed            | `number`                                          | 基本速度と追加速度の合計である走行速度の合計値を取得します。      |
| JumpPower           | `number`                                          | 基本の力と追加の力の合計であるジャンプ力の合計値を取得します。     |
| baseWalkSpeed       | `number`                                          | 基本の歩行速度を取得します。                      |
| baseRunSpeed        | `number`                                          | 基本の走行速度を取得します。                      |
| baseJumpPower       | `number`                                          | 基本のジャンプ力を取得します。                     |
| tryMove             | `boolean`                                         | キャラクターが移動しようとしているかどうかを示します。         |
| tryJump             | `boolean`                                         | キャラクターがジャンプしようとしているかどうかを示します。       |
| tryDoubleJump       | `boolean`                                         | キャラクターが二段ジャンプしようとしているかどうかを示します。     |
| motionState         | [MotionState](./#motionstate)                     | キャラクターのモーション状態と設定。                  |
| loadingStatus       | [LoadingStatus](./#zepetocharacterloadingstatus)  | キャラクターの読み込み状態。                      |
| Context             | `ZepetoContext`                                   | キャラクターの ZEPETO Context。             |
| StateMachine        | [CharacterStateMachine](./#characterstatemachine) | キャラクターのステートマシン。                     |
| CurrentState        | [CharacterState](./#characterstate)               | ステートマシンで定義された、キャラクターの現在のステート。       |
| CurrentStateStatus  | [StateStatus](./#statestatus)                     | ステートマシンで定義された、キャラクターの現在のステートのステータス。 |
| ElapsedTime         | `number`                                          | キャラクターが初期化されてからの経過時間(秒)。            |

### イベント

| 名前             | 型                                            | 説明                                                                                                                              |
| -------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| OnChangedState | `UnityEvent<CharacterState, CharacterState>` | キャラクターの状態が変化したときに発生するイベント。登録されたリスナーは 2 つのパラメーターを受け取ります: - 新しいキャラクター状態。(型: `CharacterState`) - 直前のキャラクター状態。(型: `CharacterState`) |
| OnUpdateState  | `UnityEvent<CharacterState>`                 | キャラクターの状態が `StateStatus.Update` のステータスにあるときに発生するイベント。登録されたリスナーは 1 つのパラメーターを受け取ります: - 現在のキャラクター状態。(型: `CharacterState`)          |

### メソッド

### SyncStateAnimation

`SyncStateAnimation() → void`

ZEPETO キャラクターの現在のキャラクター状態と Animator を同期させます。

### ChangeStateAnimation

`ChangeStateAnimation(state: CharacterState) → void`

指定されたキャラクター状態に対応するアニメーションを Animator で再生します。

| パラメーター | 型                                   | 説明                      |
| ------ | ----------------------------------- | ----------------------- |
| state  | [CharacterState](./#characterstate) | 再生するアニメーションを表すキャラクター状態。 |

### ChangeStateAnimation

`ChangeStateAnimation(state: CharacterState, moveState: CharacterMoveState) → void`

指定されたキャラクター状態に対応するアニメーションを Animator で再生します。

| パラメーター    | 型                                           | 説明                                                        |
| --------- | ------------------------------------------- | --------------------------------------------------------- |
| state     | [CharacterState](./#characterstate)         | 再生するアニメーションを表すキャラクター状態。                                   |
| moveState | [CharacterMoveState](./#charactermovestate) | `state` が `CharacterState.Move` の場合の、アニメーション用の移動状態(省略可能)。 |

### ChangeStateAnimation

`ChangeStateAnimation(state: CharacterState, jumpState: CharacterJumpState) → void`

指定されたキャラクター状態に対応するアニメーションを Animator で再生します。

| パラメーター    | 型                                           | 説明                                                          |
| --------- | ------------------------------------------- | ----------------------------------------------------------- |
| state     | [CharacterState](./#characterstate)         | 再生するアニメーションを表すキャラクター状態。                                     |
| jumpState | [CharacterJumpState](./#characterjumpstate) | `state` が `CharacterState.Jump` の場合の、アニメーション用のジャンプ状態(省略可能)。 |

### ChangeStateAnimation

`ChangeStateAnimation(state: CharacterState, landingState: CharacterLandingState) → void`

指定されたキャラクター状態に対応するアニメーションを Animator で再生します。

| パラメーター       | 型                                                 | 説明                                                           |
| ------------ | ------------------------------------------------- | ------------------------------------------------------------ |
| state        | [CharacterState](./#characterstate)               | 再生するアニメーションを表すキャラクター状態。                                      |
| landingState | [CharacterLandingState](./#characterlandingstate) | `state` が `CharacterState.Landing` の場合の、アニメーション用の着地状態(省略可能)。 |

### Move

`Move(dir: Vector2) → void`

指定した方向にキャラクターを移動させます。

| パラメーター | 型         | 説明             |
| ------ | --------- | -------------- |
| dir    | `Vector2` | キャラクターが移動する方向。 |

### Move

`Move(dir: Vector3) → void`

指定した方向にキャラクターを移動させます。

| パラメーター | 型         | 説明             |
| ------ | --------- | -------------- |
| dir    | `Vector3` | キャラクターが移動する方向。 |

### MoveContinuously

`MoveContinuously(dir: Vector2) → void`

現在向いている方向を基準に、指定した方向へキャラクターを継続的に移動させます。

| パラメーター | 型         | 説明                             |
| ------ | --------- | ------------------------------ |
| dir    | `Vector2` | 現在向いている方向を基準とした、キャラクターが移動する方向。 |

### MoveContinuously

`MoveContinuously(dir: Vector3) → void`

現在向いている方向を基準に、指定した方向へキャラクターを継続的に移動させます。

| パラメーター | 型         | 説明                             |
| ------ | --------- | ------------------------------ |
| dir    | `Vector3` | 現在向いている方向を基準とした、キャラクターが移動する方向。 |

### MoveToPosition

`MoveToPosition(pos: Vector3) → void`

指定した位置までキャラクターを移動させます。

| パラメーター | 型         | 説明          |
| ------ | --------- | ----------- |
| pos    | `Vector3` | キャラクターの移動先。 |

### StopMoving

`StopMoving() → void`

キャラクターの移動を停止します。

### Jump

`Jump() → void`

キャラクターをジャンプさせます。

### DoubleJump

`DoubleJump() → void`

キャラクターに二段ジャンプをさせます。

### Teleport

`Teleport(pos: Vector3, rot: Quaternion) → void`

指定した Transform までキャラクターを即座に移動させます。

| パラメーター | 型            | 説明                  |
| ------ | ------------ | ------------------- |
| pos    | `Vector3`    | キャラクターがテレポートする位置。   |
| rot    | `Quaternion` | テレポート後にキャラクターが取る回転。 |

### SetGesture

`SetGesture(gesture: AnimationClip) → void`

指定したジェスチャーに対応するキャラクターのモーションを再生します。

| パラメーター  | 型               | 説明               |
| ------- | --------------- | ---------------- |
| gesture | `AnimationClip` | キャラクターが行うジェスチャー。 |

### CancelGesture

`CancelGesture() → void`

ジェスチャーの再生を停止します。

### GetSocket

`GetSocket(socket: KnowSockets) → Transform`

キャラクターのソケットの `Transform` を取得します。

| パラメーター | 型                             | 説明                 |
| ------ | ----------------------------- | ------------------ |
| socket | [KnowSockets](./#knowsockets) | ソケット(アタッチメントポイント)。 |

**戻り値:** `Transform` — 指定したソケットに紐づく `Transform` コンポーネント。

### GetSocket

`GetSocket(socket: string) → Transform`

キャラクターのソケットの `Transform` を取得します。

| パラメーター | 型        | 説明                    |
| ------ | -------- | --------------------- |
| socket | `string` | ソケット(アタッチメントポイント)の名前。 |

**戻り値:** `Transform` — 指定したソケットに紐づく `Transform` コンポーネント。

### GetBodyModifierProperties

`GetBodyModifierProperties() → ZepetoPropertyFlag[]`

キャラクターが着用しているボディ変形アイテムに紐づくキャラクタープロパティを取得します。

**戻り値:** `ZepetoPropertyFlag[]` — キャラクターが着用しているボディ変形アイテムに紐づくキャラクタープロパティ。

### DeformDefaultProperties

`DeformDefaultProperties() → void`

キャラクターが着用しているボディ変形アイテムを削除し、デフォルトの体型に戻します。

### DeformDefaultCostume

`DeformDefaultCostume() → void`

キャラクターが着用しているボディ変形アイテムを削除し、デフォルトの体型に戻したうえで、デフォルトの ZEPETO 衣装を適用します。

### add\_loadedCharacter

`add_loadedCharacter(value: Action) → void`

キャラクターの読み込み完了を処理するコールバック関数を追加します。

| パラメーター | 型        |
| ------ | -------- |
| value  | `Action` |

### remove\_loadedCharacter

`remove_loadedCharacter(value: Action) → void`

キャラクターの読み込み完了を処理するコールバック関数を削除します。

| パラメーター | 型        |
| ------ | -------- |
| value  | `Action` |

## CameraData

`class`

`ZepetoCamera` の初期設定を表します。

### プロパティ

| 名前                     | 型            | 説明                                                      |
| ---------------------- | ------------ | ------------------------------------------------------- |
| cameraPrefab           | `GameObject` | `ZepetoCamera` を初期化するためのプレハブ。                           |
| maxZoomDistance        | `number`     | カメラがターゲットからズームアウトできる既定の最大距離。                            |
| minZoomDistance        | `number`     | カメラがターゲットにズームインできる既定の最小距離。                              |
| maxPitch               | `number`     | カメラがターゲットの周りを回転する際の垂直方向の最大角度。                           |
| minPitch               | `number`     | カメラがターゲットの周りを回転する際の垂直方向の最小角度。                           |
| offset                 | `Vector3`    | ターゲットに対するカメラの既定のオフセット。                                  |
| lockXAxis              | `boolean`    | カメラの X 軸回転がロックされているかどうかを示します。                           |
| layer                  | `LayerMask`  | カメラが衝突できるレイヤーを定義します。                                    |
| collisionTimeThreshold | `number`     | カメラの衝突検出の時間しきい値。カメラが衝突にどれだけ速く反応するかに影響します。               |
| zoomSpeed              | `number`     | ズームイン・ズームアウトの速度。                                        |
| zoomDampSpeed          | `number`     | ズームイン・ズームアウトの補間速度。                                      |
| rotationSpeed          | `number`     | 回転の速度。                                                  |
| rotationDampSpeed      | `number`     | 回転の補間速度。                                                |
| characterCulling       | `boolean`    | カメラが近距離にあるときのレンダリングの問題を防ぐため、キャラクターのカリングを有効にするかどうかを示します。 |
| targetScaleWeight      | `number`     | カメラの位置と挙動を調整するために、ターゲットのスケールへ適用される重み。                   |

## CharacterData

`class`

`ZepetoCharacter` の初期設定を表します。

### プロパティ

| 名前                 | 型                                       | 説明                                    |
| ------------------ | --------------------------------------- | ------------------------------------- |
| slopeLimit         | `number`                                | キャラクターが登れる最大の傾斜角度。                    |
| stepOffset         | `number`                                | キャラクターが乗り越えられる垂直方向の最大高低差。             |
| skinWidth          | `number`                                | 衝突検出用のスキン幅。キャラクターが他のコライダーにめり込むのを防ぎます。 |
| minMoveDistance    | `number`                                | キャラクターが移動できる最小の隙間。                    |
| center             | `Vector3`                               | キャラクターのコライダーの中心点。                     |
| radius             | `number`                                | キャラクターのカプセルコライダーの半径。                  |
| height             | `number`                                | キャラクターのカプセルコライダーの高さ。                  |
| layer              | `LayerMask`                             | キャラクターが衝突できるレイヤーを定義します。               |
| shadow             | `GameObject`                            | キャラクターの影の視覚表現。                        |
| animatorController | `RuntimeAnimatorController`             | キャラクターの Animator Controller。          |
| walkSpeed          | `number`                                | キャラクターの歩行速度。                          |
| runSpeed           | `number`                                | キャラクターの走行速度。                          |
| jumpPower          | `number`                                | キャラクターのジャンプ力。                         |
| customMotionData   | [CustomMotionData](./#custommotiondata) | キャラクターモーションのカスタム設定。                   |

## ControllerData

`class`

`ZepetoPlayerControl` の設定を表します。

### プロパティ

| 名前                          | 型                  | 説明                                                         |
| --------------------------- | ------------------ | ---------------------------------------------------------- |
| inputAsset                  | `InputActionAsset` | 複雑な入力構成を管理するための入力アクションとバインディングのコンテナー。                      |
| eventSystem                 | `GameObject`       | ユーザー入力を処理し、UI コンポーネントへ伝達します。ボタンのクリックやドラッグ、ドロップなどの操作を処理します。 |
| useDefaultVirtualController | `boolean`          | デフォルトの V-Pad を使用するかどうかを決定します。                              |
| useDefaultInputController   | `boolean`          | デフォルトの入力コントローラーを使用するかどうかを決定します。                            |
| verticalController          | `GameObject`       | 縦画面向けの V-Pad コントローラープレハブ。                                  |
| horizontalController        | `GameObject`       | 横画面向けの V-Pad コントローラープレハブ。                                  |

## FloatingUIData

`class`

キャラクター関連の UI 設定を管理するクラス。

### プロパティ

| 名前                         | 型         | 説明                                                  |
| -------------------------- | --------- | --------------------------------------------------- |
| showNickNameLocalPlayer    | `boolean` | ローカルプレイヤーのキャラクターのニックネーム UI を表示するかどうかを決定します。         |
| showNickNameOtherPlayers   | `boolean` | 他のプレイヤーのキャラクターのニックネーム UI を表示するかどうかを決定します。           |
| showBubbleChatLocalPlayer  | `boolean` | ローカルプレイヤーのキャラクターの吹き出しチャット UI を表示するかどうかを決定します。       |
| showBubbleChatOtherPlayers | `boolean` | 他のプレイヤーのキャラクターの吹き出しチャット UI を表示するかどうかを決定します。         |
| useMiniProfileOnApp        | `boolean` | キャラクターをクリックしたときにミニプロフィールのポップアップ UI を表示するかどうかを決定します。 |

## LocalPlayer

`class`

移動、コスチュームのカスタマイズ、ZEPETO カメラの操作など、ローカルプレイヤーのアクションを管理するためのクラス。

### プロパティ

| 名前           | 型                               | 説明                                 |
| ------------ | ------------------------------- | ---------------------------------- |
| movingAxis   | `Transform`                     | ローカルプレイヤーの ZEPETO キャラクターの移動の中心軸。   |
| zepetoCamera | [ZepetoCamera](./#zepetocamera) | ローカルプレイヤーに紐づく ZEPETO カメラのインスタンス。   |
| zepetoPlayer | [ZepetoPlayer](./#zepetoplayer) | ローカルプレイヤーに紐づく ZEPETO プレイヤーのインスタンス。 |

### メソッド

### SetCostume

`SetCostume(itemCode: string, complete?: Action) → void`

ローカルプレイヤーの ZEPETO キャラクターのコスチュームを変更します。一般的な `Exception` をスローします。

| パラメーター          | 型        | 説明               |
| --------------- | -------- | ---------------- |
| itemCode        | `string` | コスチュームのアイテム ID。  |
| complete (省略可能) | `Action` | 完了を処理するコールバック関数。 |

### Jump

`Jump() → void`

ローカルプレイヤーの ZEPETO キャラクターをジャンプさせます。

### DoubleJump

`DoubleJump() → void`

ローカルプレイヤーの ZEPETO キャラクターに二段ジャンプをさせます。

### Move

`Move(dir: Vector2) → void`

ローカルプレイヤーの ZEPETO キャラクターを指定した方向へ移動させます。

| パラメーター | 型         | 説明             |
| ------ | --------- | -------------- |
| dir    | `Vector2` | キャラクターが移動する方向。 |

### Move

`Move(dir: Vector3) → void`

ローカルプレイヤーの ZEPETO キャラクターを指定した方向へ移動させます。

| パラメーター | 型         | 説明             |
| ------ | --------- | -------------- |
| dir    | `Vector3` | キャラクターが移動する方向。 |

### StopMoving

`StopMoving() → void`

ローカルプレイヤーの ZEPETO キャラクターを停止させます。

## ZepetoCamera

`class`

ZEPETO Character Controller 内で使用するために設計されたカメラ制御クラス。

### プロパティ

| 名前                        | 型                                             | 説明                                                                        |
| ------------------------- | --------------------------------------------- | ------------------------------------------------------------------------- |
| additionalMaxZoomDistance | `number`                                      | 既定の最大ズーム値に加算される追加距離。                                                      |
| additionalMinZoomDistance | `number`                                      | 既定の最小ズーム値に加算される追加距離。                                                      |
| additionalOffset          | `Vector3`                                     | ターゲットに対するカメラ位置へ適用される追加オフセット。                                              |
| currentState              | [CameraState](./#camerastate)                 | 現在のカメラ状態を取得します。                                                           |
| currentStateStatus        | [StateStatus](./#statestatus)                 | 現在のカメラ状態のステータスを取得します。                                                     |
| position                  | `Vector3`                                     | 現在のカメラの位置の値を取得します。                                                        |
| rotation                  | `Quaternion`                                  | 現在のカメラの回転の値を取得します。                                                        |
| distance                  | `number`                                      | ターゲットからの距離。                                                               |
| cameraParent              | `Transform`                                   | カメラの親オブジェクトの `Transform`。                                                 |
| isFollow                  | `boolean`                                     | カメラがターゲットを追従しているかどうかを示すフラグを取得します。                                         |
| StateMachine              | [StateMachine\<CameraState>](./#statemachine) | カメラのステートマシンを取得します。                                                        |
| FollowTarget              | `Transform`                                   | ターゲットの `Transform` を取得します。デフォルトでは、ローカルプレイヤーのキャラクターの `HEAD_UPPER` に設定されます。 |
| MaxZoomDistance           | `number`                                      | カメラがターゲットからズームアウトできる、計算後の最大距離。                                            |
| MinZoomDistance           | `number`                                      | カメラがターゲットにズームインできる、計算後の最小距離。                                              |
| LookOffset                | `Vector3`                                     | ターゲットに対するカメラの、計算後のオフセット。                                                  |
| LockXAxis                 | `boolean`                                     | カメラの X 軸回転がロックされているかどうかを示します。                                             |
| CollisionLayer            | `LayerMask`                                   | カメラが衝突できるレイヤーを定義します。                                                      |
| targetScaleWeight         | `number`                                      | カメラの位置と挙動を調整するために、ターゲットのスケールへ適用される重み。                                     |
| useCharacterCulling       | `boolean`                                     | カメラが近距離にあるときのレンダリングの問題を防ぐため、キャラクターのカリングを有効にするかどうかを示します。                   |
| zoomSpeed                 | `number`                                      | ズームイン・ズームアウトの速度。                                                          |
| zoomDampSpeed             | `number`                                      | ズームイン・ズームアウトの補間速度。                                                        |
| rotationSpeed             | `number`                                      | 回転の速度。                                                                    |
| rotationDampSpeed         | `number`                                      | 回転の補間速度。                                                                  |
| camera                    | `Camera`                                      | Unity の `Camera`。                                                         |

### イベント

| 名前             | 型                                      | 説明                                                                                                               |
| -------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| OnChangedState | `UnityEvent<CameraState, CameraState>` | カメラの状態が変化したときに発生するイベント。登録されたリスナーは 2 つのパラメーターを受け取ります: - 新しいカメラ状態。(型: `CameraState`) - 直前のカメラ状態。(型: `CameraState`) |
| OnUpdateState  | `UnityEvent<CameraState>`              | 現在のカメラ状態が `StateStatus.Update` のステータスにあるときに発生するイベント。登録されたリスナーは 1 つのパラメーターを受け取ります: - 現在のカメラ状態。(型: `CameraState`)  |

### メソッド

### Create

`static Create(camera: Camera, data: CameraData) → ZepetoCamera`

`ZepetoCamera` のインスタンスを作成します。

| パラメーター | 型                           | 説明                                                  |
| ------ | --------------------------- | --------------------------------------------------- |
| camera | `Camera`                    | `ZepetoCamera` のベースとして使用する Unity の `Camera` オブジェクト。 |
| data   | [CameraData](./#cameradata) | `ZepetoCamera` の初期設定。                               |

**戻り値:** [ZepetoCamera](./#zepetocamera) — `ZepetoCamera` の新しいインスタンス。

### SetFollowTarget

`SetFollowTarget(target: Transform, scaleReference?: Transform) → void`

カメラの追従ターゲットを設定します。

| パラメーター                | 型           | 説明                                                                                 |
| --------------------- | ----------- | ---------------------------------------------------------------------------------- |
| target                | `Transform` | カメラが追従する対象オブジェクトを表す `Transform`。                                                   |
| scaleReference (省略可能) | `Transform` | カメラの追従挙動をスケーリングする際の基準として使用する `Transform`。指定した場合、カメラはこの基準のスケールに基づいてターゲットとの距離を調整します。 |

### Rotate

`Rotate(delta: Vector2) → void`

カメラを回転させます。

| パラメーター | 型         | 説明   |
| ------ | --------- | ---- |
| delta  | `Vector2` | 回転量。 |

### DoZoom

`DoZoom(delta: number) → void`

カメラをズームします。

| パラメーター | 型        | 説明    |
| ------ | -------- | ----- |
| delta  | `number` | ズーム量。 |

## ZepetoPlayer

`class`

ZEPETO プレイヤーを表します。

### プロパティ

| 名前            | 型                                     | 説明                                            |
| ------------- | ------------------------------------- | --------------------------------------------- |
| userId        | `string`                              | プレイヤーのユーザー ID。アカウント作成時にランダムに割り当てられる一意の ID です。 |
| name          | `string`                              | プレイヤーのユーザー名。ZEPETO アプリでユーザーが設定します。            |
| character     | [ZepetoCharacter](./#zepetocharacter) | プレイヤーの ZEPETO キャラクター。                         |
| isLocalPlayer | `boolean`                             | ローカルプレイヤーかどうかを示します。                           |

### メソッド

### GetProfileTextureAsync

`GetProfileTextureAsync(complete: Action<Texture2D>) → void`

プレイヤーのプロフィール画像を取得します。一般的な `Exception` をスローします。

| パラメーター   | 型                   | 説明                         |
| -------- | ------------------- | -------------------------- |
| complete | `Action<Texture2D>` | 取得したプロフィール画像を処理するコールバック関数。 |

### Release

`Release() → void`

ZEPETO プレイヤーオブジェクトを解放します。

## ZepetoPlayerControl

`class`

ZEPETO プレイヤーの入力制御を管理します。

### メソッド

### Create

`static Create(playerActions: PlayerActions) → ZepetoPlayerControl`

`ZepetoPlayerControl` のインスタンスを作成します。

| パラメーター        | 型               | 説明                                       |
| ------------- | --------------- | ---------------------------------------- |
| playerActions | `PlayerActions` | `ZepetoPlayerControl` に関連付ける入力アクションのセット。 |

**戻り値:** [ZepetoPlayerControl](./#zepetoplayercontrol) — `ZepetoPlayerControl` の新しいインスタンス。
インスタンスは新しいゲームオブジェクトにアタッチされ、プレイヤーの入力アクションを処理できる状態になります。

## ZepetoCameraControl

`class`

カメラの移動やズームの入力処理を含め、ZEPETO 環境におけるカメラ操作を管理します。

### メソッド

### Create

`static Create(cameraActions: CameraActions) → ZepetoCameraControl`

`ZepetoCameraControl` のインスタンスを作成します。

| パラメーター        | 型               | 説明                                                                            |
| ------------- | --------------- | ----------------------------------------------------------------------------- |
| cameraActions | `CameraActions` | `ZepetoCameraControl` に関連付けるカメラアクションのセット。これらのアクションは、カメラがユーザー入力にどう反応するかを定義します。 |

**戻り値:** [ZepetoCameraControl](./#zepetocameracontrol) — `ZepetoCameraControl` の新しいインスタンス。
インスタンスは新しいゲームオブジェクトにアタッチされ、カメラの入力アクションを処理できる状態になります。

## CharacterState

`enum`

ZEPETO キャラクターの状態を表します。

| 名前       | 値   | 説明                                             |
| -------- | --- | ---------------------------------------------- |
| Invalid  | 0   | 未初期化、または無効。                                    |
| Idle     | 1   | キャラクターが移動も動作も行っていない状態。                         |
| Walk     | 2   | キャラクターがゆっくりと移動している状態。                          |
| Run      | 3   | キャラクターが速く移動している状態。                             |
| JumpIdle | 4   | キャラクターがその場でジャンプしている状態。                         |
| JumpMove | 5   | キャラクターが垂直方向の跳躍と水平方向の移動を組み合わせて、ある方向へジャンプしている状態。 |
| Teleport | 20  | キャラクターが間の空間を通らずに、ある場所から別の場所へ移動している状態。          |
| Gesture  | 30  | キャラクターがジェスチャーを行っている状態。                         |
| Move     | 102 | 一般的な移動状態。                                      |
| MoveTurn | 103 | キャラクターが移動方向を変えている状態。                           |
| Jump     | 104 | 一般的なジャンプ状態。                                    |
| Stamp    | 106 | キャラクターが踏み込み動作を行っている状態。                         |
| Falling  | 108 | キャラクターが自由落下している状態。                             |
| Landing  | 109 | キャラクターが落下後に地面へ戻る状態。                            |

## CharacterMoveState

`enum`

ZEPETO キャラクターの詳細な移動状態を表します。

| 名前       | 値  | 説明         |
| -------- | -- | ---------- |
| None     | -1 | None.      |
| MoveWalk | 0  | ゆっくりとした移動。 |
| MoveRun  | 1  | 速い移動。      |

## CharacterJumpState

`enum`

ZEPETO キャラクターの詳細なジャンプ状態を表します。

| 名前         | 値  | 説明                                |
| ---------- | -- | --------------------------------- |
| None       | -1 | None.                             |
| JumpIdle   | 0  | その場でのジャンプ。                        |
| JumpMove   | 1  | 垂直方向の跳躍と水平方向の移動を組み合わせた、方向を伴うジャンプ。 |
| JumpDash   | 2  | 素早いジャンプ。                          |
| JumpDouble | 3  | ジャンプ中にもう一度ジャンプを行う動作。              |

## CharacterLandingState

`enum`

ZEPETO キャラクターの詳細な着地状態を表します。

| 名前            | 値  | 説明        |
| ------------- | -- | --------- |
| None          | -1 | None.     |
| LandingSlight | 0  | 衝撃の小さい着地。 |
| LandingDeep   | 1  | 衝撃の大きい着地。 |
| LandingRoll   | 2  | 受け身を取る着地。 |

## KnowSockets

`enum`

キャラクター上の既知のアタッチメントポイント（ソケット）のセットを定義します。

| 名前          | 値 | 説明                 |
| ----------- | - | ------------------ |
| HEAD\_UPPER | 0 | キャラクターの頭部の上側を表します。 |

## MotionState

`class`

キャラクターのモーション状態と設定を管理するクラス。

### プロパティ

| 名前                  | 型                                                 | 説明                                     |
| ------------------- | ------------------------------------------------- | -------------------------------------- |
| useDoubleJump       | `boolean`                                         | キャラクターが二段ジャンプを行えるかどうかを決定します。           |
| doubleJumpPower     | `number`                                          | 二段ジャンプ時に加えられる追加の力。                     |
| useLanding          | `boolean`                                         | 着地モーションを適用するかどうかを決定します。                |
| useLandingRoll      | `boolean`                                         | 着地時にキャラクターが受け身を取るかどうかを決定します。           |
| landingRollSpeed    | `number`                                          | キャラクターの着地時の受け身の速度を取得または設定します。          |
| useMoveTurn         | `boolean`                                         | キャラクターの移動方向を変える際にモーションを再生するかどうかを決定します。 |
| gravity             | `number`                                          | キャラクターに適用される重力。                        |
| currentJumpState    | [CharacterJumpState](./#characterjumpstate)       | キャラクターの現在のジャンプ状態を取得します。                |
| currentLandingState | [CharacterLandingState](./#characterlandingstate) | キャラクターの現在の着地状態を取得します。                  |
| currentMoveState    | [CharacterMoveState](./#charactermovestate)       | キャラクターの現在の移動状態を取得します。                  |

## CharacterStateMachine

`class` · extends [StateMachine\<CharacterState>](./#statemachine)

ZEPETO キャラクターのキャラクター状態と Animator を同期させるクラス。

### プロパティ

| 名前                       | 型         | 説明                                                                                                        |
| ------------------------ | --------- | --------------------------------------------------------------------------------------------------------- |
| constraintStateAnimation | `boolean` | ZEPETO キャラクターの現在のキャラクター状態と Animator を同期させるかどうかを決定します。`true` に設定した場合、Animator の状態は現在のキャラクター状態に基づいて更新されません。 |

### メソッド

### SyncStateAnimation

`SyncStateAnimation() → void`

ZEPETO キャラクターの現在のキャラクター状態と Animator を同期させます。

### ChangeStateAnimation

`ChangeStateAnimation(state: CharacterState) → void`

指定されたキャラクター状態に対応するアニメーションを Animator で再生します。

| パラメーター | 型                                   | 説明                      |
| ------ | ----------------------------------- | ----------------------- |
| state  | [CharacterState](./#characterstate) | 再生するアニメーションを表すキャラクター状態。 |

## StateMachine

`class`

`StateMachine` manages the `States`, `Transitions`, and `Events`.
指定された条件と経過時間に応じて状態を更新することで、オブジェクトのさまざまな状態を定義し制御できます。

### プロパティ

| 名前              | 型                                               | 説明                                                                    |
| --------------- | ----------------------------------------------- | --------------------------------------------------------------------- |
| OnChangedState  | `Action<TEnum, TEnum>`                          | カメラの状態が変化したときに発生するイベント。登録されたリスナーは 2 つのパラメーターを受け取ります: - 新しい状態。- 直前の状態。 |
| Events          | [TransitionBase\<TEnum>\[\]](./#transitionbase) | ステートマシンで定義されたすべてのイベントの配列を提供します。                                       |
| Current         | [State\<TEnum>](./#state)                       | 現在のステートを取得します。                                                        |
| Prev            | [State\<TEnum>](./#state)                       | 直前のステートを取得します。                                                        |
| IsRunning       | `boolean`                                       | ステートマシンがステートと遷移を実際に処理しているかどうかを示します。                                   |
| stateCount      | `number`                                        | ステートマシンで定義されたステートの数を取得します。                                            |
| transitionCount | `number`                                        | ステートマシンで定義された遷移の数を取得します。                                              |

### メソッド

### FindState

`FindState(state: TEnum, success: Action<State<TEnum>>, failed: Action) → void`

ステートマシン内のステートを検索し、成功した場合にコールバックを実行します。

| パラメーター  | 型                      | 説明                            |
| ------- | ---------------------- | ----------------------------- |
| state   | `TEnum`                | ステートマシン内で検索するステート。            |
| success | `Action<State<TEnum>>` | 見つかった `State` を処理するコールバック関数。  |
| failed  | `Action`               | ステートが見つからなかった場合を処理するコールバック関数。 |

### FindTransitions

`FindTransitions(from: TEnum, success: Action<Transition<TEnum>[]>, failed: Action) → void`

ステートマシン内の遷移を検索し、成功した場合にコールバックを実行します。

| パラメーター  | 型                             | 説明                                   |
| ------- | ----------------------------- | ------------------------------------ |
| from    | `TEnum`                       | 遷移の開始元となるステート。                       |
| success | `Action<Transition<TEnum>[]>` | 見つかった `Transition` の配列を処理するコールバック関数。 |
| failed  | `Action`                      | 遷移が見つからなかった場合を処理するコールバック関数。          |

### FindTransition

`FindTransition(from: TEnum, to: TEnum, success: Action<Transition<TEnum>>, failed: Action) → void`

ステートマシン内の遷移を 1 つ検索し、成功した場合にコールバックを実行します。

| パラメーター  | 型                           | 説明                                |
| ------- | --------------------------- | --------------------------------- |
| from    | `TEnum`                     | 遷移の開始元となるステート。                    |
| to      | `TEnum`                     | 遷移先となるステート。                       |
| success | `Action<Transition<TEnum>>` | 見つかった `Transition` を処理するコールバック関数。 |
| failed  | `Action`                    | 遷移が見つからなかった場合を処理するコールバック関数。       |

### Start

`Start(state: TEnum) → void`

ステートマシンの処理を開始します。

| パラメーター | 型       | 説明                   |
| ------ | ------- | -------------------- |
| state  | `TEnum` | ステートマシンが処理を開始するステート。 |

### Update

`Update(deltaTime: number) → void`

ステートマシンの現在のステートと遷移を更新します。

| パラメーター    | 型        | 説明                           |
| --------- | -------- | ---------------------------- |
| deltaTime | `number` | 前回の `Update` 呼び出しからの経過時間(秒)。 |

### Stop

`Stop() → void`

ステートマシンの処理を停止します。

### EnterState

`EnterState(state: TEnum) → void`

ステートマシンを指定したステートへ遷移させます。

| パラメーター | 型       | 説明                  |
| ------ | ------- | ------------------- |
| state  | `TEnum` | ステートマシンの遷移先となるステート。 |

### LeaveState

`LeaveState(nextState: TEnum) → void`

ステートマシンが現在のステートを終了します。

| パラメーター    | 型       | 説明                               |
| --------- | ------- | -------------------------------- |
| nextState | `TEnum` | 現在のステートの `OnLeave` で処理される次のステート。 |

## StateStatus

`enum`

ステートマシン内におけるステートの取り得るステータスを表し、ステートのライフサイクルの現在の段階を示します。

| 名前     | 値 | 説明                            |
| ------ | - | ----------------------------- |
| Wait   | 0 | ステートは非アクティブで、開始されるのを待っている状態。  |
| Enter  | 1 | ステートが開始処理中の状態。                |
| Update | 2 | ステートがアクティブで、そのロジックが実行されている状態。 |
| End    | 3 | ステートがアクティブな段階を完了し、終了できる状態。    |
| Leave  | 4 | ステートが終了処理中の状態。                |

## CustomMotionData

`class`

キャラクターモーションのカスタム設定を表します。

### プロパティ

| 名前                            | 型         | 説明                                        |
| ----------------------------- | --------- | ----------------------------------------- |
| useDoubleJump                 | `boolean` | キャラクターが二段ジャンプを行えるかどうかを決定します。              |
| doubleJumpPower               | `number`  | 二段ジャンプ時に加えられる追加の力。                        |
| useLanding                    | `boolean` | 着地モーションを適用するかどうかを決定します。                   |
| useLandingRoll                | `boolean` | 着地時にキャラクターが受け身を取るかどうかを決定します。              |
| landingRollSpeed              | `number`  | 着地時の受け身モーションの再生速度。                        |
| useMoveTurn                   | `boolean` | キャラクターの移動方向を変える際にモーションを再生するかどうかを決定します。    |
| gravity                       | `number`  | キャラクターに適用される重力。                           |
| walkThreshold                 | `number`  | 歩行モーションの加速を発生させるために必要な最小入力値。              |
| runThreshold                  | `number`  | 歩行モーションから走行モーションへ切り替えるために必要な最小入力値。        |
| fallingTimeThreshold          | `number`  | キャラクターが落下状態に入ったかどうかを判定するための最小落下時間。        |
| fallingSpeedThreshold         | `number`  | キャラクターが落下状態に入ったかどうかを判定するための最小落下速度。        |
| landingTimeThreshold          | `number`  | キャラクターが着地したかどうかを判定するための最小着地時間。            |
| landingSpeedThreshold         | `number`  | 着地時にキャラクターが追加の動作を行えるかどうかを判定するための最小落下速度。   |
| landingImpactSpeedThreshold   | `number`  | 着地時にキャラクターがより大きな衝撃を受けるかどうかを判定するための最小落下速度。 |
| landingRollSpeedThreshold     | `number`  | 着地時の受け身を発生させるために必要な最大落下速度。                |
| moveTurnAngleThreshold        | `number`  | 方向転換モーションを発生させるために必要な最小旋回角度。              |
| moveTurnSpeedThreshold        | `number`  | 方向転換モーションを発生させるために必要な最小移動速度。              |
| moveTurnTimeThreshold         | `number`  | 方向転換モーションの継続時間。                           |
| jumpDashSpeedThreshold        | `number`  | ダッシュを発生させるために必要な最小ジャンプ速度。                 |
| walkClipBaseSpeed             | `number`  | 歩行モーションの基本速度。                             |
| stampClipNormalizedTime       | `number`  | 踏み込みモーションの継続時間。                           |
| landingClipNormalizedTime     | `number`  | 着地モーションの継続時間。                             |
| landingRollClipNormalizedTime | `number`  | 着地時の受け身モーションの継続時間。                        |
| moveTurnClipNormalizedTime    | `number`  | 方向転換モーションの継続時間。                           |

## CharacterShadow

`class`

ZEPETO キャラクターの影を管理するクラス。

### プロパティ

| 名前                | 型           | 説明                           |
| ----------------- | ----------- | ---------------------------- |
| target            | `Transform` | Transform の基準となるオブジェクトを表します。 |
| autoSyncTransform | `boolean`   | 影の位置をターゲットに同期させるかどうかを決定します。  |

## CameraState

`enum`

`ZepetoCamera` の状態を表します。

| 名前     | 値 | 説明                   |
| ------ | - | -------------------- |
| Idle   | 0 | カメラがターゲットを追従していない状態。 |
| Follow | 1 | カメラがターゲットを追従している状態。  |

## ZepetoScreenStick

`class` · extends [ZepetoScreenControl](./#zepetoscreencontrol)

ZEPETO 環境におけるスティック操作を処理するためのクラス。

### イベント

| 名前                 | 型                     | 説明                          |
| ------------------ | --------------------- | --------------------------- |
| OnPointerDownEvent | `UnityEvent`          | スティックが押されたときに発生するイベント。      |
| OnDragEvent        | `UnityEvent<Vector2>` | スティックがドラッグされているときに発生するイベント。 |
| OnPointerUpEvent   | `UnityEvent`          | スティックが離されたときに発生するイベント。      |

### メソッド

### OnDrag

`OnDrag(eventData: PointerEventData) → void`

ドラッグの挙動を管理し、位置の差分を計算して指定された移動範囲内に制限します。
正規化された位置の値とともに `OnDragEvent` を発生させます。
`ArgumentNullException` をスローします。

| パラメーター    | 型                  | 説明               |
| --------- | ------------------ | ---------------- |
| eventData | `PointerEventData` | ドラッグイベントに関するデータ。 |

## ZepetoScreenControl

`class`

ZEPETO 環境で UI コントロールを作成するための抽象クラス。

### メソッド

### OnPointerDown

`OnPointerDown(eventData: PointerEventData) → void`

ユーザーが UI コントロールを押したときのイベントを処理します。

| パラメーター    | 型                  | 説明                     |
| --------- | ------------------ | ---------------------- |
| eventData | `PointerEventData` | ポインターが押されたイベントに関するデータ。 |

### OnPointerUp

`OnPointerUp(eventData: PointerEventData) → void`

ユーザーが UI コントロールを離したときのイベントを処理します。

| パラメーター    | 型                  | 説明                     |
| --------- | ------------------ | ---------------------- |
| eventData | `PointerEventData` | ポインターが離されたイベントに関するデータ。 |

## ZepetoScreenButton

`class` · extends [ZepetoScreenControl](./#zepetoscreencontrol)

ZEPETO 環境におけるボタン操作を処理するためのクラス。

### イベント

| 名前               | 型            | 説明                   |
| ---------------- | ------------ | -------------------- |
| OnPointDownEvent | `UnityEvent` | ボタンが押されたときに発生するイベント。 |
| OnPointUpEvent   | `UnityEvent` | ボタンが離されたときに発生するイベント。 |

## ZepetoScreenTouchpad

`class` · extends [ZepetoScreenControl](./#zepetoscreencontrol)

ZEPETO 環境におけるタッチパッド操作を処理するためのクラス。

### プロパティ

| 名前                            | 型                | 説明                                                  |
| ----------------------------- | ---------------- | --------------------------------------------------- |
| canvasGroupTouchPadBackground | `CanvasGroup`    | タッチパッドの背景の不透明度と操作を管理するために使用する Canvas Group コンポーネント。 |
| touchPadBackgroundCurve       | `AnimationCurve` | タッチパッドの背景のフェードイン・フェードアウト効果に使用するアニメーションカーブ。          |
| touchHandle                   | `RectTransform`  | タッチハンドルを表す `RectTransform` コンポーネント。                 |
| touchHandleAnimator           | `Animator`       | タッチハンドルをアニメーションさせるために使用する Animator コンポーネント。         |
| touchHandleOrigin             | `RectTransform`  | タッチハンドルの元の位置を示す `RectTransform`。                    |
| touchHandleOriginAnimator     | `Animator`       | タッチハンドルの原点用の Animator コンポーネント。                      |

### イベント

| 名前                 | 型                     | 説明                           |
| ------------------ | --------------------- | ---------------------------- |
| OnPointerDownEvent | `UnityEvent`          | タッチパッドが押されたときに発生するイベント。      |
| OnDragEvent        | `UnityEvent<Vector2>` | タッチパッドがドラッグされているときに発生するイベント。 |
| OnPointerUpEvent   | `UnityEvent`          | タッチパッドが離されたときに発生するイベント。      |

### メソッド

### OnPointerClick

`OnPointerClick(eventData: PointerEventData) → void`

タッチパッド上のクリックイベントを処理します。`ArgumentNullException` をスローします。

| パラメーター    | 型                  | 説明               |
| --------- | ------------------ | ---------------- |
| eventData | `PointerEventData` | ドラッグイベントに関するデータ。 |

### OnDrag

`OnDrag(eventData: PointerEventData) → void`

ドラッグの挙動を管理し、位置の差分を計算して指定された移動範囲内に制限します。
正規化された位置の値とともに `OnDragEvent` を発生させます。
`ArgumentNullException` をスローします。

| パラメーター    | 型                  | 説明               |
| --------- | ------------------ | ---------------- |
| eventData | `PointerEventData` | ドラッグイベントに関するデータ。 |

## UIZepetoPlayerControl

`class`

ローカルプレイヤーのキャラクターを UI で操作する機能を提供するクラス。

### メソッド

### StartMoving

`StartMoving() → void`

ローカルプレイヤーのキャラクターの移動フラグを `true` に設定します。

### Move

`Move(delta: Vector2) → void`

ローカルプレイヤーの ZEPETO キャラクターの移動方向を設定します。

| パラメーター | 型         |
| ------ | --------- |
| delta  | `Vector2` |

### StopMoving

`StopMoving() → void`

ローカルプレイヤーの ZEPETO キャラクターを停止させます。

### Jump

`Jump() → void`

ローカルプレイヤーの ZEPETO キャラクターをジャンプさせます。

### DoubleJump

`DoubleJump() → void`

ローカルプレイヤーの ZEPETO キャラクターに二段ジャンプをさせます。

### Update

`Update() → void`

ローカルプレイヤーの ZEPETO キャラクターの移動方向を更新します。

## InputHelper

`class`

入力処理を補助するためのユーティリティクラス。

### メソッド

### IsPointerOverUIObjectCurrentPosition

`static IsPointerOverUIObjectCurrentPosition() → boolean`

ポインターが現在 UI オブジェクトの上にあるかどうかを判定します。

**戻り値:** `boolean` — ポインターが UI オブジェクトの上にある場合は `true` を返します。

### IsPointerOverUIObject

`static IsPointerOverUIObject(position: Vector2) → boolean`

画面上の指定した位置が UI 要素の上にあるかどうかを確認します。

| パラメーター   | 型         | 説明      |
| -------- | --------- | ------- |
| position | `Vector2` | 画面上の位置。 |

**戻り値:** `boolean` — その位置が UI オブジェクトの上にある場合は `true` を返します。

## EventReceiver

`class`

ZEPETO World 内のキャラクター関連イベントや一般的なイベントを処理するクラス。

### イベント

| 名前                               | 型                                   | 説明                                |
| -------------------------------- | ----------------------------------- | --------------------------------- |
| OnCharacterClick (static)        | `UnityEvent<string, ZepetoContext>` | キャラクターがクリックされたときに発生するイベント。        |
| OnCharacterProfileClick (static) | `UnityEvent<string, ZepetoContext>` | キャラクターのプロフィールがクリックされたときに発生するイベント。 |
| OnClick (static)                 | `UnityEvent<number>`                | さまざまなインタラクティブ要素に使用できる汎用のクリックイベント。 |

## TransitionBase

`class`

ステートマシンにおけるステート間の遷移を定義するための基底クラス。

### プロパティ

| 名前        | 型                             | 説明                                                                     |
| --------- | ----------------------------- | ---------------------------------------------------------------------- |
| To        | `TEnum`                       | 遷移先となるステート。                                                            |
| Duration  | `number`                      | 遷移の開始から終了までにかかる時間(秒)。                                                  |
| Status    | [StateStatus](./#statestatus) | 遷移のステータス。                                                              |
| IsRunning | `boolean`                     | 遷移が現在 `StateStatus.Enter` または `StateStatus.Update` のステータスにあるかどうかを示します。 |

### メソッド

### Check

`Check() → boolean`

遷移を発生させる条件が満たされているかどうかを確認します。

**戻り値:** `boolean` — 遷移の条件が満たされている場合は `true`。

## State

`class`

ステートマシン内のステートを表します。

### プロパティ

| 名前            | 型                             | 説明                    |
| ------------- | ----------------------------- | --------------------- |
| OnUpdateState | `Action<TEnum>`               | ステートの更新を処理するコールバック関数。 |
| stateType     | `TEnum`                       | ステートの型。               |
| Status        | [StateStatus](./#statestatus) | ステートのステータス。           |

## Transition

`class` · extends [TransitionBase\<TEnum>](./#transitionbase)

ステートマシンにおけるステート間の遷移を定義するためのジェネリッククラス。

### プロパティ

| 名前   | 型       | 説明             |
| ---- | ------- | -------------- |
| From | `TEnum` | 遷移の開始元となるステート。 |

## ZepetoCharacter.LoadingStatus

`enum`

ZEPETO キャラクターの読み込み状態。

| 名前        | 値 | 説明                         |
| --------- | - | -------------------------- |
| NotLoaded | 0 | キャラクターがまだ読み込み処理を開始していない状態。 |
| Loading   | 1 | キャラクターが読み込み処理中の状態。         |
| Loaded    | 2 | キャラクターの読み込みが完了した状態。        |
| Error     | 3 | 読み込み処理中にエラーが発生した状態。        |

## PlayerControlMode

`enum`

| 名前       | 値 |
| -------- | - |
| Default  | 0 |
| WalkOnly | 1 |
| RunOnly  | 2 |
