GetInstanceId#

ExportAssets.GetInstanceId()#

ExportMessage.EmitWithId() の引数に与えるIDを取得します。

Returns:

VCI インスタンスの ID

Return type:

string

説明#

ExportMessage.EmitWithId() の引数以外の用途でこの API の返り値を利用することは推奨されません。

IDはVCIのインスタンスそれぞれに割り当てられます。
したがって同じVCIを複数出した場合はIDが異なります。
またVCIを出しなおした場合もIDが異なります。

IDはスタジオやルームのセッションの中でのユニークさが保証されます。
したがってルームの入室人数が0人になったのち再度入室した場合はIDが変わることがあります。

Example#

function onUse(objectName)
    -- 自分自身の VCI インスタンスに対してメッセージを送信
    vci.message.EmitWithId("color", 3, vci.assets.GetInstanceId())
end