Unaffiliated

Home Documentation & Help
Steamworks Documentation
ISteamGameCoordinator Interface
Functions for sending and receiving messages from the Game Coordinator.

This is largely deprecated, and only continues to exist for the couple games that still use this.

Functions


NOTE: ISteamGameCoordinator does not expose a global accessor function. You must access it through ISteamClient::GetISteamGenericInterface.

IsMessageAvailable

bool IsMessageAvailable( uint32 *pcubMsgSize );
NameTypeDescription
pcubMsgSizeuint32 *Returns the size of the message in bytes.

Checks if there is a message waiting from the game coordinator.

Returns: bool
true if a message is available; otherwise, false.

RetrieveMessage

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

Fills the provided buffer with the first message in the queue and returns k_EGCResultOK or returns k_EGCResultNoMessage if there is no message waiting. pcubMsgSize is filled with the message size.

If the provided buffer is not large enough to fit the entire message, k_EGCResultBufferTooSmall is returned and the message remains at the head of the queue.

Returns: EGCResults

SendMessage

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

Sends a message to the Game Coordinator.

Returns: EGCResults

Callbacks

These are callbacks which can be fired by calling SteamAPI_RunCallbacks. Many of these will be fired directly in response to the member functions of ISteamGameCoordinator.

GCMessageAvailable_t

callbacks
callback notification - A new message is available for reading from the message queue

NameTypeDescription
m_nMessageSizeuint32

GCMessageFailed_t

callback notification - A message failed to make it to the GC. It may be down temporarily

This callback has no fields.

Enums

These are enums which are defined for use with ISteamGameCoordinator.

EGCResults

List of possible return values from the ISteamGameCoordinator API.

NameValueDescription
k_EGCResultOK0Success.
k_EGCResultNoMessage1There is no message in the queue.
k_EGCResultBufferTooSmall2The buffer is too small for the requested message.
k_EGCResultNotLoggedOn3The client is not logged onto Steam.
k_EGCResultInvalidMessage4Something was wrong with the message being sent with SendMessage.

Constants

These are constants which are defined for use with ISteamGameCoordinator.

NameTypeValueDescription
STEAMGAMECOORDINATOR_INTERFACE_VERSIONconst char *"SteamGameCoordinator001"