vci:script:reference
差分
この文書の現在のバージョンと選択したバージョンの差分を表示します。
| 両方とも前のリビジョン 前のリビジョン 次のリビジョン | 前のリビジョン | ||
|
vci:script:reference [2020/11/04 15:07] t-daihisa [コラム等] |
vci:script:reference [2023/11/30 20:01] pastatto Lua 5.2 リファレンスマニュアルのページをWikiページに差し替え |
||
|---|---|---|---|
| ライン 3: | ライン 3: | ||
| VCIスクリプトに関する下記項目についてのまとめになります。 | VCIスクリプトに関する下記項目についてのまとめになります。 | ||
| - | * イベント関数 | + | * **イベント関数** |
| - | * VCI独自のクラス | + | * **VCIのクラス** |
| - | * VCI作成にあたってのコラム | + | * **VCI作成にあたってのコラム** |
| - | ---- | + | <WRAP center round important 80%> |
| + | このページは過去の情報となります。\\ | ||
| + | 新しいスクリプトリファレンスは**[[https://developer.virtualcast.jp/vci-docs/api/|こちら]]**になります。 | ||
| + | </WRAP> | ||
| + | |||
| + | |||
| + | |||
| + | <WRAP group> | ||
| + | <WRAP half column> | ||
| ==== Luaドキュメント ==== | ==== Luaドキュメント ==== | ||
| - | * [[http://milkpot.sakura.ne.jp/lua/lua52_manual_ja.html|Lua 5.2 リファレンスマニュアル]] | + | * [[vci/script/luareference|Lua 5.2 リファレンスマニュアル]] |
| + | |||
| + | </WRAP> | ||
| + | |||
| + | |||
| + | <WRAP half column> | ||
| ==== VCIスクリプト(Lua)の機能 ==== | ==== VCIスクリプト(Lua)の機能 ==== | ||
| * [[vci:script:module| module機能]] | * [[vci:script:module| module機能]] | ||
| - | ==== イベント関数 ==== | ||
| - | * [[vci:script:reference:eventfunction | イベント関数]] | + | </WRAP> |
| - | * [[vci:script:reference:eventfunction:tips1 | イベント関数呼び出しの条件とタイミングについて]] | + | </WRAP> |
| + | |||
| + | |||
| + | |||
| + | ===== イベント関数 ===== | ||
| + | **update**のような繰り返される関数や、\\ | ||
| + | **onUse**や**onTriggerEnter**のような特定条件で発動する関数があります。 | ||
| + | |||
| + | * **[[vci:script:reference:eventfunction | イベント関数]]** | ||
| * [[vci:script:reference:eventfunction:ownership| 所有権とイベント関数の関係]] | * [[vci:script:reference:eventfunction:ownership| 所有権とイベント関数の関係]] | ||
| - | ==== Transform ==== | ||
| - | * [[vci:script:reference:exporttransform | ExportTransform]] | + | <WRAP center round help 80%> |
| - | * [[vci:script:reference:vector3 | Vector3]] | + | 現在のバーチャルキャストでは使用不可能な関数があります。\\ |
| - | * [[vci:script:reference:quaternion | Quaternion]] | + | [[https://blog.virtualcast.jp/blog/2021/08/208a_vci_changes/|バーチャルキャスト ver 2.0.8a でのVCIに関する変更について]] |
| + | </WRAP> | ||
| - | ==== Utility ==== | ||
| - | * [[vci:script:reference:color | Color(色の指定)]] | + | ===== VCIのクラス ===== |
| - | ==== VCIのクラス ==== | + | ^ ［Transform］ ^ クラス ^ 説明 ^ |
| + | | vci.assets | **[[ vci/script/reference/exporttransform | ExportTransform ]]** | SubitemのTransform等に干渉 | | ||
| + | | ::: | **[[ | ||
| + | vci/script/reference/attachable | ExportTransform Attachable ]]** |装着アイテムに干渉 | | ||
| + | | vci.forceMode | **[[ vci/script/reference/forcemode | ExportForceMode ]]** | AddForceで力を掛ける方法を指定 | | ||
| + | | vci.ResetRootTransform | **[[vci:script:reference:resetroottransform|ResetRootTransform ]]** | VCIの全体のTransformをリセット | | ||
| + | | Vector3 | **[[vci:script:reference:vector3 | Vector3]]** | X,Y,Zの3つの値を持ったクラス | | ||
| + | | Quaternion | **[[vci:script:reference:quaternion | Quaternion]]** | X,Y,Z,Wの4つの値を持ったクラス | | ||
| + | ^ ［Coroutine］ ^ クラス ^ 説明 ^ | ||
| + | | vci.StartCoroutine | **[[vci:script:reference:startcoroutine|StartCoroutine ]]** | コルーチンを開始 | | ||
| + | ^ ［Color］ ^ クラス ^ 説明 ^ | ||
| + | | Color | **[[vci:script:reference:color | Color]]** | 色の指定 | | ||
| + | ^ ［全般］ ^ クラス ^ 説明 ^ | ||
| + | | vci.assets | **[[ vci/script/reference/exportassets | ExportAssets ]]** | Text等のコンポーネントを扱う\\ <wrap lo>※一部の関数は非推奨</wrap> | | ||
| + | | ::: | **[[ vci/script/reference/exportanimation | ExportAnimation ]]** | Animationを再生 | | ||
| + | | ::: | **[[ vci/script/reference/effekseer | ExportEffekseer ]]** | エフェクトを再生 | | ||
| + | | vci.assets.audio | **[[ vci/script/reference/exportassets/audio | ExportAudio ]]** | Audioを再生 | | ||
| + | | vci.assets.material | **[[ vci/script/reference/exportassets/material | ExportMaterial ]]** | Materialを制御 | | ||
| + | | vci.assets | **[[ vci/script/reference/exportaudiosource | ExportAudioSource ]]** | AudioSourceを制御 | | ||
| + | | vci.studio | **[[ vci/script/reference/exportstudio | ExportStudio ]]** | スタジオ内の情報を取得 | | ||
| + | | ::: | **[[ vci/script/reference/exportavatar | ExportAvatar ]]** | アバター情報を取得 | | ||
| + | | ::: | **[[ vci/script/reference/exportshared | ExportShared ]]** | 部屋に紐づく同期変数 | | ||
| + | | vci.state | **[[ vci/script/reference/exportstate | ExportState ]]** | 特定のアイテムに紐づく同期変数 | | ||
| + | | vci.me | **[[ vci/script/reference/exportme | ExportMe ]]** | ユーザーのローカル情報を取得 | | ||
| + | | ::: | **[[ vci/script/reference/vciinput | ExportMe GetXXInput ]]** | キーボードの入力を受け取る | | ||
| + | | vci.message | **[[ vci/script/reference/message | ExportMessage ]]** | Messageを飛ばしてVCI間で通信 | | ||
| + | | vci.cameraSystem | **[[ vci/script/reference/exportphotographycamera | ExportPhotographyCamera ]]** | 写真撮影用カメラを作成 | | ||
| + | | vci.vc.room | **[[ vci/script/reference/exportvc | ExportVc/ExportRoom ]]** | ルーム情報を取得 | | ||
| + | | ::: | **[[ vci/script/reference/exportroomplayer | ExportRoomPlayer/Controller ]]** | プレイヤー情報を取得、物理演算の制御 | | ||
| + | | ::: | **[[ vci/script/reference/exportcharacter | ExportCharacter ]]** | キャラクターモデル情報を取得 | | ||
| + | | ::: | **[[ vci/script/reference/exportmonitorcamera | ExportMonitorCamera ]]** | モニターカメラの情報を取得 | | ||
| + | |vci.osc|**[[vci:script:reference:exportosc|ExportOsc]]**|外部との OSC 通信 | | ||
| - | * [[vci:script:reference:exportvci | vci(ExportVci)]] | + | クラスと関数の一覧は、 |
| - | * [[vci:script:reference:exportme | me(ExportMe)(ローカルマシンの情報)]] | + | <code>C:/Users/_USER_/AppData/LocalLow/VirtualCast/VirtualCast</code> |
| - | * [[vci:script:reference:exportstudio | studio (ExportSystemItem) (VirtualCastのアイテム)]] | + | 内の **[EmbeddedScriptWorkspace > types.lua]** を開くと確認できます。 |
| - | * [[vci:script:reference:exportassets | assets (ExportAssets) (VCIに格納されたアセット)]] | + | |
| - | * [[vci:script:reference:exportavatar | avatar(ExportAvatar) (アバター情報)]] | + | |
| - | * [[vci:script:reference:ExportAnimation | animation(ExportAnimation) (アニメーション)]] | + | |
| - | * [[vci:script:reference:exportassets:audio | assets.audio (ExportAudio) (オーディオ制御)]] | + | |
| - | * [[vci:script:reference:exportassets:material | assets.material (ExportMaterial) (マテリアル制御)]] | + | |
| - | * [[vci:script:reference:message | message(VCI間のメッセージシステム)]] | + | |
| - | * [[vci:script:reference:messagecomment | message(コメントの受信)]] | + | |
| - | * [[vci:script:reference:messagenotification | message(通知の受信)]] | + | |
| - | * [[vci:script:reference:exportstate | state(ExportState)(アイテムの状態)]] | + | |
| - | * [[vci:script:reference:exportshared | studio.shared (ExportShared)(共有変数)]] | + | |
| - | * [[vci:script:reference:vciInput | me.Input() (キー入力の受付)]] | + | |
| - | * [[vci:script:reference:effekseer | Effekseer (エフェクト)]] | + | |
| - | ==== リファレンス(自動出力) ==== | ||
| + | --> リファレンス(自動出力) (クリックで展開) # | ||
| * [[vci:script:reference:callbacks| callbacks]] | * [[vci:script:reference:callbacks| callbacks]] | ||
| - | * [[vci:script:reference:vcimodule| vci_module]] | ||
| * [[vci:script:reference:cstypes# types| c# types]] | * [[vci:script:reference:cstypes# types| c# types]] | ||
| + | {{ vci:script:reference:vcireferencedoc.zip |}} ※Windowsヘルプ形式(chm)\\ | ||
| + | 使えるライブラリ一覧 version 0.3.0(2019/05/15) | ||
| + | <-- | ||
| - | ==== コラム等 ==== | + | ===== コラム ===== |
| * [[vci:script:tips:stringsearch | string型の検索方法まとめ]] | * [[vci:script:tips:stringsearch | string型の検索方法まとめ]] | ||
| * [[vci:script:tips:hsv2rgb | LuaでHSVtoRGBを書く]] | * [[vci:script:tips:hsv2rgb | LuaでHSVtoRGBを書く]] | ||
| - | * [[vci:script:tips:animation| アニメーションクリップを使用する際の注意]] | + | * [[vci:tips:animation| アニメーションクリップを使用する際の注意]] |
| - | * [[vci:sdk:subitem:owned | SubItemの所有権と同期処理の関係]] | + | * [[vci/script/document/getname]] |
| - | * [[vci:data:sharedmesh | メッシュの共通化]] | + | * [[vci/script/reference/syncvariable]] |
| + | * [[vci:component:sdk:subitem:owned| SubItemの所有権と同期処理の関係]] | ||
| + | * [[vci:script:reference:sharedmesh| メッシュの共通化]] | ||
| - | ==== VCIスクリプトリファレンスの名前空間 ==== | ||
| - | * [[vci:script:reference:namespace | VCIスクリプトリファレンスの名前空間]] | ||
| - | * [[vci:script:reference:tmp | リファレンスページのテンプレート]] | ||
vci/script/reference.txt · 最終更新: 2023/11/30 20:01 by pastatto