ZEPETO.Multiplay

type description sandboxplayer /#sandboxplayer représente le client d'un joueur connecté au multiplay room ibroadcastoptions /#ibroadcastoptions options de diffusion des messages du multiplay room vers les clients sandboxoptions /#sandboxoptions options de création d'un multiplay room sandbox /#sandbox représente un multiplay room sandboxplayer interface représente le client d'un joueur connecté au multiplay room propriétés nom type description sessionid string id de session du client userid string id utilisateur du joueur méthodes send send(type string | number, message? t) → void envoie un message à un client via un canal spécifié paramètre type description type string | number identifiant du canal par lequel envoyer le message message (facultatif) t message contenu facultatif du message à envoyer ibroadcastoptions interface options de diffusion des messages du multiplay room vers les clients propriétés nom type description except sandboxplayer /#sandboxplayer spécifie un client à exclure de la diffusion sandboxoptions interface options de création d'un multiplay room propriétés nom type description issandbox boolean spécifie si le room est hébergé localement, par exemple pour les tests qr mobile dans l'éditeur unity sandbox class représente un multiplay room propriétés nom type description locked boolean spécifie si le multiplay room est verrouillé roomid string id du multiplay room, attribué aléatoirement lors de la création pour éviter les doublons uniqueid string id du multiplay room, attribué explicitement lors de la création maxclients number nombre maximal de clients pouvant se connecter au multiplay room state state état d'un multiplay room le schéma des données d'état est défini par le multiplay schema clients iterableiterator\<sandboxplayer> représentation itérable des clients connectés au multiplay room allowreconnectiontime number délai limite (en secondes) pendant lequel la reconnexion d'un client à la connexion instable est autorisée private boolean spécifie si le multiplay room est privé méthodes oncreate oncreate(options sandboxoptions) → void | promise\<void> l'implémentation de cette méthode abstraite est exécutée une seule fois, à la création du multiplay room l'implémentation peut éventuellement être déclarée async paramètre type description options sandboxoptions /#sandboxoptions options de création du multiplay room renvoie void | promise\<void> — en mode asynchrone, renvoie promise\<void> sinon, void onjoin onjoin(client sandboxplayer) → void | promise\<void> l'implémentation de cette méthode abstraite est exécutée lorsqu'un client rejoint le multiplay room l'implémentation peut éventuellement être déclarée async paramètre type description client sandboxplayer /#sandboxplayer objet client du joueur renvoie void | promise\<void> — en mode asynchrone, renvoie promise\<void> sinon, void onleave onleave(client sandboxplayer, consented? boolean) → void | promise\<void> l'implémentation de cette méthode abstraite est exécutée lorsqu'un client quitte le multiplay room l'implémentation peut éventuellement être déclarée async paramètre type description client sandboxplayer /#sandboxplayer objet client du joueur consented (facultatif) boolean spécifie si le joueur a consenti à se reconnecter renvoie void | promise\<void> — en mode asynchrone, renvoie promise\<void> sinon, void lock lock() → promise\<void> verrouille le multiplay room renvoie promise\<void> — promise résolue une fois le verrouillage terminé unlock unlock() → promise\<void> déverrouille le multiplay room renvoie promise\<void> — promise résolue une fois le déverrouillage terminé ontick ontick(deltatime number) → void l'implémentation de cette méthode est exécutée environ toutes les 100 millisecondes paramètre type description deltatime number représente l'écart de temps (en millisecondes) depuis l'appel précédent onmessage onmessage(messagetype ' ' | string | number, callback (client sandboxplayer, message t) => void) → void enregistre un callback chargé de traiter les messages reçus des clients paramètre type description messagetype ' ' | string | number identifiant du canal par lequel le message a été envoyé callback (client sandboxplayer, message t) => void méthode de callback chargée de traiter le message reçu broadcast broadcast(type string | number, message? any, options? ibroadcastoptions) → void envoie un message via un canal spécifié à tous les clients connectés au multiplay room paramètre type description type string | number identifiant du canal par lequel envoyer le message message (facultatif) any contenu facultatif du message options (facultatif) ibroadcastoptions /#ibroadcastoptions options de diffusion loadplayer loadplayer(sessionid string) → sandboxplayer | undefined récupère l'objet client associé à un id de session paramètre type description sessionid string id de session du client renvoie sandboxplayer | undefined — l'objet client setprivate setprivate(isprivate boolean) → promise\<void> définit l'état privé du multiplay room paramètre type description isprivate boolean spécifie l'état privé du multiplay room renvoie promise\<void> — promise résolue une fois le traitement terminé kick kick(client sandboxplayer, reason? string) → promise\<void> expulse un client du multiplay room paramètre type description client sandboxplayer /#sandboxplayer objet du client à expulser reason (facultatif) string décrivez éventuellement la raison de l'expulsion renvoie promise\<void> — promise résolue une fois le traitement terminé