gpg:: RealTimeMultiplayerManager
#include <real_time_multiplayer_manager.h>
מאחזר, משנה, מטפל בהעברת הודעות ויוצר RealTimeRoom
אובייקטים.
סיכום
סוגים ציבוריים |
|
---|---|
FetchInvitationsCallback
|
typedefstd::function< void(const FetchInvitationsResponse &)>
מגדירה קריאה חוזרת (callback) שניתן להשתמש בה כדי לקבל WaitingRoomUIResponse מאחת הפעולות של מספר משתתפים בזמן אמת. |
LeaveRoomCallback
|
typedefstd::function< void(const ResponseStatus &)>
מגדירה קריאה חוזרת (callback) שיכולה לקבל ResponseStatus מ-LeaveRoom . |
PlayerSelectUICallback
|
typedefstd::function< void(const PlayerSelectUIResponse &)>
מגדירה קריאה חוזרת (callback) שיכולה לקבל PlayerSelectUIResponse מ-ShowPlayerSelectUI . |
PlayerSelectUIResponse
|
typedefData וגם ResponseStatus עבור הפעולה ShowPlayerSelectUI . |
RealTimeRoomCallback
|
typedefstd::function< void(const RealTimeRoomResponse &)>
הגדרת קריאה חוזרת (callback) שניתן להשתמש בה כדי לקבל struct RealTimeRoomResponse מאחת הפעולות של ריבוי משתתפים המבוססות על תורות. |
RoomInboxUICallback
|
typedefstd::function< void(const RoomInboxUIResponse &)>
מגדירה קריאה חוזרת (callback) שיכולה לקבל RoomInboxUIResponse מ-ShowRoomInboxUI . |
SendReliableMessageCallback
|
typedefstd::function< void(const MultiplayerStatus &)>
מגדירה קריאה חוזרת (callback) שיכולה לקבל ResponseStatus מ-SendReliableMessage . |
WaitingRoomUICallback
|
typedefstd::function< void(const WaitingRoomUIResponse &)>
מגדירה קריאה חוזרת (callback) שניתן להשתמש בה כדי לקבל WaitingRoomUIResponse מאחת הפעולות של מספר משתתפים בזמן אמת. |
תפקידים ציבוריים |
|
---|---|
AcceptInvitation(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
|
void
הפונקציה מקבלת
MultiplayerInvitation באופן אסינכרוני ומחזירה את התוצאה דרך RealTimeRoomCallback . |
AcceptInvitation(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
|
void
הפונקציה מקבלת
MultiplayerInvitation באופן אסינכרוני ומחזירה את התוצאה דרך RealTimeRoomCallback . |
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
|
גרסת חסימה של AcceptInvitation.
|
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, IRealTimeEventListener *listener)
|
עומס יתר של AcceptInvitationBlocking, שבו הזמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 10 שנים.
|
AcceptInvitationBlocking(Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
|
גרסת חסימה של AcceptInvitation.
|
AcceptInvitationBlocking(const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper)
|
עומס יתר של AcceptInvitationBlocking, שבו הזמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 10 שנים.
|
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback)
|
void
הפונקציה יוצרת באופן אסינכרוני אובייקט
RealTimeRoom באמצעות המחלקה RealTimeRoomConfig שצוינה. |
CreateRealTimeRoom(const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback)
|
void
הפונקציה יוצרת באופן אסינכרוני אובייקט
RealTimeRoom באמצעות המחלקה RealTimeRoomConfig שצוינה. |
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
|
גרסת חסימה של CreateRealTimeRoom.
|
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, IRealTimeEventListener *listener)
|
עומס יתר של CreateRealTimeRoomBlocking, שהזמן הקצוב לתפוגה שהוגדר לו הוא 10 שנים כברירת מחדל.
|
CreateRealTimeRoomBlocking(Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
|
גרסת חסימה של CreateRealTimeRoom.
|
CreateRealTimeRoomBlocking(const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper)
|
עומס יתר של CreateRealTimeRoomBlocking, שהזמן הקצוב לתפוגה שהוגדר לו הוא 10 שנים כברירת מחדל.
|
DeclineInvitation(const MultiplayerInvitation & invitation)
|
void
דחייה של
MultiplayerInvitation לRealTimeRoom . |
DismissInvitation(const MultiplayerInvitation & invitation)
|
void
דוחה
MultiplayerInvitation ל-RealTimeRoom . |
FetchInvitations(FetchInvitationsCallback callback)
|
void
הפונקציה מאחזרת כל
MultiplayerInvitation s כדי להציג חדרים בזמן אמת. |
FetchInvitationsBlocking(Timeout timeout)
|
גרסת חסימה של FetchInvitations.
|
FetchInvitationsBlocking()
|
עומס יתר של FetchInvitationsBlocking, שמשתמש הזמן הקצוב לתפוגה שמוגדר כברירת מחדל ל-10 שנים.
|
LeaveRoom(const RealTimeRoom & room, LeaveRoomCallback callback)
|
void
משאירים
RealTimeRoom . |
LeaveRoomBlocking(Timeout timeout, const RealTimeRoom & room)
|
גרסה חוסמת של LeaveRoom.
|
LeaveRoomBlocking(const RealTimeRoom & room)
|
עומס יתר של LeaveRoomBlocking, שמוגדר כברירת מחדל זמן קצוב לתפוגה של 10 שנים.
|
SendReliableMessage(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback)
|
void
שליחת הודעה למכשיר
MultiplayerParticipant שצוין. |
SendReliableMessageBlocking(Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
|
גרסת חסימה של SendReliableMessage.
|
SendReliableMessageBlocking(const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data)
|
עומס יתר של SendReliableMessageBlocking, שלפיו הזמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 10 שנים.
|
SendUnreliableMessage(const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data)
|
void
שליחת הודעה ל-
MultiplayerParticipant s שצוינו. |
SendUnreliableMessageToOthers(const RealTimeRoom & room, std::vector< uint8_t > data)
|
void
שליחת הודעה לכל המשתתפים מלבד המשתמש הנוכחי.
|
ShowPlayerSelectUI(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback)
|
void
מציג באופן אסינכרוני את ממשק המשתמש של בחירת השחקן, וכך מאפשר לשחקן לבחור שחקנים אחרים שיצטרפו לחדר.
|
ShowPlayerSelectUIBlocking(Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
|
גרסת חסימה של ShowPlayerSelectUI.
|
ShowPlayerSelectUIBlocking(uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch)
|
עומס יתר של ShowPlayerSelectUIBlocking, הזמן הקצוב לתפוגה שמוגדר כברירת מחדל ל-10 שנים.
|
ShowRoomInboxUI(RoomInboxUICallback callback)
|
void
מציג באופן אסינכרוני את ממשק המשתמש של תיבת הדואר הנכנס של החדר, וכך מאפשר לשחקן לבחור הזמנה למשחק רב-משתתפים.
|
ShowRoomInboxUIBlocking(Timeout timeout)
|
גרסת חסימה של ShowRoomInboxUI.
|
ShowRoomInboxUIBlocking()
|
עומס יתר של ShowRoomInboxUIBlocking, שמשתמש בברירת מחדל של זמן קצוב לתפוגה של 10 שנים.
|
ShowWaitingRoomUI(const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback)
|
void
מציג ממשק משתמש של חדר המתנה, שבו מוצג הסטטוס של משתתפים מרובי-משתתפים שמצטרפים לחדר.
|
ShowWaitingRoomUIBlocking(Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start)
|
גרסת החסימה של ShowWaitingRoomUI.
|
ShowWaitingRoomUIBlocking(const RealTimeRoom & room, uint32_t min_participants_to_start)
|
עומס יתר של ShowWaitingRoomUIBlocking, שמשתמש בברירת מחדל של זמן קצוב לתפוגה של 10 שנים.
|
מבנים |
|
---|---|
gpg:: |
|
gpg:: |
הערכים |
gpg:: |
|
gpg:: |
|
סוגים ציבוריים
FetchInvitationsCallback
std::function< void(const FetchInvitationsResponse &)> FetchInvitationsCallback
מגדירה קריאה חוזרת (callback) שניתן להשתמש בה כדי לקבל WaitingRoomUIResponse
מאחת הפעולות של מספר משתתפים בזמן אמת.
LeaveRoomCallback
std::function< void(const ResponseStatus &)> LeaveRoomCallback
מגדירה קריאה חוזרת (callback) שיכולה לקבל ResponseStatus
מ-LeaveRoom
.
PlayerSelectUICallback
std::function< void(const PlayerSelectUIResponse &)> PlayerSelectUICallback
מגדירה קריאה חוזרת (callback) שיכולה לקבל PlayerSelectUIResponse
מ-ShowPlayerSelectUI
.
PlayerSelectUIResponse
TurnBasedMultiplayerManager::PlayerSelectUIResponse PlayerSelectUIResponse
Data
וגם ResponseStatus
עבור הפעולה ShowPlayerSelectUI
.
הכרטיס הזה משותף עם משחקים מרובי משתתפים המבוססים על תורות.
RealTimeRoomCallback
std::function< void(const RealTimeRoomResponse &)> RealTimeRoomCallback
הגדרת קריאה חוזרת (callback) שניתן להשתמש בה כדי לקבל struct RealTimeRoomResponse
מאחת הפעולות של ריבוי משתתפים המבוססות על תורות.
RoomInboxUICallback
std::function< void(const RoomInboxUIResponse &)> RoomInboxUICallback
מגדירה קריאה חוזרת (callback) שיכולה לקבל RoomInboxUIResponse
מ-ShowRoomInboxUI
.
SendReliableMessageCallback
std::function< void(const MultiplayerStatus &)> SendReliableMessageCallback
מגדירה קריאה חוזרת (callback) שיכולה לקבל ResponseStatus
מ-SendReliableMessage
.
WaitingRoomUICallback
std::function< void(const WaitingRoomUIResponse &)> WaitingRoomUICallback
מגדירה קריאה חוזרת (callback) שניתן להשתמש בה כדי לקבל WaitingRoomUIResponse
מאחת הפעולות של מספר משתתפים בזמן אמת.
תפקידים ציבוריים
AcceptInvitation
void AcceptInvitation( const MultiplayerInvitation & invitation, IRealTimeEventListener *listener, RealTimeRoomCallback callback )
הפונקציה מקבלת MultiplayerInvitation
באופן אסינכרוני ומחזירה את התוצאה דרך RealTimeRoomCallback
.
AcceptInvitation
void AcceptInvitation( const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback )
הפונקציה מקבלת MultiplayerInvitation
באופן אסינכרוני ומחזירה את התוצאה דרך RealTimeRoomCallback
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( Timeout timeout, const MultiplayerInvitation & invitation, IRealTimeEventListener *listener )
גרסת חסימה של AcceptInvitation.
מאפשרת למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שיחלוף הזמן שצוין, הפונקציה מחזירה את ERROR_TIMEOUT
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( const MultiplayerInvitation & invitation, IRealTimeEventListener *listener )
עומס יתר של AcceptInvitationBlocking, שבו הזמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 10 שנים.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( Timeout timeout, const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper )
גרסת חסימה של AcceptInvitation.
מאפשרת למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שיחלוף הזמן שצוין, הפונקציה מחזירה את ERROR_TIMEOUT
.
AcceptInvitationBlocking
RealTimeRoomResponse AcceptInvitationBlocking( const MultiplayerInvitation & invitation, RealTimeEventListenerHelper helper )
עומס יתר של AcceptInvitationBlocking, שבו הזמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 10 שנים.
CreateRealTimeRoom
void CreateRealTimeRoom( const gpg::RealTimeRoomConfig & config, IRealTimeEventListener *listener, RealTimeRoomCallback callback )
הפונקציה יוצרת באופן אסינכרוני אובייקט RealTimeRoom
באמצעות המחלקה RealTimeRoomConfig
שצוינה.
אם היצירה תתבצע בהצלחה, הפונקציה הזו תחזיר את האובייקט RealTimeRoom
דרך RealTimeRoomCallback
שסופק.
CreateRealTimeRoom
void CreateRealTimeRoom( const gpg::RealTimeRoomConfig & config, RealTimeEventListenerHelper helper, RealTimeRoomCallback callback )
הפונקציה יוצרת באופן אסינכרוני אובייקט RealTimeRoom
באמצעות המחלקה RealTimeRoomConfig
שצוינה.
אם היצירה תתבצע בהצלחה, הפונקציה הזו תחזיר את האובייקט RealTimeRoom
דרך RealTimeRoomCallback
שסופק.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( Timeout timeout, const RealTimeRoomConfig & config, IRealTimeEventListener *listener )
גרסת חסימה של CreateRealTimeRoom.
מאפשרת למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שיחלוף הזמן שצוין, הפונקציה מחזירה את ERROR_TIMEOUT
.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( const RealTimeRoomConfig & config, IRealTimeEventListener *listener )
עומס יתר של CreateRealTimeRoomBlocking, שהזמן הקצוב לתפוגה שהוגדר לו הוא 10 שנים כברירת מחדל.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( Timeout timeout, const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper )
גרסת חסימה של CreateRealTimeRoom.
מאפשרת למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שיחלוף הזמן שצוין, הפונקציה מחזירה את ERROR_TIMEOUT
.
CreateRealTimeRoomBlocking
RealTimeRoomResponse CreateRealTimeRoomBlocking( const RealTimeRoomConfig & config, RealTimeEventListenerHelper helper )
עומס יתר של CreateRealTimeRoomBlocking, שהזמן הקצוב לתפוגה שהוגדר לו הוא 10 שנים כברירת מחדל.
DeclineInvitation
void DeclineInvitation( const MultiplayerInvitation & invitation )
דחייה של MultiplayerInvitation
לRealTimeRoom
.
הפעולה הזו מבטלת את החדר של שאר המשתתפים ומסירה את החדר מהמכשיר של השחקן המקומי.
DismissInvitation
void DismissInvitation( const MultiplayerInvitation & invitation )
דוחה MultiplayerInvitation
ל-RealTimeRoom
.
הפעולה הזו לא משנה את המצב הגלוי של RealTimeRoom
עבור המשתתפים האחרים, אלא רק מסירה אותה מהמכשיר של הנגן המקומי.
FetchInvitations
void FetchInvitations( FetchInvitationsCallback callback )
הפונקציה מאחזרת כל MultiplayerInvitation
s כדי להציג חדרים בזמן אמת.
פריטי ה-MultiplayerInvitation
שנשלפו מוחזרים באמצעות ה-FetchInvitationsCallback
שסופק.
FetchInvitationsBlocking
FetchInvitationsResponse FetchInvitationsBlocking( Timeout timeout )
גרסת חסימה של FetchInvitations.
מאפשר למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שעובר הזמן המפוצל, הפונקציה תחזיר ERROR_TIMEOUT
.
FetchInvitationsBlocking
FetchInvitationsResponse FetchInvitationsBlocking()
עומס יתר של FetchInvitationsBlocking, שמשתמש הזמן הקצוב לתפוגה שמוגדר כברירת מחדל ל-10 שנים.
LeaveRoom
void LeaveRoom( const RealTimeRoom & room, LeaveRoomCallback callback )
משאירים RealTimeRoom
.
עד שהפעולה הזו תסתיים, אין ליצור חדר חדש או לנסות להצטרף לחדר אחר. התוצאה של פעולה זו מוחזרת דרך LeaveRoomCallback
.
LeaveRoomBlocking
ResponseStatus LeaveRoomBlocking( Timeout timeout, const RealTimeRoom & room )
גרסה חוסמת של LeaveRoom.
מאפשרת למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שיחלוף הזמן שצוין, הפונקציה מחזירה את ERROR_TIMEOUT
.
LeaveRoomBlocking
ResponseStatus LeaveRoomBlocking( const RealTimeRoom & room )
עומס יתר של LeaveRoomBlocking, שמוגדר כברירת מחדל זמן קצוב לתפוגה של 10 שנים.
SendReliableMessage
void SendReliableMessage( const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data, SendReliableMessageCallback callback )
שליחת הודעה למכשיר MultiplayerParticipant
שצוין.
משתמש בשיטה אמינה לשליחת ההודעה. השיטה הזו של שליחת נתונים עשויה להימשך זמן רב יותר משליחת הודעה באופן לא מהימן. תוצאת השליחה מדווחת באמצעות הקריאה החוזרת (callback) שסופקה.
SendReliableMessageBlocking
MultiplayerStatus SendReliableMessageBlocking( Timeout timeout, const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data )
גרסת חסימה של SendReliableMessage.
מאפשרת למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שיחלוף הזמן שצוין, הפונקציה מחזירה את ERROR_TIMEOUT
.
SendReliableMessageBlocking
MultiplayerStatus SendReliableMessageBlocking( const RealTimeRoom & room, const MultiplayerParticipant & participant, std::vector< uint8_t > data )
עומס יתר של SendReliableMessageBlocking, שלפיו הזמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 10 שנים.
SendUnreliableMessage
void SendUnreliableMessage( const RealTimeRoom & room, const std::vector< MultiplayerParticipant > & participants, std::vector< uint8_t > data )
שליחת הודעה ל-MultiplayerParticipant
s שצוינו.
משתמש בשיטה לא אמינה לשליחת ההודעה. השיטה הזו לשליחת נתונים מהירה יותר משליחה אמינה של נתונים, וכדאי להעדיף אותה אם אפשר.
SendUnreliableMessageToOthers
void SendUnreliableMessageToOthers( const RealTimeRoom & room, std::vector< uint8_t > data )
שליחת הודעה לכל המשתתפים מלבד המשתמש הנוכחי.
משתמש בשיטה לא אמינה לשליחת ההודעה. השיטה הזו לשליחת נתונים מהירה יותר משליחה אמינה של נתונים, וכדאי להעדיף אותה אם אפשר.
ShowPlayerSelectUI
void ShowPlayerSelectUI( uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch, PlayerSelectUICallback callback )
מציג באופן אסינכרוני את ממשק המשתמש של בחירת השחקן, וכך מאפשר לשחקן לבחור שחקנים אחרים שיצטרפו לחדר.
בסיום, השחקנים שנבחרו יוחזרו באמצעות PlayerSelectUICallback
.
ShowPlayerSelectUIBlocking
PlayerSelectUIResponse ShowPlayerSelectUIBlocking( Timeout timeout, uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch )
גרסת חסימה של ShowPlayerSelectUI.
מאפשרת למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שיחלוף הזמן שצוין, הפונקציה מחזירה את ERROR_TIMEOUT
.
ShowPlayerSelectUIBlocking
PlayerSelectUIResponse ShowPlayerSelectUIBlocking( uint32_t minimum_players, uint32_t maximum_players, bool allow_automatch )
עומס יתר של ShowPlayerSelectUIBlocking, הזמן הקצוב לתפוגה שמוגדר כברירת מחדל ל-10 שנים.
ShowRoomInboxUI
void ShowRoomInboxUI( RoomInboxUICallback callback )
מציג באופן אסינכרוני את ממשק המשתמש של תיבת הדואר הנכנס של החדר, וכך מאפשר לשחקן לבחור הזמנה למשחק רב-משתתפים.
בסיום, ההזמנה שנבחרה תוחזר באמצעות RoomInboxUIResponse
.
ShowRoomInboxUIBlocking
RoomInboxUIResponse ShowRoomInboxUIBlocking( Timeout timeout )
גרסת חסימה של ShowRoomInboxUI.
מאפשרת למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שיחלוף הזמן שצוין, הפונקציה מחזירה את ERROR_TIMEOUT
.
ShowRoomInboxUIBlocking
RoomInboxUIResponse ShowRoomInboxUIBlocking()
עומס יתר של ShowRoomInboxUIBlocking, שמשתמש בברירת מחדל של זמן קצוב לתפוגה של 10 שנים.
ShowWaitingRoomUI
void ShowWaitingRoomUI( const RealTimeRoom & room, uint32_t min_participants_to_start, WaitingRoomUICallback callback )
מציג ממשק משתמש של חדר המתנה, שבו מוצג הסטטוס של משתתפים מרובי-משתתפים שמצטרפים לחדר.
ShowWaitingRoomUIBlocking
WaitingRoomUIResponse ShowWaitingRoomUIBlocking( Timeout timeout, const RealTimeRoom & room, uint32_t min_participants_to_start )
גרסת החסימה של ShowWaitingRoomUI.
מאפשר למתקשר לציין זמן קצוב לתפוגה ב-ms. לאחר שעובר הזמן המפוצל, הפונקציה תחזיר ERROR_TIMEOUT
.
ShowWaitingRoomUIBlocking
WaitingRoomUIResponse ShowWaitingRoomUIBlocking( const RealTimeRoom & room, uint32_t min_participants_to_start )
עומס יתר של ShowWaitingRoomUIBlocking, שמשתמש בברירת מחדל של זמן קצוב לתפוגה של 10 שנים.