peerPlayerUTMCallback
Called when a private UTM is received from another player.
- typedef void (*peerPlayerUTMCallback)(
- PEER peer,
- const gsi_char * nick,
- const gsi_char * command,
- const gsi_char * parameters,
- PEERBool authenticated,
- void * param );
| Routine | Required Header | Distribution |
|---|---|---|
| peerPlayerUTMCallback | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- nick
- [in] The player's chat nickname.
- command
- [in] The raw UTM command sent for this message.
- parameters
- [in] The parameters sent along with the command.
- authenticated
- [in] True if authenticated the server.
- param
- [in] Pointer to user data. This is optional and will be passed unmodified to the callback function.
Remarks
The peerPlayerUTMCallback function is called after receiving a UTM from a remote player. 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 |
|---|---|---|
| peerPlayerUTMCallback | peerPlayerUTMCallbackA | peerPlayerUTMCallbackW |
peerPlayerUTMCallbackW and peerPlayerUTMCallbackA are UNICODE and ANSI mapped versions of peerPlayerUTMCallback. The arguments of peerPlayerUTMCallbackA are ANSI strings; those of peerPlayerUTMCallbackW are wide-character strings.
Section Reference: Gamespy Peer SDK