Itemの種類一覧 / HeliScript関数対応表
概要
Vket Cloud上でワールドを構成する際、Player以外の各要素はItemとして表現されます。
HeliScriptにてこれを扱うためのItemクラスには様々なメソッドが用意されていますが、Itemのtype(種類)によって使用できるかどうかが異なります。
ここではその一覧と対応するHeliScript関数を表としてまとめます。
Itemのtype
Vket Cloudでは、一口にItemと言っても様々なtypeが存在します。
各Itemはそれぞれ該当するHEOコンポーネントをUnity上でオブジェクトに割り当てて表現されます。HeliScriptから思った動作ができない場合は、各オブジェクトに紐づいているItemの種類をご確認ください。
また、Unityシーン内のゲームオブジェクトがSDKによって設定される条件に合致する場合は、シーン直下や空のオブジェクト以下にあっても出力されます。(HEO Field以下でも別Itemとして出力されます。)
下表に各typeの説明を示します。ギミック実装時に思っていたtypeじゃなくて困るということが減るように、SDKによって設定される条件も記します。
| Itemのtype / 該当のHEOComponent | typeの説明 |
|---|---|
| field / HEOField | 基本的なワールドオブジェクトで使用するItem ・ビルド時にHEOField以下のオブジェクトをまとめて一つのHEOファイルとして出力できる。 ・HEOField以下のゲームオブジェクトはノードという概念となるが、孫の概念はない。 ・ノード操作系やMaterial操作系機能を使用可能 ・HEOFieldが入れ子構造になると、下層のFieldもItemとして出力されるが、下層以下のノードは親のノードとして出力されたりするので避けること。 ・ノードの指定は名前なので、名前の重複は避けること |
| object / HEOObject | 移動させたりすることがあるオブジェクトに使用するItem ・glTF/VRM/HRMを配置するのに使用 ・移動系の機能が使用可能 ・HEMアニメーションが使用可能 |
| plane / HEOPlane | テクスチャをそのまま表示できるItem ・日本語向けと英語向けとで2種類の画像を設定可能 ・billboardや両面描写にも対応 |
| textplane / HEOTextPlane | 任意の文字列を描画することができるItem ・文字の書き換えが必要なときに使用 ・TextPlane系の機能が使用可能 |
| bgm/se / HEOAudio | BGMや効果音を再生することができるItem ・Play/Stop/IsPlayが使用可能 ・2種類のtypeは機能としてはどれも同じで、音量設定のどの項目に対応するかが変わる |
| particle / HEOParticle | パーティクルを再生することができるItem ・Play/Stop/IsPlayが使用可能 |
| spot / HEOSpot | URLで直接任意の場所の前から開始出来るようにするための位置指定に使用するItem ・Spot0から連番で好きな位置に配置してURLに&spaceindex=1等のパラメーターを追記することで選んだ位置から開始できる。 |
| areacollider / HEOAreacollider | 「侵入するとギミックを発火する」という機能のためのItem Unity上ではFieldの子に配置されるのが正しい ・コライダーに入るときと出るときとでそれぞれActionを設定できる |
| bgtexture / HEOBackgroundTexture | シーンの背景に画像を配置するために使用するItem ・必ず一番はじめに描画される ・使用する画像の比率は『1 : 1』である必要がある |
| activity / HEOActivity | アクティビティ配置のためのItem ・JSONファイルの紐づけによって、ギミックをそのまま配置することが可能 |
| camera / HEOCamera | 演出目的等で通常のカメラから切り替えるためのItem ・HeliScriptから切り替えることで任意のCameraに切り替えることができる※SDK5.0以降使用可能 |
Itemの種類とItemクラスの関数の使用可否対応表
| field | object | plane | textplane | bgm / se | particle | spot | areacollider | bgtexture | activity | camera | |
|---|---|---|---|---|---|---|---|---|---|---|---|
| Equals | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| GetName | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| SetPos | ○ | ||||||||||
| GetPos | ○ | ||||||||||
| GetWorldPos | ○ | ||||||||||
| SetQuaternion | ○ | ||||||||||
| GetQuaternion | ○ | ||||||||||
| GetWorldQuaternion | ○ | ||||||||||
| GetWorldRotate | ○ | ||||||||||
| GetScale | ○ | ||||||||||
| SetScale | ○ | ||||||||||
| MovePos | ○ | ||||||||||
| IsMoving | ○ | ||||||||||
| Play | ○ | ○ | ○ | ||||||||
| Stop | ○ | ○ | |||||||||
| IsPlay | ○ | ○ | ○ | ||||||||
| SetShow | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| IsShow | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| ChangeMotion | ○ | ||||||||||
| Load | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| Unload | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| IsLoading | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| IsLoaded | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| GetNodeIndexByName | ○ | ||||||||||
| GetNodeNameByIndex | ○ | ||||||||||
| GetNodePosByIndex | ○ | ||||||||||
| SetShowNode | ○ | ○ | |||||||||
| IsShowNode | ○ | ○ | |||||||||
| SetRotateNode | ○ | ||||||||||
| SetEnableCollider | ○ | ○ | |||||||||
| IsEnableCollider | ○ | ○ | |||||||||
| SetClickableNode | ○ | ||||||||||
| IsClickableNode | ○ | ||||||||||
| SetUVOffset | ○ | ○ *SDK Ver9.x系以降 | |||||||||
| PlayVideo | ○ | ||||||||||
| StopVideo | ○ | ||||||||||
| IsPlayVideo | ○ | ||||||||||
| ClearTextPlane | ○ | ||||||||||
| WriteTextPlane | ○ | ||||||||||
| SetCamera | ○ | ||||||||||
| ResetCamera | ○ | ||||||||||
| ReplaceItem | ○ | ○ | ○ | ||||||||
| ReplaceTexture | ○ | ○ | ○ | ○ | |||||||
| SetPhysicsEnable | ○ | ||||||||||
| IsPhysicsFixed | ○ | ||||||||||
| SetProperty | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| GetProperty | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| CallComponentMethod | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| SetOverridesProperty | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| GetOverridesProperty | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
各メソッドの説明は以下のページを参照して下さい。