peerRoomUTMCallback
Called when a UTM is sent to a room the local player is in.
- typedef void (*peerRoomUTMCallback)(
- PEER peer,
- RoomType roomType,
- const gsi_char * nick,
- const gsi_char * command,
- const gsi_char * parameters,
- PEERBool authenticated,
- void * param );
| Routine | Required Header | Distribution |
|---|---|---|
| peerRoomUTMCallback | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object
- roomType
- [in] Can be either TitleRoom, GroupRoom or StagingRoom.
- nick
- [in] The chat nickname of the player who sent the UTM
- command
- [in] The raw UTM command sent
- parameters
- [in] The parameters sent along with the UTM command
- authenticated
- [in] PEERTrue if authenticated, PEERFalse if otherwise
- param
- [in] Pointer to user data. This is optional and will be passed unmodified to the callback function.
Remarks
The peerRoomUTMCallback is called when a player in the specified room sends a UTM message. The command is a short string identifying this UTM (e.g., RQI, NFO, GML). Ignore any unrecognized UTM, as internal Peer UTMs go through this callback, as do application UTMs.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerRoomUTMCallback | peerRoomUTMCallbackA | peerRoomUTMCallbackW |
peerRoomUTMCallbackW and peerRoomUTMCallbackA are UNICODE and ANSI mapped versions of peerRoomUTMCallback. The arguments of peerRoomUTMCallbackA are ANSI strings; those of peerRoomUTMCallbackW are wide-character strings.
Section Reference: Gamespy Peer SDK