peerRoomKeyChangedCallback
Called when a new value becomes available for a room watch key, or when a broadcast key changes.
- typedef void (*peerRoomKeyChangedCallback)(
- PEER peer,
- RoomType roomType,
- const gsi_char * nick,
- const gsi_char * key,
- const gsi_char * value,
- void * param );
Routine | Required Header | Distribution |
---|---|---|
peerRoomKeyChangedCallback | <peer.h> | SDKZIP |
Parameters
- peer
- [in] Initialized peer object
- roomType
- [in] Can be either TitleRoom, GroupRoom or StagingRoom.
- nick
- [in] The player's chat nickname whose keys changed
- key
- [in] The key that has changed
- value
- [in] The value that is associated with this key that has changed
- param
- [in] Pointer to user data. This is optional and will be passed unmodified to the callback function.
Remarks
The peerRoomKeyChangedCallback is called for watch keys when a room is joined, for watch keys when another player joins, for any newly set watch keys, and when a broadcast watch key is changed.
Unicode Mappings
Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
---|---|---|
peerRoomKeyChangedCallback | peerRoomKeyChangedCallbackA | peerRoomKeyChangedCallbackW |
peerRoomKeyChangedCallbackW and peerRoomKeyChangedCallbackA are UNICODE and ANSI mapped versions of peerRoomKeyChangedCallback. The arguments of peerRoomKeyChangedCallbackA are ANSI strings; those of peerRoomKeyChangedCallbackW are wide-character strings.
Section Reference: Gamespy Peer SDK