バーチャルキャスト公式Wiki
メニュー
Steam版
デバイス
アセット
配信
その他
リリース情報
- wiki編集者用ページ
-
vci:script:reference
VCIスクリプトリファレンス
VCIスクリプトに関する下記項目についてのまとめになります。
- イベント関数
- VCIのクラス
- VCI作成にあたってのコラム
このページは過去の情報となります。
新しいスクリプトリファレンスはこちらになります。
Luaドキュメント
VCIスクリプト(Lua)の機能
イベント関数
updateのような繰り返される関数や、
onUseやonTriggerEnterのような特定条件で発動する関数があります。
現在のバーチャルキャストでは使用不可能な関数があります。
バーチャルキャスト ver 2.0.8a でのVCIに関する変更について
VCIのクラス
| ［Transform］ | クラス | 説明 |
|---|---|---|
| vci.assets | ExportTransform | SubitemのTransform等に干渉 |
| ExportTransform Attachable | 装着アイテムに干渉 | |
| vci.forceMode | ExportForceMode | AddForceで力を掛ける方法を指定 |
| vci.ResetRootTransform | ResetRootTransform | VCIの全体のTransformをリセット |
| Vector3 | Vector3 | X,Y,Zの3つの値を持ったクラス |
| Quaternion | Quaternion | X,Y,Z,Wの4つの値を持ったクラス |
| ［Coroutine］ | クラス | 説明 |
| vci.StartCoroutine | StartCoroutine | コルーチンを開始 |
| ［Color］ | クラス | 説明 |
| Color | Color | 色の指定 |
| ［全般］ | クラス | 説明 |
| vci.assets | ExportAssets | Text等のコンポーネントを扱う ※一部の関数は非推奨 |
| ExportAnimation | Animationを再生 | |
| ExportEffekseer | エフェクトを再生 | |
| vci.assets.audio | ExportAudio | Audioを再生 |
| vci.assets.material | ExportMaterial | Materialを制御 |
| vci.assets | ExportAudioSource | AudioSourceを制御 |
| vci.studio | ExportStudio | スタジオ内の情報を取得 |
| ExportAvatar | アバター情報を取得 | |
| ExportShared | 部屋に紐づく同期変数 | |
| vci.state | ExportState | 特定のアイテムに紐づく同期変数 |
| vci.me | ExportMe | ユーザーのローカル情報を取得 |
| ExportMe GetXXInput | キーボードの入力を受け取る | |
| vci.message | ExportMessage | Messageを飛ばしてVCI間で通信 |
| vci.cameraSystem | ExportPhotographyCamera | 写真撮影用カメラを作成 |
| vci.vc.room | ExportVc/ExportRoom | ルーム情報を取得 |
| ExportRoomPlayer/Controller | プレイヤー情報を取得、物理演算の制御 | |
| ExportCharacter | キャラクターモデル情報を取得 | |
| ExportMonitorCamera | モニターカメラの情報を取得 | |
| vci.osc | ExportOsc | 外部との OSC 通信 |
クラスと関数の一覧は、
C:/Users/_USER_/AppData/LocalLow/VirtualCast/VirtualCast
内の [EmbeddedScriptWorkspace > types.lua] を開くと確認できます。
- リファレンス(自動出力) (クリックで展開)
-
vcireferencedoc.zip ※Windowsヘルプ形式(chm)
使えるライブラリ一覧 version 0.3.0(2019/05/15)
コラム
vci/script/reference.txt · 最終更新: 2024/08/19 14:39 by pastatto