Peer SDK Functions
| peerAlwaysGetPlayerInfo | Tell the peer SDK to always retrieve IP and profile information for room members. |
| peerAreAllReady | Used to check if all players in the staging room are ready. |
| peerAuthenticateCDKey | Allows pre-chat cd key authentication via the chat server. |
| peerChangeNick | Change the chat nickname associated with the local client. This does not affect the account name. |
| peerClearTitle | Resets the peer SDK. peerSetTitle must be called before new operations are made. |
| peerConnect | Connect to the chat server. |
| peerConnectLogin | Connects a peer object to the backend chat server and then logs in using an account from the GameSpy Presence system. A title must be set with peerSetTitle() before this function is called. |
| peerConnectPreAuth | Connects a peer object to the backend chat server and then logs in using authentication information from a parter authentication system. |
| peerCreateStagingRoom | Creates a new staging room with the local player as the host. |
| peerCreateStagingRoomWithSocket | Creates a new staging room with the local player as the host. |
| peerDisconnect | Disconnect from the chat server. peerShutdown must still be called. |
| peerEnumPlayers | Enumerates through the players in a room. |
| peerFixNick | Repairs an illegal chat nickname. Removes illegal characters from a nickname as well as invalid character combinations. |
| peerGetAutoMatchStatus | Used when automatching to retrieve the current status. |
| peerGetChat | Returns the chat sdk object. |
| peerGetGlobalWatchKey | Returns the cached value of a players watch key. |
| peerGetGroupID | Returns the current group ID set from peerJoinGroupRoom or peerSetGroupID. |
| peerGetHostServer | Returns the SBServer object associated with the staging room host. |
| peerGetNick | Returns the chat nickname of the local client. |
| peerGetPlayerFlags | Returns the cached flag values for the current player. This is from the key "b_flags". |
| peerGetPlayerGlobalKeys | Query the server for a player’s global key values. |
| peerGetPlayerInfo | Retrieve a local player's IP and profile ID. |
| peerGetPlayerInfoNoWait | Retrieve a players IP and profile ID. Uses a cached copy. |
| peerGetPlayerPing | Returns the cached ping between the local player and the specified remote player. |
| peerGetPlayersCrossPing | Calculates the cross-ping between 2 players. |
| peerGetPrivateIP | Returns the local private IP address. |
| peerGetProfileID | Returns the profile ID of the local client. Only valid with peerConnectLogin or peerConnectPreAuth. |
| peerGetPublicIP | Returns the local public IP address. |
| peerGetReady | Get the ready state of the specified player. |
| peerGetRoomChannel | Returns the chat channel associated with the room type. |
| peerGetRoomGlobalKeys | Retrieves global keys for all players in the specified room. (Local client must be a room member.) |
| peerGetRoomKeys | Retrieves room key values for the room or a single player. |
| peerGetRoomName | Returns the channel’s title. The local client must be a member of the room. |
| peerGetTitle | Gets the currently set title |
| peerGetUserID | Returns the local userID. Only valid with peerConnectLogin or peerConnectPreAuth. |
| peerInitialize | Initialize the peer SDK. |
| peerInRoom | Determines if the local client is in a room of the specified type. |
| peerIsAutoMatching | Returns PEERTrue if an AutoMatch is in progress. |
| peerIsConnected | Returns PEERTrue if connected to the chat server. |
| peerIsPlayerHost | Returns PEERTrue if specified player is a room host or operator. |
| peerIsPlaying | Returns PEERTrue if the local client is playing. |
| peerJoinGroupRoom | Join the specified group room. |
| peerJoinStagingRoom | Joins a specified game staging room. Allows players to get together and chat while setting up a game. Players can also see other players’ pings and crosspings. |
| peerJoinStagingRoomByChannel | Join a staging room using the channel name. |
| peerJoinTitleRoom | Join the title room for the local client’s game application. |
| peerKickPlayer | Kick a player from a room. |
| peerLeaveRoom | Remove the local client from a room. |
| peerListGroupRooms | List all the group rooms for the currently set title. |
| peerMessagePlayer | Send a message to the specified player. |
| peerMessageRoom | Send a message to the specified room |
| peerParseQuery | Pass a manually received server query to the peer SDK. Use with peerStartReportingWithSocket or peerCreateStagingRoomWithSocket. |
| peerPingPlayer | Send a ping request to a remote player. |
| peerRegisterUniqueNick | Register a unique nick. Call in response to peerNickErrorCallback. |
| peerRetryWithNick | Use in response to a nickErrorCallback. This function allows the local client to retry the connection attempt with a different chat nickname. |
| peerSendNatNegotiateCookie | Send a nat negotiation cookie to a server. |
| peerSetAwayMode | Set the away mode, as it appears in chat. |
| peerSetGlobalKeys | Set global keys on the local player. |
| peerSetGlobalWatchKeys | Set the global watch keys for the specified room type. |
| peerSetGroupID | Manually set the group ID. Use with caution as this is normally set automatically. |
| peerSetPassword | Set the password on the chat room. Local client must be the host. |
| peerSetQuietMode | Sets the peer sdk to quiet mode or disables quiet mode. See remarks. |
| peerSetReady | Set the local clients ready state. |
| peerSetRoomKeys | Set room keys for a player or the room itself. |
| peerSetRoomName | Set the name of a room. Local client must be the host. |
| peerSetStagingRoomMaxPlayers | Update the maximum number of players for a staging room. Local client must be the host. |
| peerSetTitle | Set the game information to be used by the peer sdk. |
| peerSetTitleRoomChannel | Set the channel to be used as the TitleRoom. (Rarely used, SDK sets title room automatically.) |
| peerShutdown | Destructs the peer SDK. |
| peerStartAutoMatch | Start an automatch attempt. |
| peerStartAutoMatchWithSocket | Start an automatch attempt using an external managed socket. |
| peerStartGame | Called by the host to begin the game. |
| peerStartListingGames | Begin listing the currently running games and staging rooms. |
| peerStartPlaying | Flag the local player as "playing". Use this to manual set the player’s flag in the event a non peer sdk game is started. |
| peerStartReporting | Begins server reporting, does not create a staging room. |
| peerStartReportingWithSocket | Begin server reporting using an externally managed socket. |
| peerStateChanged | Notify the backend of a server state change, such as the server becoming full. |
| peerStayInRoom | Allows SDK to remain in the title room after peerClearTitle. (Rarely used.) |
| peerStopAutoMatch | Stop an automatch attempt in progress. |
| peerStopGame | Called by the host when the game has ended. |
| peerStopListingGames | Stops a server list update in progress. Also stops listening for game state changed messages. |
| peerThink | Allow the Peer SDK to continue processing. Callbacks will be triggered during this call. |
| peerTranslateNick | Removes the namespace extension from a nickname. Use this when working with unique nicknames in a public chat room. |
| peerUpdateGame | Send an update query to the specified server. |
| peerUpdateGameByMaster | This function updates a server via the master server. Passing in true for fullUpdate will obtain the full keys for that server, otherwise it will only obtain the basic keys. |
| peerUTMPlayer | Send a UTM message to the specified client. |
| peerUTMRoom | Send a UTM message to each client in the room. |