peerGetReady
Get the ready state of the specified player.
- PEERBool peerGetReady(
- PEER peer,
- const gsi_char * nick,
- PEERBool * ready );
| Routine | Required Header | Distribution |
|---|---|---|
| peerGetReady | <peer.h> | SDKZIP |
Return Value
This function returns PEERTrue if the ready state is available. PEERFalse otherwise.
Parameters
- peer
- [in] Initialized peer object.
- nick
- [in] Nickname of the target player.
- ready
- [out] Set to PEERTrue if the player is ready, PEERFalse if the player is not.
Remarks
The peerGetReady function may be used to determine the ready status of each player in a staging room. This is often useful for display an icon or informational message to the host. This is only valid when in a staging room.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerGetReady | peerGetReadyA | peerGetReadyW |
peerGetReadyW and peerGetReadyA are UNICODE and ANSI mapped versions of peerGetReady. The arguments of peerGetReadyA are ANSI strings; those of peerGetReadyW are wide-character strings.
Section Reference: Gamespy Peer SDK