入退室通知#
スタジオの入退室情報をVCIスクリプトで受信する事ができます。
入退室通知の受信方法#
入退室通知の受信には ExportMessage.On()
を使用します。
本来はメッセージを受信するために存在する関数ですが、スタジオでは messageName
引数に予約済みの値 "notification"
を渡すことで、誰かがスタジオに入退室するたびにコールバック関数が実行されます。
コールバック関数の引数#
引数名 |
型 |
説明 |
---|---|---|
sender |
|
入退室者の情報 |
name |
|
(入退室通知の場合は |
message |
|
入室( |
とくに sender
オブジェクトは次の内容を含みます。
引数名 |
型 |
説明 |
---|---|---|
name |
|
ユーザー名 |
type |
|
(入退室通知の場合は |
スクリプト#
入退室通知をコンソールに表示する例です。
function onMessage(sender, name, message)
if message == 'joined' then
print(sender.name..'さんが入室しました。')
elseif message == 'left' then
print(sender.name..'さんが退室しました。')
end
end
vci.message.On('notification', onMessage)
参考
サンプルVCIはこちら。
通知表示板 [VirtualCast]
ヒント
ルームで入退室情報を取得したい場合は、ExportRoom.OnPlayerJoined()
、ExportRoom.OnPlayerLeft()
を使用します。