【VRchat向け】アイテム出現メニューギミック「BBWand」

本アセットはVRChat SDK3ワールド向けのUdonギミックです。

メニュー(後述)に入れておいたアイテムを「杖」オブジェクトで指定した位置に出現させることができます。

■更新履歴

2021/08/19 リリース

■ギミック内容

導入するBBWandPrefab.prefab内には下記が存在します。

・BBStock

出現させるオブジェクト(アイテム)をメニュー別に管理します。下記【BBStockの設定】にてメニュー・アイテムを追加できます。

・BBWand/BBWand

出現させるための「杖」オブジェクトを扱います。下記【BBWandの設定】にて一部設定を変更できます。

・BBWand/iconCube

出現時のメニューアイコン用Cubeです。特に変更する必要はありません。

・BBWand/iconGUI

アイコン・アイテムを選択した時のメニュー名・ストック数を表示するためのGUIです。特に変更する必要はありません。

・ResetObject

このオブジェクトに杖先が触れた状態でUseすると出したアイテムをすべて収納します。

また、色々なアイテム用途のサポートのために下記UdonSharpスクリプトを用意しています。(BBWandを利用するのに必須ではありません)

具体的な使用例はAsset/Bellbell/BBWand/Sample下のBBWand_Sample.prefabにサンプルを用意していますのでお試しください。

・ManualSyncTransform

出現初回のみ位置同期をします。Pickup等で動かすことはなくワールド固定したいアイテムに有効です。

また、First GravityオプションをTrueにすると、出現初回時のみ重力落下し、位置が安定すると固定するようになります。家具など地面に接するようにしたいアイテムに有効です。

同期方式はManualSyncを指定してください。ManualSyncのため同一オブジェクトでのVRC_ObjectSyncと併用はできません。

・MemoryInitialTransform

子階層のGameObjectの初期位置を記憶し、再度Activeになった時に、子階層のGameObjectを初期位置に戻します。

アイテム内に複数モデルが入っており、それぞれをPickupや物理演算で独立して動かすような場合に有効です。

■導入手順

[1] VRChatのSDKおよびUdonSharp(U#)を事前にUnityプロジェクトに導入してください

下記バージョンにて動作を確認しておりますが、通常は最新のSDKおよびU#を利用してください。

・VRCSDK3-WORLD-2021.08.04.15.07_Public

・UdonSharp_v0.20.2

[2] 同梱のBBWand.unitypackageをUnityプロジェクトにImportします

[3] Asset/Bellbell/BBWand下のBBWandPrefab.prefabをSceneに配置します

[4] シーンのBBWandPrefabを「Unpack Prefab」で展開しBBWandPrefab下の「BBStock」をHierarchyのScene直下に配置します。

※直下以外に配置した場合、収納機能が利用できなくなります。

■BBStockの設定

メニュー・アイテムをBBStockに追加することで出現させるアイテムを管理します。

追加手順:

[1] BBStock下に空のGameObjectを追加します。BBStock直下のGameObjectが「メニュー」となります。

※仕様上一つのBBStockに36個のメニューを登録可能です。

[2] GameObjectの名前を表示したいメニュー名に変更します。

[3] メニュー直下にメニュー選択時に出現させたいオブジェクト(アイテム)を入れます。

※仕様上一つのBBStockに全メニュー合計で最大800個まで入れることができます。(表示負荷はVRChatの挙動に依存するため入れすぎることは非推奨です)

※自身をInstantiateやDestroyしたり、BBWandの操作以外で非Activeになるようなアイテムを入れた場合、挙動がおかしくなる可能性があります。

[4] アイテムにVRC_ObjectSync等の同期設定を追加しましたら、アイテムを非Activeにします。

[5] 出したい最大個数分、同メニュー下にアイテムを複製します。

■BBWandの設定

BBWandPrefab下のBBWandを選択するとInspectorウィンドウのUdon Behaviourから設定変更ができます。

基本的に変更は不要ですが、例えば下記項目などを用途により変更してください。

・アイテム出現の効果音/アイテム収納の効果音

AudioClipを指定するとアイテムを出現させる際収納する際に効果音を出すようになります(同期します)。デフォルトは音なしです。

・ランダム出現の有効化

一メニュー内に複数種類のアイテムが入っている場合、ランダムに選択するようになります。

■VRChat上での使い方

[1] アイテムの出現

Pickup後、Useするとメニューアイコンが前方に表示されます。

(何もない箇所でもう一度Useするとメニューが閉じます)

アイコンに杖先で触れると選択状態になります。

Useを押したまま出したい場所に杖先を持っていきます。

離すとアイテムが出現します。

ストックが切れるとアイコンが選択できなくなります。

[2] アイテムの収納

出したアイテムに杖先で触れると収納選択状態になります。

収納選択状態でUseを押すとアイテムを仕舞います。

[3] リセット

ResetObjectに杖先で触れた状態でUseを押すと、出現させていたアイテムをすべて収納します。

■ライセンス

MITライセンスです。

Copyright (c) 2021 べるべる

This software is released under the MIT license

http://opensource.org/licenses/mit-license.php

■連絡先

Booth - https://bellbelllab.booth.pm/

Twitter - https://twitter.com/foxFizzingcandy