Documentación de Steamworks
Interfaz ISteamGameCoordinator
Funciones para el envío y recepción de mensajes del coordinador del juego.

Esto está en buena parte obsoleto y solo continúa existiendo para el par de juegos que todavía lo usan.

Funciones


NOTA: ISteamGameCoordinator no expone una función de un descriptor de acceso global. Debes acceder a él a través de ISteamClient::GetISteamGenericInterface.

IsMessageAvailable

bool IsMessageAvailable( uint32 *pcubMsgSize );
NombreTipoDescripción
pcubMsgSizeuint32 *Devuelve el tamaño del mensaje en bytes.

Comprueba si hay un mensaje en espera del coordinador de juego.

Devuelve: bool
true si hay un mensaje disponible; de lo contrario, false.

RetrieveMessage

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

Rellena el búfer proporcionado con el primer mensaje en la cola y devuelve k_EGCResultOK o devuelve k_EGCResultNoMessage si no hay ningún mensaje en espera. pcubMsgSize se llena con el tamaño del mensaje.

Si el búfer proporcionado no es lo suficientemente grande como para que quepa todo el mensaje, se devuelve k_EGCResultBufferTooSmall y el mensaje permanece al principio de la cola.

Devuelve: EGCResults

SendMessage

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

Envía un mensaje al coordinador del juego.

Devuelve: EGCResults

Funciones callback

Estas son funciones callback que se activan al llamar a SteamAPI_RunCallbacks. Muchas de estas se activarán directamente en respuesta a las funciones miembro de ISteamGameCoordinator.

GCMessageAvailable_t

Callbacks
Notificación de la función callback: Hay un nuevo mensaje disponible para leer en la cola de mensajes.

NombreTipoDescripción
m_nMessageSizeuint32

GCMessageFailed_t

Notificación de la función callback: Fallo en el envío de mensaje al coordinador del juego. Podría estar fuera de servicio temporalmente.

Esta función callback no tiene campos.

Enums

Esta es la lista de enumeraciones definidas para su uso con ISteamGameCoordinator.

EGCResults

Lista de posibles valores devueltos por la API ISteamGameCoordinator.

NombreValorDescripción
k_EGCResultOK0Operación exitosa.
k_EGCResultNoMessage1No hay mensaje en la cola.
k_EGCResultBufferTooSmall2El búfer es demasiado pequeño para el mensaje solicitado.
k_EGCResultNotLoggedOn3El cliente no ha iniciado sesión en Steam.
k_EGCResultInvalidMessage4Ha habido un problema con el mensaje que se estaba enviando mediante SendMessage.

Constantes

Estas son constantes definidas para su uso con ISteamGameCoordinator.

NombreTipoValorDescripción
STEAMGAMECOORDINATOR_INTERFACE_VERSIONconst char *"SteamGameCoordinator001"