On#

ExportMessage.On(messageName, callback)#

指定した名前の「メッセージ」を受信したときに呼び出すコールバック関数を登録します。

Parameters:

  • messageName (string) -- 受信対象として登録するメッセージの名前

  • callback (function) -- メッセージを受信したときに呼び出されるコールバック関数

説明#

コールバック関数の引数には次の値が渡されます。

引数名

型

説明

sender

table

送信元 VCI インスタンスの情報

name

string

受信したメッセージの名前

message

nil|boolean|number|string|table

受信したメッセージの値

とくに sender オブジェクトは次の内容を含みます。

プロパティ名

型

説明

type

string

vci という文字列

name

string

送信元 VCI インスタンスの名前

Example#

function OnReceiveMessage(sender, name, message)
    print(sender.type)        ---> "vci"
    print(sender.name)        ---> "My Score Attack VCI"
    print(name)               ---> "register_score"
    print(message.challenger) ---> "Aさん"
    print(message.score)      ---> 123456
end

--- "register_score" という名前のメッセージを受信したら OnReceiveMessage を呼び出す
vci.message.On("register_score", OnReceiveMessage)

vci.message.Emit("register_score", {
    challenger = "Aさん",
    score = 123456,
})

ヒント

スタジオではこの関数を使ってプレイヤーの入退出情報やスタジオの生放送コメントを受信することができます。