Language:

サイドバー

バーチャルキャスト公式Wiki

メニュー

配信

その他

リリース情報

デベロッパー向け


開発環境

VRM

VCI

GLB

vci:script:reference:exportshared

ExportShared

グローバル同期変数1) 。特定のアイテムに結び付かずに、部屋に変数を保存する機能です。


main.lua
if vci.assets.IsMine then -- 呼び出したユーザーが代表して初期化する
    vci.studio.shared.Set('switch', 0) 
end
 
function onUse(use)
    print('use')
    vci.studio.shared.Set('switch', 1)
end
 
function onUnuse(use)
    print('unuse')
    vci.studio.shared.Set('switch', 0)
end

Bind は updateAll と似ていますが、ちょっと違います。

main.lua
-- Bind。値が変更されたタイミングだけ呼ばれる
vci.studio.shared.Bind('switch', function(value)
    if value==1 then
        vci.assets.SetMaterialColorFromIndex(4, Color.__new(1, 0, 0, 1))
    else
        vci.assets.SetMaterialColorFromIndex(4, Color.__new(0.5, 0.5, 0.5, 1))
    end
end)
main.lua
-- Bind。値が変更されなくても毎フレーム呼ばれる
function updateAll() -- 所有権に関係なく全ユーザーに来る
    --print(vci.state.Get('switch'))
    if vci.studio.shared.Get('switch')==1 then
        vci.assets.SetMaterialColorFromIndex(4, Color.__new(1, 0, 0, 1))
    else
        vci.assets.SetMaterialColorFromIndex(4, Color.__new(0.5, 0.5, 0.5, 1))
    end
end

Set()

引数

  • name : string
  • value : number, string

Get()

引数

  • name : string

返り値

  • number, string

Bind()

引数

  • name : string
  • callback : 関数

概要

初期に updateAll が無かったために実装されました。

Add()

引数

  • name : string
  • value : usertype

概要

ExportState.Add項を参照してください。

グローバル同期変数の弱点と代替策

グローバル同期変数には実装上の弱点があります。

  • アイテム間での変数名重複を回避する手段が無い
  • 変数の持ち主が分からないのでクリアできない

vci.studio.shared.Get を vci.state + message で代替する例

グローバル同期変数の場合

main.lua
local value = vci.studio.shared.Get('valueName')

代替する場合

値をGetする方
main.lua
-- あらかじめ値を受け取る関数を用意して
message.On('response_valueName', function()
 
end)
-- 値を要求
message.Emit('request_valueName')
値をGetされる方
main.lua
-- 値が要求されたら
message.On('request_valueName', function() 
    -- アイテム内同期変数から値を得て投げ返す
    vci.Emit('respone_valueName', vci.state.Get('valueName'))
end)

ちょっと大変です。

1)
実装当初は「共有変数」と呼ばれておりましたが、命名が見直されて「グローバル同期変数」となりました。これは「アイテム内同期変数」と並ぶ「同期変数」の一つであることを明示するためです。
vci/script/reference/exportshared.txt · 最終更新: 2021/11/17 21:12 by numa

ページ用ツール