gpg::RealTimeMultiplayerManager

#include <real_time_multiplayer_manager.h>

מאחזר, משנה, מטפל בהעברת הודעות ויוצר אובייקטים מסוג RealTimeRoom.

סיכום

סוגים ציבוריים

FetchInvitationsCallback typedef
std::function< void(const FetchInvitationsResponse &)>
מגדיר קריאה חוזרת (callback) שאפשר להשתמש בה כדי לקבל WaitingRoomUIResponse מאחת מהפעולות הרב-משתתפים בזמן אמת.
LeaveRoomCallback typedef
std::function< void(const ResponseStatus &)>
מגדיר קריאה חוזרת (callback) שיכולה לקבל ResponseStatus מ-LeaveRoom.
PlayerSelectUICallback typedef
std::function< void(const PlayerSelectUIResponse &)>
מגדיר קריאה חוזרת (callback) שיכולה לקבל PlayerSelectUIResponse מ-ShowPlayerSelectUI.
PlayerSelectUIResponse typedef
Data ו-ResponseStatus לפעולה ShowPlayerSelectUI.
RealTimeRoomCallback typedef
std::function< void(const RealTimeRoomResponse &)>
מגדיר קריאה חוזרת (callback) שאפשר להשתמש בה כדי לקבל מבנה RealTimeRoomResponse מאחת מהפעולות רבי-משתתפים לפי תור.
RoomInboxUICallback typedef
std::function< void(const RoomInboxUIResponse &)>
מגדיר קריאה חוזרת (callback) שיכולה לקבל RoomInboxUIResponse מ-ShowRoomInboxUI.
SendReliableMessageCallback typedef
std::function< void(const MultiplayerStatus &)>
מגדיר קריאה חוזרת (callback) שיכולה לקבל ResponseStatus מ-SendReliableMessage.
WaitingRoomUICallback typedef
std::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
DismissInvitation(const MultiplayerInvitation & invitation)
void
FetchInvitations(FetchInvitationsCallback callback)
void
אחזור כל מכשיר MultiplayerInvitation לחדרים בזמן אמת.
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 שצוינו.
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::RealTimeMultiplayerManager::FetchInvitationsResponse

Data ו-ResponseStatus לפעולה FetchInvitations.

gpg::RealTimeMultiplayerManager::RealTimeRoomResponse

Data ו-ResponseStatus לאובייקט RealTimeRoom ספציפי.

gpg::RealTimeMultiplayerManager::RoomInboxUIResponse

Data ו-ResponseStatus לפעולה ShowRoomInboxUI.

gpg::RealTimeMultiplayerManager::WaitingRoomUIResponse

Data ו-ResponseStatus לפעולה ShowWaitingRoomUI.

סוגים ציבוריים

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) שאפשר להשתמש בה כדי לקבל מבנה 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.

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי הזמן שצוין, הפונקציה מחזירה ERROR_TIMEOUT.

AcceptInvitationBlocking

RealTimeRoomResponse AcceptInvitationBlocking(
  const MultiplayerInvitation & invitation,
  IRealTimeEventListener *listener
)

עומס יתר של AcceptInvitationBlocking, שבו הזמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 10 שנים.

AcceptInvitationBlocking

RealTimeRoomResponse AcceptInvitationBlocking(
  Timeout timeout,
  const MultiplayerInvitation & invitation,
  RealTimeEventListenerHelper helper
)

גרסת חסימה של AcceptInvitation.

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי הזמן שצוין, הפונקציה מחזירה 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.

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי הזמן שצוין, הפונקציה מחזירה ERROR_TIMEOUT.

CreateRealTimeRoomBlocking

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  const RealTimeRoomConfig & config,
  IRealTimeEventListener *listener
)

עומס יתר של CreateRealTimeRoomBlocking, שבו הזמן הקצוב לתפוגה שמוגדר כברירת מחדל הוא 10 שנים.

CreateRealTimeRoomBlocking

RealTimeRoomResponse CreateRealTimeRoomBlocking(
  Timeout timeout,
  const RealTimeRoomConfig & config,
  RealTimeEventListenerHelper helper
)

גרסת חסימה של CreateRealTimeRoom.

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי הזמן שצוין, הפונקציה מחזירה 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 לחדרים בזמן אמת.

הפריטים מסוג 'MultiplayerInvitation' שאוחזרו מוחזרים דרך ה-FetchInvitationsCallback שצוין.

FetchInvitationsBlocking

FetchInvitationsResponse FetchInvitationsBlocking(
  Timeout timeout
)

גרסת חסימה של FetchInvitations (הזמנות לשליפה).

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי שיעבור הזמן שהוקצב, הפונקציה תחזיר 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.

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי הזמן שצוין, הפונקציה מחזירה 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.

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי הזמן שצוין, הפונקציה מחזירה 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 שצוינו.

נעשה שימוש בשיטה לא אמינה לשליחת ההודעה. השיטה הזו לשליחת נתונים מהירה יותר משליחת נתונים אמינה, ולכן כדאי להעדיף אם אפשר.

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.

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי הזמן שצוין, הפונקציה מחזירה 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

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. אחרי הזמן שצוין, הפונקציה מחזירה 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.

מאפשרת למתקשר לציין זמן קצוב לתפוגה באלפיות השנייה. בסיום הזמן הקצוב לתפוגה, הפונקציה תחזיר ERROR_TIMEOUT.

ShowWaitingRoomUIBlocking

WaitingRoomUIResponse ShowWaitingRoomUIBlocking(
  const RealTimeRoom & room,
  uint32_t min_participants_to_start
)

עומס יתר של ShowWaitingRoomUIBlocking, שהזמן הקצוב שלו לתפוגה הוא 10 שנים כברירת מחדל.