peerUTMRoom
Send a UTM message to each client in the room.
- void peerUTMRoom(
- PEER peer,
- RoomType roomType,
- const gsi_char * command,
- const gsi_char * parameters,
- PEERBool authenticate );
| Routine | Required Header | Distribution |
|---|---|---|
| peerUTMRoom | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- roomType
- [in] Can be either TitleRoom, GroupRoom or StagingRoom.
- command
- [in] The raw command to send.
- parameters
- [in] Parameters to send along with the command.
- authenticate
- [in] Set to PEERTrue to have server authenticate this UTM. Normally set this to PEERFalse.
Remarks
The peerUTMPlayer function may be used to send a UTM message to the specified client. All the players in the room, including the local player, will receive a peerRoomUTMCallback with the UTM. UTM’s are used to pass around arbitrary information between players. The command is a short string identifying this UTM (e.g., RQI, NFO, GML). This function only works if the local user is in the room he is trying to message.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerUTMRoom | peerUTMRoomA | peerUTMRoomW |
peerUTMRoomW and peerUTMRoomA are UNICODE and ANSI mapped versions of peerUTMRoom. The arguments of peerUTMRoomA are ANSI strings; those of peerUTMRoomW are wide-character strings.
Section Reference: Gamespy Peer SDK
See Also: peerUTMPlayer