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 ระบุว่า room ถูกโฮสต์แบบโลคัลหรือไม่ เช่น สำหรับการทดสอบ qr mobile ใน unity editor sandbox class แทน multiplay room พร็อพเพอร์ตี้ ชื่อ ประเภท คำอธิบาย locked boolean ระบุว่า multiplay room ถูกล็อกหรือไม่ roomid string id ของ multiplay room ซึ่งกำหนดแบบสุ่มเมื่อสร้างเพื่อหลีกเลี่ยงการซ้ำกัน uniqueid string id ของ multiplay room ซึ่งกำหนดอย่างชัดเจนเมื่อสร้าง 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 ที่ resolve เมื่อกระบวนการล็อกเสร็จสิ้น unlock unlock() → promise\<void> ปลดล็อก multiplay room ค่าที่คืนกลับ promise\<void> — promise ที่ resolve เมื่อกระบวนการปลดล็อกเสร็จสิ้น ontick ontick(deltatime number) → void การอิมพลีเมนต์เมธอดนี้จะทำงานประมาณทุก 100 มิลลิวินาที พารามิเตอร์ ประเภท คำอธิบาย deltatime number แทนผลต่างของเวลา (เป็นมิลลิวินาที) นับจากการเรียกครั้งก่อน onmessage onmessage(messagetype ' ' | string | number, callback (client sandboxplayer, message t) => void) → void ลงทะเบียน callback เพื่อจัดการข้อความที่ได้รับจากไคลเอนต์ พารามิเตอร์ ประเภท คำอธิบาย messagetype ' ' | string | number ตัวระบุของแชนเนลที่ข้อความถูกส่งผ่าน callback (client sandboxplayer, message t) => void เมธอด callback สำหรับจัดการข้อความที่ได้รับ 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 ที่ resolve เมื่อกระบวนการเสร็จสิ้น kick kick(client sandboxplayer, reason? string) → promise\<void> เตะไคลเอนต์ออกจาก multiplay room พารามิเตอร์ ประเภท คำอธิบาย client sandboxplayer /#sandboxplayer อ็อบเจกต์ของไคลเอนต์ที่จะถูกเตะออก reason (ไม่บังคับ) string ระบุเหตุผลของการเตะออกได้ตามต้องการ ค่าที่คืนกลับ promise\<void> — promise ที่ resolve เมื่อกระบวนการเสร็จสิ้น