Documentation Steamworks
Interface ISteamGameCoordinator
Fonctions pour envoyer et recevoir les messages du coordinateur de jeu.

Essentiellement obsolète, mais il existe encore uniquement pour quelques jeux qui les utilisent.

Fonctions


Remarque : ISteamGameCoordinator n'affiche pas de fonction d'accesseur global. Pour y accéder, veuillez utiliser ISteamClient::GetISteamGenericInterface.

IsMessageAvailable

bool IsMessageAvailable( uint32 *pcubMsgSize );
NomTypeDescription
pcubMsgSizeuint32 *Renvoie la taille du message en octets.

Contrôle si un message du coordinateur de jeu est en attente.

Éléments renvoyés : bool
true si le message est disponible. Sinon, renvoie false.

RetrieveMessage

EGCResults RetrieveMessage( uint32 *punMsgType, void *pubDest, uint32 cubDest, uint32 *pcubMsgSize );
NomTypeDescription
punMsgTypeuint32 *
pubDestvoid *
cubDestuint32
pcubMsgSizeuint32 *

Remplit le tampon fourni avec le premier message en file d'attente et renvoie k_EGCResultOK ou k_EGCResultNoMessage s'il n'y a pas de messages en attente. pcubMsgSize comporte la taille du message.

Si le tampon fourni n'est pas assez grand pour accueillir le message tout entier, la fonction retourne k_EGCResultBufferTooSmall et le message reste en tête de la file d'attente.

Éléments renvoyés : EGCResults

SendMessage

EGCResults SendMessage( uint32 unMsgType, const void *pubData, uint32 cubData );
NomTypeDescription
unMsgTypeuint32
pubDataconst void *
cubDatauint32

Envoie un message au coordinateur de jeu.

Éléments renvoyés : EGCResults

Rappels

Voici les rappels qui peuvent être activés en appelant SteamAPI_RunCallbacks. La plupart seront activés directement en réponse aux fonctions membres de ISteamGameCoordinator.

GCMessageAvailable_t

callbacks
Notification de rappel : un nouveau message est disponible à la lecture dans la file d'attente des messages.

NomTypeDescription
m_nMessageSizeuint32

GCMessageFailed_t

Notification de rappel : un message n'a pas réussi à parvenir au coordinateur de jeu. Il est peut-être désactivé temporairement.

Ce rappel n'a pas de champ.

Énumérations

Voici les énumérations destinées à être utilisées avec ISteamGameCoordinator.

EGCResults

Liste des valeurs de retour possibles de l'API ISteamGameCoordinator.

NomValeurDescription
k_EGCResultOK0Succès.
k_EGCResultNoMessage1Il n'y a aucun message dans la file d'attente.
k_EGCResultBufferTooSmall2Le tampon n'est pas assez grand pour le message demandé.
k_EGCResultNotLoggedOn3Le client n'est pas connecté à Steam.
k_EGCResultInvalidMessage4Une erreur s'est produite avec le message envoyé via SendMessage.

Constantes

Voici les constantes destinées à être utilisées avec ISteamGameCoordinator.

NomTypeValeurDescription
STEAMGAMECOORDINATOR_INTERFACE_VERSIONconst char *"SteamGameCoordinator001"