ZEPETO.Multiplay
20 분
형식 설명 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 입니다