peerKickPlayer
Kick a player from a room.
- void peerKickPlayer(
- PEER peer,
- RoomType roomType,
- const gsi_char * nick,
- const gsi_char * reason );
| Routine | Required Header | Distribution |
|---|---|---|
| peerKickPlayer | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object.
- roomType
- [in] Can be either TitleRoom, GroupRoom or StagingRoom.
- nick
- [in] Nickname of the client to kick.
- reason
- [in] Optional explanation string to be sent to the target client.
Remarks
The peerKickPlayer function will kick a specifed player from the room. Only players that have operator or host ability will be able to kick players. A player can be kicked by the operator with or without reason. An player that does not exist cannot be kicked. If the player does not exist in this room, then no one will be kicked.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| peerKickPlayer | peerKickPlayerA | peerKickPlayerW |
peerKickPlayerW and peerKickPlayerA are UNICODE and ANSI mapped versions of peerKickPlayer. The arguments of peerKickPlayerA are ANSI strings; those of peerKickPlayerW are wide-character strings.
Section Reference: Gamespy Peer SDK