peerUTMPlayer
Send a UTM message to the specified client.
- void peerUTMPlayer(
- PEER peer,
- const gsi_char * nick,
- const gsi_char * command,
- const gsi_char * parameters,
- PEERBool authenticate );
| Routine | Required Header | Distribution |
|---|---|---|
| peerUTMPlayer | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- nick
- [in] Chat Nickname of the target player.
- 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 peerUTMRoom function may be used to send a UTM message to another player of the specified room.
As long as the nick is valid and matches up with a player, that player will get the message in a peerPlayerUTMCallback(). 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 while connected.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerUTMPlayer | peerUTMPlayerA | peerUTMPlayerW |
peerUTMPlayerW and peerUTMPlayerA are UNICODE and ANSI mapped versions of peerUTMPlayer. The arguments of peerUTMPlayerA are ANSI strings; those of peerUTMPlayerW are wide-character strings.
Section Reference: Gamespy Peer SDK
See Also: peerUTMRoom