ルーム情報を取得するのに必要なクラスです。

• UniVCI v0.35 以降で Export される VCI で使用できます。
• バーチャルキャスト v2.3.0 以降で動作します。
• 現在、この API はルーム上でのみ動作します。

ExportVc.room ExportRoom
ExportRoomを取得する。

※次項のサンプルを参照のこと。

ExportVc.GetSpaceType() fun(): ExportVcSpaceType
VCIが出された空間の種別( Studio, Room )を取得する。

※次項のサンプルを参照のこと。

ExportVc.spaceTypes ExportVcSpaceType
空間種別の静的な列挙子のテーブル。

main.lua

local spaceType = vci.vc.GetSpaceType()
print(spaceType == vci.vc.spaceTypes.room) -- Room: true, Studio: false
print(spaceType == vci.vc.spaceTypes.studio) -- Room: false, Studio: true
print(spaceType == vci.vc.spaceTypes.unknown) -- Room: false, Studio: false

ExportRoom.GetGravity fun(): Vector3
ルームの重力加速度ベクトル [m/s²] を取得する。

main.lua

print("Gravity: "..tostring(vci.vc.room.GetGravity()))

ExportRoom.GetWalkSpeed fun(): number
ルームの移動速度 [m/s] を取得する。

main.lua

print("WalkSpeed: "..vci.vc.room.GetWalkSpeed())

ExportRoom.GetJumpSpeed fun(): number
ルームのジャンプ力の初速度 [m/s] を取得する。

main.lua

print("JumpSpeed: "..vci.vc.room.GetJumpSpeed())

ExportRoom.GetRoomKey fun(): string
ルームキーを取得する。

main.lua

print("RoomKey: "..vci.vc.room.GetRoomKey())

ExportRoom.GetAllPlayers fun(): ExportRoomPlayer[]
ルームに参加中のすべてのプレイヤーを取得する。
※取得した配列内の ExportRoomPlayer の順番は、各プレイヤーの環境上で異なります。

main.lua

-- プレイヤー情報の取得
local players = vci.vc.room.GetAllPlayers()
local currentPlayersString = "Current Players: "
local idToNameMap = {}
for k, v in pairs(players) do
    local name = v.GetName()
    idToNameMap[v.GetId()] = name
    currentPlayersString = currentPlayersString..name..", "
end
print(string.sub(currentPlayersString, 1, -3))

ExportRoom.GetLocalPlayer fun(): ExportRoomPlayer
ローカルのプレイヤーを取得する。

main.lua

-- ローカルプレイヤーの取得
local localPlayer = vci.vc.room.GetLocalPlayer()
print("local player: "..localPlayer.GetName())

ExportRoom.GetPlayerById fun(playerId: string): ExportRoomPlayer
IDを指定してルームに参加中のプレイヤーを取得する。

※次項のサンプルを参照のこと。

ExportRoom.OnPlayerJoined fun(callback: usertype)
ルームにプレイヤーが参加した時に呼ばれるコールバックを登録する。

callback: : fun(joinEvent: table{“PlayerId”: string})

main.lua

-- 入室時コールバックの登録
vci.vc.room.OnPlayerJoined(
    function (joinEvent)  -- {"PlayerId": string}
        local id = joinEvent["PlayerId"]
        local name = vci.vc.room.GetPlayerById(id).GetName()
        if name ~= nil then print(name.." joined.") end
        idToNameMap[id] = name
    end
)

ExportRoom.OnPlayerLeft fun(callback: usertype)
ルームからプレイヤーが去った時に呼ばれるコールバックを登録する。

callback: : fun(joinEvent: table{“PlayerId”: string})

main.lua

-- 退出時コールバックの登録
vci.vc.room.OnPlayerLeft(
    function (leftEvent)  -- {"PlayerId": string}        
        local id = leftEvent["PlayerId"]
        local name = idToNameMap[id]
        if name ~= nil then print(name.." has left.") end
        idToNameMap[id] = nil
    end
)