~~NOTOC~~
====== ExportVc/ExportRoom(ルーム情報) ======
<WRAP center round important 80%>

このページは過去の情報となります。\\
新しいスクリプトリファレンスは**[[https://developer.virtualcast.jp/vci-docs/api/|こちら]]**になります。
</WRAP>
ルーム情報を取得するのに必要なクラスです。

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


===== メンバ変数・関数一覧 =====

^ ExportVc ^^
^ 名前 ^ 説明 ^
| [[vci/script/reference/exportvc#room ]] | ExportRoomを取得 |
| [[vci/script/reference/exportvc#GetSpaceType ]] | VCIが出された空間の種別( ''Studio'', ''Room'' )を取得 |
| [[vci/script/reference/exportvc#spaceTypes ]] | 空間種別の静的な列挙子のテーブル|
^ ExportRoom ^^
^ 名前 ^ 説明 ^
| [[vci/script/reference/exportvc#GetGravity ]] | ルームの重力加速度ベクトルを取得 |
| [[vci/script/reference/exportvc#GetWalkSpeed ]] | ルームの移動速度を取得 |
| [[vci/script/reference/exportvc#GetJumpSpeed ]] | ルームのジャンプ力の初速度を取得 |
| [[vci/script/reference/exportvc#GetRoomKey ]] | ルームキーを取得 |
| [[vci/script/reference/exportvc#GetAllPlayers ]] | ルームに参加中のすべてのプレイヤーを取得 |
| [[vci/script/reference/exportvc#GetLocalPlayer ]] | ローカルのプレイヤーを取得 |
| [[vci/script/reference/exportvc#GetPlayerById ]] | IDを指定してルームに参加中のプレイヤーを取得 |
| [[vci/script/reference/exportvc#OnPlayerJoined ]] | ルームにプレイヤーが参加した時に呼ばれるコールバックを登録 |
| [[vci/script/reference/exportvc#OnPlayerLeft ]] | ルームからプレイヤーが去った時に呼ばれるコールバックを登録 |


===== room =====
<wrap em>ExportVc.</wrap>**room ExportRoom**\\
ExportRoomを取得する。

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

===== GetSpaceType =====
<wrap em>ExportVc.</wrap>**GetSpaceType() fun(): ExportVcSpaceType**\\
VCIが出された空間の種別( ''Studio'', ''Room'' )を取得する。

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


===== spaceTypes =====
<wrap em>ExportVc.</wrap>**spaceTypes ExportVcSpaceType**\\
空間種別の静的な列挙子のテーブル。

=== サンプル ===

<file lua 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

</file>


===== GetGravity =====
<wrap em>ExportRoom.</wrap>**GetGravity fun(): Vector3**\\
ルームの重力加速度ベクトル [m/s<sup>2</sup>] を取得する。

=== サンプル ===

<file lua main.lua>
print("Gravity: "..tostring(vci.vc.room.GetGravity()))

</file>


===== GetWalkSpeed =====
<wrap em>ExportRoom.</wrap>**GetWalkSpeed fun(): number**\\
ルームの移動速度 [m/s] を取得する。

=== サンプル ===

<file lua main.lua>
print("WalkSpeed: "..vci.vc.room.GetWalkSpeed())

</file>



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

=== サンプル ===

<file lua main.lua>
print("JumpSpeed: "..vci.vc.room.GetJumpSpeed())

</file>



===== GetRoomKey =====
<wrap em>ExportRoom.</wrap>**GetRoomKey fun(): string**\\
ルームキーを取得する。

=== サンプル ===

<file lua main.lua>
print("RoomKey: "..vci.vc.room.GetRoomKey())

</file>



===== GetAllPlayers =====
<wrap em>ExportRoom.</wrap>**GetAllPlayers fun(): [[https://developer.virtualcast.jp/vci-docs/api/classes/ExportRoomPlayer/index.html|ExportRoomPlayer]][]**\\
ルームに参加中のすべてのプレイヤーを取得する。\\
<wrap em>※取得した配列内の ExportRoomPlayer の順番は、各プレイヤーの環境上で異なります。</wrap>

=== サンプル ===

<file lua 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))

</file>



===== GetLocalPlayer =====
<wrap em>ExportRoom.</wrap>**GetLocalPlayer fun(): [[https://developer.virtualcast.jp/vci-docs/api/classes/ExportRoomPlayer/index.html|ExportRoomPlayer]]**\\
ローカルのプレイヤーを取得する。

=== サンプル ===

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

</file>



===== GetPlayerById =====
<wrap em>ExportRoom.</wrap>**GetPlayerById fun(playerId: string): [[https://developer.virtualcast.jp/vci-docs/api/classes/ExportRoomPlayer/index.html|ExportRoomPlayer]]**\\
IDを指定してルームに参加中のプレイヤーを取得する。

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


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

=== 引数 ===

''callback:'' : ''fun(joinEvent: table{"PlayerId": string})''

=== サンプル ===

<file lua 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
)

</file>

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

=== 引数 ===

''callback:'' : ''fun(joinEvent: table{"PlayerId": string})''


=== サンプル ===

<file lua 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
)

</file>