スラッシュコマンドとは？
スラッシュコマンドという機能を使うと、ワールド・アイテム制作を効率化することができます。例えば、自分のアバターを指定の座標にワープさせたり、デバッグを効率化する機能などが使えます。
この記事では、スラッシュコマンドの基本的な使い方と使用できる機能を簡単に紹介します。
詳細な解説はCluster Creator Kitドキュメントをご覧ください。
スラッシュコマンドの有効化
スラッシュコマンドはclusterのワールド内で使用することができます。主に自身が制作したワールド内で使うことになります。
スラッシュコマンドを使用する手順は以下の通りです。
- 右上のclusterロゴからメニューを開いてください
- メニュー上部バーの一番左にある「設定（歯車のアイコン）」を選択してください
- 左のメニューから「その他」を選択してください
- 「その他」メニューの一番上にあるデベロッパーメニューの「開発者向け機能の有効化」をONにしてください
- メニューを閉じて、右上のclusterロゴの左にある「…」を選択して、「デベロッパーメニュー」を選択してください
- デベロッパーメニューが開かれるので、その中の「スラッシュコマンド」と「コンソール」をONにしてください
これでスラッシュコマンドが使えるようになります！後述するコマンドをコメント欄に入力することでスラッシュコマンドを使用できます。
※コマンドによっては「コンソール」に結果が表示されるため、「コンソール」もONにしてください。
アイテムのIDを確認するのに便利な「アイテムインスペクター」
スラッシュコマンドを使う際に「itemID」が必要になることがあります。
スラッシュコマンドでコンソールに表示して確認することもできますが、「アイテムインスペクター」という機能を利用して確認することもできます。アイテムインスペクターは下記の手順で使用できます。
- 右上のclusterロゴからメニューを開いてください
- メニュー上部バーの一番左にある「設定（歯車のアイコン）」を選択してください
- 左のメニューから「その他」を選択してください
- 「その他」メニューの一番上にあるデベロッパーメニューの「開発者向け機能の有効化」をONにしてください
- メニューを閉じて、右上のclusterロゴの左にある「…」を選択して、「デベロッパーメニュー」を選択してください
- デベロッパーメニューが開かれるので、その中の「アイテムインスペクター」を選択してください
アイテムインスペクターでアイテムを選択すると、ワールド内でそのアイテムが黄色でハイライトされ、IDを確認することができます。
詳細な機能や権限についてはアイテムインスペクターのヘルプ記事を参照してください。
全員が使えるコマンド
/help
使用できるスラッシュコマンドの一覧を確認することができます。
ワールドの作者のみが実行できるコマンド
/getmyposition
自分が今いる座標を表示します。
省略形: /getmypos
/item destroy itemID
itemID で表されるアイテムを削除します。ワールド設置アイテム（クラフトアイテム以外のUnityで配置されアップロードされたアイテム）は削除できません。
/item owner itemID
itemID で表されるアイテムの現在のオーナーのユーザーIDをコンソールに表示します。
/items
空間内のScriptable Item コンポーネントを持つアイテムのID一覧をコンソールに表示します。 表示されるIDはItemHandle.idで取得できるものと同等です。
/respawn
自分をリスポーン（入室して最初に降り立つ位置に移動）させます。
/users
空間内のユーザーのID一覧をコンソールに表示します。 表示されるIDはPlayerHandle.idで取得できるものと同等です。
/warp x y z
自身を(x y z)で指定する座標にワープさせます。
x、y、zをそれぞれ数字に置き換えてください（ex. /warp 12 15 20）
/dummygift price displayName userId giftType
- ギフトコールバックAPIのデバッグ目的として使用することができます。ギフトコールバックAPIについては、以下の記事を参考にしてください。
- スペース、またはワールドクラフトで使用でき、イベントでは使用できません。
- このコマンドを実行してもクラスターコインは使用されず、Vポイントの付与も発生しません。また、イベントで実際にギフトを贈った場合に表示されるギフトオブジェクトも表示されません。
- このコマンドでは price 以降の値を省略可能であり、以下いずれかの形式で呼び出します。
- /dummygift
- /dummygift price
- /dummygift price displayName
- /dummygift price displayName userId
- /dummygift price displayName userId giftType
- 記述例: /dummygift 200 PlayerName 01234567-89ab-cdef-0123-456789abcdef 0001_c02
- price では、ギフトの価格をクラスターコインの数量として、ダミーの正の整数で指定します。小数は無効な値として扱われます。省略した場合、100を指定したものとして扱います。
- displayName では、ギフトを贈ったプレイヤーの表示名としてPlayerHandle.userDisplayNameに相当する値を指定します。空白文字を含む表示名は指定できません。省略した場合、コマンドを実行したプレイヤーの表示名が適用されます。
- userId では、ギフトを贈ったユーザーのIDとして、 /users で取得できる値を指定します。 /users に含まれない値を指定した場合、ゴーストまたはグループビューイングで参加しているプレイヤーがギフトを贈ったものとして扱われます。省略した場合、コマンドを実行したプレイヤーのIDが適用されます。
- giftType では、ギフトの種類を指定します。この値はGiftInfo.giftTypeに反映されます。実際のイベントで使用されるギフトの種類についてはギフト一覧を参照して下さい。省略した場合、空文字列が適用されます。
アイテムの作者のみが実行できるコマンド
/item state itemID
itemID で表されるアイテムのステートに設定されている一覧をコンソールに表示します。
/item state itemID key
itemID で表されるアイテムのステートに設定されている、keyで取得できる値をコンソールに表示します。
/item state itemID key type value
- itemID で表されるアイテムのステートに、プロパティ名がkeyで型がtypeの値valueを書き込みます。 typeには各Sendable型に対応する以下の文字列、およびnullのいずれかを指定できます
- number: 数値に対応します
- string: 文字列に対応します
- bool: booleanに対応します
- vec2: Vector2に対応します
- vec3: Vector3に対応します
- quaternion: Quaternionに対応します
- playerHandle: PlayerHandleに対応します
- itemHandle: ItemHandleに対応します
- array: 配列に対応します
- object: objectに対応します
