ZEPETO.Multiplay

型 説明 sandboxplayer /#sandboxplayer multiplay room に接続しているプレイヤーのクライアントを表します。 ibroadcastoptions /#ibroadcastoptions multiplay room からクライアントへメッセージをブロードキャストする際のオプション。 sandboxoptions /#sandboxoptions multiplay room を作成する際のオプション。 sandbox /#sandbox multiplay room を表します。 sandboxplayer interface multiplay room に接続しているプレイヤーのクライアントを表します。 プロパティ 名前 型 説明 sessionid string クライアントのセッション id userid string プレイヤーのユーザー id メソッド send send(type string | number, message? t) → void 指定したチャンネルを通じてクライアントにメッセージを送信します。 パラメーター 型 説明 type string | number メッセージの送信に使用するチャンネルの識別子。 message (省略可能) t message 送信するメッセージの内容(省略可能)。 ibroadcastoptions interface multiplay room からクライアントへメッセージをブロードキャストする際のオプション。 プロパティ 名前 型 説明 except sandboxplayer /#sandboxplayer ブロードキャストから除外するクライアントを指定します。 sandboxoptions interface multiplay room を作成する際のオプション。 プロパティ 名前 型 説明 issandbox boolean unity エディターでの qr モバイルテストなど、room がローカルでホストされるかどうかを指定します。 sandbox class multiplay room を表します。 プロパティ 名前 型 説明 locked boolean multiplay room がロックされているかどうかを指定します。 roomid string multiplay room の id。重複を避けるため、作成時にランダムに割り当てられます。 uniqueid string multiplay room の id。作成時に明示的に割り当てられます。 maxclients number multiplay room に接続できるクライアントの最大数。 state state multiplay room の状態。状態データのスキーマは multiplay schema によって定義されます。 clients iterableiterator\<sandboxplayer> multiplay room に接続しているクライアントの反復可能な表現。 allowreconnectiontime number 接続が不安定なクライアントの再接続を許可する制限時間(秒)。 private boolean multiplay room がプライベートかどうかを指定します。 メソッド oncreate oncreate(options sandboxoptions) → void | promise\<void> この抽象メソッドの実装は、multiplay room が作成されるときに一度だけ実行されます。 実装は任意で async として宣言できます。 パラメーター 型 説明 options sandboxoptions /#sandboxoptions この multiplay room を作成する際のオプション。 戻り値 void | promise\<void> — 非同期の場合は promise\<void> を返します。それ以外の場合は void を返します。 onjoin onjoin(client sandboxplayer) → void | promise\<void> この抽象メソッドの実装は、クライアントが multiplay room に参加したときに実行されます。 実装は任意で async として宣言できます。 パラメーター 型 説明 client sandboxplayer /#sandboxplayer プレイヤーのクライアントオブジェクト。 戻り値 void | promise\<void> — 非同期の場合は promise\<void> を返します。それ以外の場合は void を返します。 onleave onleave(client sandboxplayer, consented? boolean) → void | promise\<void> この抽象メソッドの実装は、クライアントが multiplay room から退出したときに実行されます。 実装は任意で async として宣言できます。 パラメーター 型 説明 client sandboxplayer /#sandboxplayer プレイヤーのクライアントオブジェクト。 consented (省略可能) boolean プレイヤーが再接続に同意したかどうかを指定します。 戻り値 void | promise\<void> — 非同期の場合は promise\<void> を返します。それ以外の場合は void を返します。 lock lock() → promise\<void> multiplay room をロックします。 戻り値 promise\<void> — ロック処理の完了時に解決される promise 。 unlock unlock() → promise\<void> multiplay room のロックを解除します。 戻り値 promise\<void> — ロック解除処理の完了時に解決される promise 。 ontick ontick(deltatime number) → void このメソッドの実装は、およそ 100 ミリ秒ごとに実行されます。 パラメーター 型 説明 deltatime number 前回の呼び出しからの時間差(ミリ秒)を表します。 onmessage onmessage(messagetype ' ' | string | number, callback (client sandboxplayer, message t) => void) → void クライアントから受信したメッセージを処理するコールバックを登録します。 パラメーター 型 説明 messagetype ' ' | string | number メッセージが送信されたチャンネルの識別子。 callback (client sandboxplayer, message t) => void 受信したメッセージを処理するコールバックメソッド。 broadcast broadcast(type string | number, message? any, options? ibroadcastoptions) → void 指定したチャンネルを通じて、multiplay room に接続しているすべてのクライアントにメッセージを送信します。 パラメーター 型 説明 type string | number メッセージの送信に使用するチャンネルの識別子。 message (省略可能) any メッセージの内容(省略可能)。 options (省略可能) ibroadcastoptions /#ibroadcastoptions ブロードキャストのオプション。 loadplayer loadplayer(sessionid string) → sandboxplayer | undefined セッション id に紐づくクライアントオブジェクトを取得します。 パラメーター 型 説明 sessionid string クライアントのセッション id。 戻り値 sandboxplayer | undefined — クライアントオブジェクト。 setprivate setprivate(isprivate boolean) → promise\<void> multiplay room のプライベート状態を設定します。 パラメーター 型 説明 isprivate boolean multiplay room のプライベート状態を指定します。 戻り値 promise\<void> — 処理の完了時に解決される promise 。 kick kick(client sandboxplayer, reason? string) → promise\<void> multiplay room からクライアントを強制的に退出させます。 パラメーター 型 説明 client sandboxplayer /#sandboxplayer 強制退出させるクライアントのオブジェクト。 reason (省略可能) string 強制退出の理由を任意で記述します。 戻り値 promise\<void> — 処理の完了時に解決される promise 。