あなたの世界を作りなさい
マルチプレイ

Multiplay Room Message

8min

Multiplay Room Message

Document image


ZEPETO Multiplayは、クライアントとサーバー(Room)間のメッセージ送受信のためのインタフェースを提供します。 サーバーは、個々のクライアントにメッセージを送ったり、全体クライアントにメッセージを送ることができます。

メッセージタイプはPrimitive、Schema、(Custom)Objectタイプをサポートします。

Server API

Server APIは次のMethodを提供しています。

API

説明

onMessage(Type, Callback)

ZEPETOマルチプレイサーバーは、クライアントから送信されたメッセージを処理するために、タイプ別にマッピングされたコールバックを登録できます。 typeパラメータは、文字列または数字として定義できます。

client.send(Type, Message)

特定のクライアントにメッセージを送信するための関数です。

broadcast(Type, Message)

Roomに接続中の全てのクライアントにメッセージを送るためのインターフェイスです。 全体クライアントに発信したり、特定のクライアントだけ除いて発信可能です。

Multiplay Server APIを知りたい場合は、次の記事を参照してください。

📘 次のガイドを参考にして. [ZEPETO.Multiplay(Server) API]

メッセージ受信

onMessage使用例は次の通りです。

TypeScript


メッセージ送信

client.send使用例は次の通りです。

TypeScript


broadcast使用例は次の通りです。

すべてのクライアントへのメッセージ発信例

TypeScript


▼ 特定のクライアントを除いたメッセージ発信例

TypeScript


Client API

Client APIは次のMethodを提供しています。

room.AddMessageHandler(Type, Message)

サーバーから受信したメッセージを受信するにはAddMessageHandlerコールバックを登録することで受信することができます。 メッセージコールバック登録の際、受信したいメッセージタイプを定義することができます。

room.Send(Type, message)

サーバーにメッセージを発信する際に使用するインターフェイスです。伝えるメッセージタイプを定義することができます。

room.AddMessageHandler使用例は次の通りです。

TypeScript


room.Send使用例は次の通りです。

TypeScript


様々なタイプのRoom Message例をご確認ください。

Server

TypeScript


Client

TypeScript