ZEPETO Mannequin
ZEPETO Mannequinは、着せ替え/販売機能をサーポートするマネキンAPIパッケージです。
- オリジナル制作アイテムをワールドで販売できるようになります。
- ZEPETOアバターのNPCに指定したコーデを着せたマネキンを作成できます。
- マネキン又はオブジェクトとインタラクションし、ファッションアイテムを購入できます。
Window → Package Manager → を選択し、まず ZEPETO.World パッケージ 1.21.15 以降をインストールしてください。
その後、ZEPETO.Module 1.0.8 パッケージをインストールしてください。
❗️ 注意事項
- パフォーマンス向上の一環として、スタンドアロン パッケージは ZEPETO.Module 1.0.8 以降のバージョンのパッケージに統合されました。
- 以前にインストールした ZEPETO.Mannquin パッケージを削除してください。
- 既存のパッケージを削除した後、ZEPETO.Module パッケージ バージョン 1.0.8 以降をインストールしてください。
👍 アイテムID確認する方法
- ZEPETO Studioでアイテム商品をクリックするとポップアップするURLで確認できます。
- アイテムIDを乱数形式でコピーし、Unityエディターに貼り付け、その前に「CR_」を貼り付けます。
📘 アイテム制作が初めての方は、次のガイドを参考にしてください [Create Your Item]
マネキンオブジェクトは、全部で3つの方法で制作できます。
❗️ 注意事項
- ZEPETO Mannequinはご自身のオリジナル制作のアイテムだけがワールドに設定/販売する事ができます。
- 審査で拒否されたアイテムは販売する事ができません。
- Unityのログインが必須の機能です。
- マネキン機能を含んだパッケージをPublishする際も編集ログインが必要です。
- ZEPETO Template、ZEPETO Model Typeのマネキンを使用する場合、マネキンの数だけゼペトキャラクターが入場した程度のリソースを占めて、最適化に影響を与えることができます。
- もし、ワールド内に多くのゼペットキャラクター形状のマネキンを入れなければならない場合は、Simple Typeのマネキンを選択した後、オブジェクトとして ZEPETO BaseModel を活用することをお勧めします。
とても基本的な方式です。Mannequin次式で特定オブジェクトを追加し外形を調整できます。
- 対話するオブジェクトを追加します。
- オブジェクトにインタラクションする為、Colliderを必ず追加しなければなりません。
- is Tringeerチェックは必須です。万が一チェックが確認できなければ、自動的にトリッカーとして認識処理されます。
- Colliderを追加しないままマネキンのコンポーネットを追加する際、下記のような警告が出てきます。
- オブジェクトにマネキンコンポーネントを追加します。
- Please set the following in the inspector.
- icon: 基本的にはハンガーアイコンです。カスタムアイコンに変更可能です。
- icon position: 基本的にマネキンコンポーネントがあるオブジェクトの位置にアイコンが現れます。
- position objectを追加後、値を入れると思い通りの位置に現れます。
- ids: 販売したいファッションアイテムIDを作成できます。
- Empty Objectを追加し、オブジェクトの名前をMannequinScriptで作成します。
- ZEPETO> Typescriptを追加し、スクリプトの名前をMannequinScriptで作成します。
- 以下内容通りに作成します。
- スクリプトをオブジェクトに追加し、[▶︎(play)]ボタンを押して実行します。
ZEPETOアバターのNPCにアイテムIDを追加し、マネキン外形を変更することができます。
- Empty Objectを生成して、名前をMannequinで作成します。
- オブジェクトにインタラクションする為、Colliderを必ず追加しなければなりません。
- is Tringeerチェックは必須です。万が一チェックが確認できなければ、自動的にトリッカーとして認識処理されます。
- オブジェクトにマネキンコンポーネントを追加します。
- Please set the following in the inspector.
- icon: 基本的にはハンガーアイコンです。カスタムアイコンに変更可能です。
- icon position: 基本的にマネキンコンポーネントがあるオブジェクトの位置にアイコンが現れます。
- position objectを追加後、値を入れると思い通りの位置に現れます。
- ids: 販売したいファッションアイテムIDを作成できます。
- pose: ポーズを選択し、設置できます。
- 今後、思い通りのポーズをポーズid形態に提供する予定です。
👍 シーンにマネキン スクリプトが既にある場合は、後の手順を省略できます。
- Empty Objectを追加し、オブジェクトの名前をMannequinScriptで作成します。
- ZEPETO> Typescriptを追加し、スクリプトの名前をMannequinScriptで作成します。
- 以下内容通りに作成します。
- スクリプトをオブジェクトに追加し、[▶︎(play)]ボタンを押して実行します。
ZEPETO IDを入力したら、そのアバターが着用しているコーデをマネキンが着用し登場します。ただし、自分で作ったオリジナルアイテムでない場合はコーデは確認できないです。
- Empty Objectを生成して、名前をMannequinで作成します。
- オブジェクトにインタラクションする為、Colliderを必ず追加しなければなりません。
- is Tringeerチェックは必須です。万が一チェックが確認できなければ、自動的にトリッカーとして認識処理されます。
- オブジェクトにマネキンコンポーネントを追加します。
- Please set the following in the inspector.
- icon: 基本的にはハンガーアイコンです。カスタムアイコンに変更可能です。
- icon position: 基本的にマネキンコンポーネントがあるオブジェクトの位置にアイコンが現れます。
- position objectを追加後、値を入れると思い通りの位置に現れます。
- zepeto id: ZEPETO IDを入力してください。
- pose: ポーズを選択し、設置できます。
- 今後、思い通りのポーズをポーズid形態に提供する予定です。
👍 シーンにマネキン スクリプトが既にある場合は、後の手順を省略できます。
- Empty Objectを追加し、オブジェクトの名前をMannequinScriptで作成します。
- ZEPETO> Typescriptを追加し、スクリプトの名前をMannequinScriptで作成します。
- 以下内容通りに作成します。
- スクリプトをオブジェクトに追加し、[▶︎(play)]ボタンを押して実行します。
マネキン設置を正しく終えたら、マネキンオブジェクトのCollider領域内に入った際にインタラクション出来るアイコンが現れます。
アイコンをクリックした場合、購入ポップアップが開き、マネキンに設置したアイテムが現れます。
アイテムをクリックしたら、着せ替えが出来ます。
- 既に保有したアイテムは、価格の代わりにチェック表示が現れます。
マネキンオブジェクトのCollider 領域から出た際、着せ替えが消去され、本来のコーデに戻ります。
テスト環境 | 購入処理 |
---|---|
Unity Editorで購入 | プレイ中に購入が成功しコーデが変更できますが、プレイ終了すると本来の状態に戻ります。 |
QRコードモバイルテスト環境での購入 | この場合は、実際のサーバーに接続してテストをするので、購入成功時、コーデが変更となりワールドを退出した際にも変更されたコーデが維持されます。 また、購入成功時に、実際のサーバーでアイテムを購入することになりますので、実際のアカウントが保有するジェムが差し引かれ、衣装アイテムを所持することになります。購入した衣装を任意に捨てたり削除することはできませんので、テスト時に慎重に購入してください。 |
ZEPETO Studioにパッケージ登録後、テストリンクから接続して購入 | この場合は、実際のサーバーに接続してテストをするので、購入成功時、コーデが変更となりワールドを退出した際にも変更されたコーデが維持されます。 また、購入成功時に、実際のサーバーでアイテムを購入することになりますので、実際のアカウントが保有するジェムが差し引かれ、衣装アイテムを所持することになります。購入した衣装を任意に捨てたり削除することはできませんので、テスト時に慎重に購入してください。 |
マルチプレイは、他のプレイヤーがマネキン機能を使用して着用した衣装を同期させる必要があります。
👍 以下の内容を作業する前に、基本的なマルチプレイセッティングを完了させてください。
- クライアントスクリプトを追加します。ZEPETO > Typescript を追加して、スクリプトの名前をMannequinControllerに設定します。
- 以下の内容通りに作成してください。
- Hierarchy > Empty Objectを作成して、名前をMannequinControllerに設定します。
- 先ほど作成したスクリプトをMannequinControllerに追加してください。
- 次に、World.Multiplay > index.tsで、以下の内容を参考にサーバーコードを作成してください。
- マルチプレイサーバーをOnにし、テストをしてください。
ZEPETO Mannequin 1.1.0 バージョンからイベント関数を使用することができます。
関数 | 説明 |
---|---|
public static OnSelectedItem: UnityEngine_Events.UnityEvent$2<ItemContent, boolean>; | マネキンコーデ購入ウィンドウで特定のアイテムを選択したときに呼び出され、選択したアイテム情報アイテムContentおよびアイテム選択の可否がboolean値に移されます。 |
public static OnSucceededPurchaseItems: UnityEngine_Events.UnityEvent$1<ItemContent[]>; | コーデ購入完了時に呼び出され、購入したアイテム情報アイテムContentリストが渡されます。 |
public static OnFailedPurchaseItems: UnityEngine_Events.UnityEvent$1<ItemContent[]>; | コーデの購入に失敗時に呼び出され、購入に失敗したアイテム情報アイテムContentリストが渡されます。 |
public static OnAppliedItems: UnityEngine_Events.UnityEvent$1<ItemContent[]>; | コーデ購入成功後、購入したアイテムを着用すると選択した時に呼び出され、着用したアイテム情報アイテムContentリストが渡されます。 |
public static OnOpenedShopUI: UnityEngine_Events.UnityEvent$1<ItemContent[]>; | マネキンコーデ購入ウィンドウが開く時に呼び出され、購入ウィンドウにあるアイテム情報ItemContentリストが送信されます。 |
public static OnClosedShopUI: UnityEngine_Events.UnityEvent; | マネキンコーデの購入ウィンドウが閉じたときに呼び出されます。 |
関数 | 説明 |
---|---|
public OnChanged: UnityEngine_Events.UnityEvent$1<ZEPETO_Mannequin_BasePreviewer.ChangedValue[]>; | マネキンを押して着用中のアイテム情報が変わると毎回呼び出され、OnChagedValueリストが移動します。 |
OnChagedValueクラスのメンバー変数情報は次のとおりです。
public property : ZepetoPropertyFlag | コーデ詳細情報 |
---|---|
public id : string | item ID |
Mannequin.WorldCameraをセッティングしないと、マネキンインタラクションアイコンと関連したカメラとしてDepthが低いカメラが設定されます。
他のカメラを別途セッティングしたい場合には、Mannequin.WorldCameraを使用すると指定できます。
Variable | 説明 |
---|---|
Mannequin.WorldCamera | マネキンインタラクションアイコンと関連したカメラを直接セッティングできるようにする変数です。 |
従来のMannequinScriptにMannequin.WorldCameraをセッティングした例は以下の通りです。
A callback has been added that is triggered when all clothing items are fully loaded while using the Mannequin API to equip clothing items.
An example of setting OnContentsLoaded in the existing MannequinScript is as follows.