2263 lines
101 KiB
HTML
2263 lines
101 KiB
HTML
<HTML>
|
||
|
||
<HEAD>
|
||
<TITLE>Ubi.com GameService SDK</TITLE>
|
||
<LINK href="./gs-sdk-doc.css" rel="stylesheet" type="text/css">
|
||
</HEAD>
|
||
|
||
<BODY >
|
||
<!-- Generated by Doxygen 1.3.4 -->
|
||
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
|
||
<h1>Functions<br>
|
||
<small>
|
||
[<a class="el" href="group__group4.html">Lobby Service</a>]</small>
|
||
</h1>Messages sent to the lobby server.
|
||
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
|
||
<tr><td></td></tr>
|
||
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a0">Lobby_Engine</a> (GSuint uiMaxPostingDelay=500, GSuint uiMaxsOperationalDelay=800)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update connection status-messages handling relating to the lobby service. </em> <a href="#a0"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a1">LobbySend_Connect</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is deprecated. </em> <a href="#a1"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a2">LobbySend_Disconnect</a> (GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the lobby server. </em> <a href="#a2"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a3">LobbySend_DisconnectAll</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect from the lobby server. </em> <a href="#a3"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a4">LobbySend_Login</a> (const GSchar *szGames, GSbool bPublicIP=GS_TRUE, GSushort usPlayerStatus=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is used to log into the lobby service. </em> <a href="#a4"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a5">LobbySend_JoinLobby</a> (GSint iGroupID, GSint iLobbyServerID, const GSchar *szPassword, GSint iconfig=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Join a lobby. </em> <a href="#a5"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a6">LobbySend_JoinRoom</a> (GSint iGroupID, GSint iLobbyServerID, const GSchar *szPassword, GSbool bVisitor, const GSchar *szVersion, GSint iconfig=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Join a room. </em> <a href="#a6"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a7">LobbySend_LeaveGroup</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Leave a group. </em> <a href="#a7"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a8">LobbySend_CreateRoom</a> (GSint iParentGroupID, GSint iLobbyServerID, const GSchar *szRoomName, const GSchar *szGames, GSushort usRoomType, GSushort usMaxPlayers, GSushort usMaxVisitors, const GSvoid *vpData, GSint iSize, const GSvoid *vpAltGroupInfo, GSint iAltGroupInfoSize, const GSchar *szPassword, const GSchar *szGameVersion, const GSchar *szGSVersion)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a room. </em> <a href="#a8"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a9">LobbySend_StartMatch</a> (GSint iGroupID, GSint iLobbyServerID, GSuint uiMode=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that you are ready to start the match. </em> <a href="#a9"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a10">LobbySend_MatchFinish</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that you are finishing the match. </em> <a href="#a10"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a11">LobbySend_NewMaster</a> (GSint iGroupID, GSint iLobbyServerID, GSchar *szUsername)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that you are ready to start the match. </em> <a href="#a11"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a12">LobbySend_PlayerMatchStarted</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that a match is finished. </em> <a href="#a12"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a13">LobbySend_PlayerMatchFinished</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that a match is finished. </em> <a href="#a13"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a14">LobbySend_PlayerKick</a> (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName, GSchar *szReason)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that to kick a player. </em> <a href="#a14"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a15">LobbySend_GetParentGroupID</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server that to get a parent group id. </em> <a href="#a15"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a16">LobbySend_UpdateRoomConfig</a> (GSint iGroupID, GSint iLobbyServerID, GSbyte bDedicatedServer, GSbyte bOpen, GSbyte bScore_Submission, GSint iMaxPlayers, GSint iMaxVisitors, const GSchar *szPassword, const GSvoid *vpGroupInfo, GSint iGroupInfoSize, const GSvoid *vpAltGroupInfo, GSint iAltGroupInfoSize)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server to update room configuration flags. </em> <a href="#a16"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a17">LobbySend_GetGroupInfo</a> (GSint iGroupID, GSint iLobbyServerID, GSint iconfig)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get information about a group. </em> <a href="#a17"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a18">LobbySend_GetAlternateGroupInfo</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get information about a group. </em> <a href="#a18"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a19">LobbySend_InitMatchResults</a> (GSuint uiMatchID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the library score submission system. </em> <a href="#a19"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a20">LobbySend_SetMatchResult</a> (const GSchar *szUserName, GSuint uiFieldID, GSint iFieldValue)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set results for a player in a match. </em> <a href="#a20"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a21">LobbySend_SubmitMatchResult</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send the compiled scores of a match to the lobby server. </em> <a href="#a21"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a22">LobbySend_ClearMatchResult</a> ()</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unload the internal score submission system. </em> <a href="#a22"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a23">LobbySend_UpdatePing</a> (GSint iGroupID, GSint iLobbyServerID, GSushort usPing)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a new ping value to the server. </em> <a href="#a23"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a24">LobbySend_GameStart</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to inform the lobby server that the game is started. </em> <a href="#a24"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a25">LobbySend_GameConnected</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to inform the lobby server that you are connected. </em> <a href="#a25"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a26">LobbySend_GameFinish</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to inform the lobby server about the end of the game. </em> <a href="#a26"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a27">LobbySend_GameReady</a> (GSint iGroupID, GSint iLobbyServerID, GSvoid *vpGameData, GSint iSize, GSushort usPort=0, GSchar *szIPAddress=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a message to inform the lobby server about connection readiness. </em> <a href="#a27"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a28">LobbySend_UpdateGameInfo</a> (GSint iGroupID, GSint iLobbyServerID, GSvoid *vpGameData, GSint iSize, GSushort usPort=0, GSchar *szIPAddress=0)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the lobby server about new game information. </em> <a href="#a28"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a29">LobbySend_PlayerBan</a> (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName, GSchar *szReason)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ban a player from a group. </em> <a href="#a29"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a30">LobbySend_PlayerUnBan</a> (GSint iGroupID, GSint iLobbyServerID, GSchar *szUserName)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Un-Ban a player from a group. </em> <a href="#a30"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a31">LobbySend_GetPlayerBannedList</a> (GSint iGroupID, GSint iLobbyServerID)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get banned player list. </em> <a href="#a31"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a32">LobbySend_SetPlayerInfo</a> (GSvoid *vpPlayerInfo, GSint iPlayerInfoSize)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set player specific information. </em> <a href="#a32"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a33">LobbySend_GetPlayerGroups</a> (GSchar *szUsername)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set player specific information. </em> <a href="#a33"></a><em><br><br></td></tr>
|
||
<tr><td class="memItemLeft" nowrap align=right valign=top>GSbool </td><td class="memItemRight" valign=bottom><a class="el" href="group__group4__1.html#a34">LobbySend_ChangeRequestedLobbies</a> (const GSchar *szGames)</td></tr>
|
||
|
||
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is used to get a new list of available lobbies for a game. </em> <a href="#a34"></a><em><br><br></td></tr>
|
||
</table>
|
||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||
These function are used to send lobby related message to the server <hr><h2>Function Documentation</h2>
|
||
<a class="anchor" name="a0" doxytag="GSClientLibrary.h::Lobby_Engine" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool Lobby_Engine </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSuint </td>
|
||
<td class="mdname" nowrap> <em>uiMaxPostingDelay</em> = 500, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSuint </td>
|
||
<td class="mdname" nowrap> <em>uiMaxsOperationalDelay</em> = 800</td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Updates the connection between the client and the server, and handles the delivery of queued up messages and reception of messages relating to the lobby service. This function should be called regularly to ensure that the application will run smoothly.</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>The connection is ok and function call was a success. </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>There has been a communication problem.</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>uiMaxPostingDelay</em> </td><td>The maximum time to be spent inside the engine to read incomming messages and posting them to the message queue. (Milliseconds) </td></tr>
|
||
<tr><td valign=top><em>uiMaxsOperationalDelay</em> </td><td>The maximum time to be spent inside the engine to decode message in the queue and calling appropriate callback. (Milliseconds) </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a34" doxytag="GSClientLibrary.h::LobbySend_ChangeRequestedLobbies" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_ChangeRequestedLobbies </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>szGames</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to get a new list of available lobbies for a game The parameter szGame is used to narrow the list of groups received with only those who are running the game specified in the argument field. More than one game can be specify, each ugly game name must be separated by one of those character: | ; or ,</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a5">CBLobbyRcv_NewLobby</a> for every lobby supporting the new game name</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>szGames</em> </td><td>List of game separated by comma or pipe | character (can be empty) </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a22" doxytag="GSClientLibrary.h::LobbySend_ClearMatchResult" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_ClearMatchResult </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Unload the internal score submission system previously initialized for a specific match. Must be called after scores has been submitted to the lobby server.</dd></dl>
|
||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group4__1.html#a19">LobbySend_InitMatchResults()</a><br>
|
||
<a class="el" href="group__group4__2.html#a26">LobbyFix_SubmitMatchResultReply()</a><br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a1" doxytag="GSClientLibrary.h::LobbySend_Connect" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_Connect </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>You don't need to call this function anymore to open up a connection to a lobby server.</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>The connection is ok and function call was a success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>There has been a problem with the communication of messages between the client and the server </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a8" doxytag="GSClientLibrary.h::LobbySend_CreateRoom" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_CreateRoom </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iParentGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szRoomName</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szGames</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSushort </td>
|
||
<td class="mdname" nowrap> <em>usRoomType</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSushort </td>
|
||
<td class="mdname" nowrap> <em>usMaxPlayers</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSushort </td>
|
||
<td class="mdname" nowrap> <em>usMaxVisitors</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSvoid * </td>
|
||
<td class="mdname" nowrap> <em>vpData</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iSize</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSvoid * </td>
|
||
<td class="mdname" nowrap> <em>vpAltGroupInfo</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iAltGroupInfoSize</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szPassword</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szGameVersion</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szGSVersion</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Create a new room on the lobby server. After successfully creating the room you must join if before it shows up.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a3">CBLobbyRcv_CreateRoomReply<br></a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iParentGroupID</em> </td><td>ID of the parent group </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the room is created </td></tr>
|
||
<tr><td valign=top><em>szRoomName</em> </td><td>Name of the lobby </td></tr>
|
||
<tr><td valign=top><em>szGames</em> </td><td>Games played in the created lobby </td></tr>
|
||
<tr><td valign=top><em>usRoomType</em> </td><td>The type of the game that will be played in the room<br>
|
||
ROOM_CLIENTHOST: Should always be this for ingame clients. </td></tr>
|
||
<tr><td valign=top><em>usMaxPlayers</em> </td><td>Maximum number of player in the room </td></tr>
|
||
<tr><td valign=top><em>usMaxVisitors</em> </td><td>Maximum number of visitor in the room </td></tr>
|
||
<tr><td valign=top><em>vpData</em> </td><td>Group info. This can be any binary data the client wants. </td></tr>
|
||
<tr><td valign=top><em>iSize</em> </td><td>Size of the group info </td></tr>
|
||
<tr><td valign=top><em>vpAltGroupInfo</em> </td><td>Alternate Group Info. This can be any binary data the client wants. See <a class="el" href="group__group4__1.html#a18">LobbySend_GetAlternateGroupInfo()</a> </td></tr>
|
||
<tr><td valign=top><em>iAltGroupInfoSize</em> </td><td>Size of the alternate group info </td></tr>
|
||
<tr><td valign=top><em>szPassword</em> </td><td>Password to lock the lobby </td></tr>
|
||
<tr><td valign=top><em>szGameVersion</em> </td><td>Version of the game played in this room (information purpose only) </td></tr>
|
||
<tr><td valign=top><em>szGSVersion</em> </td><td>Version of the game played in this room given by ubi.com (gs-game version will be checked upon joining that room) </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a2" doxytag="GSClientLibrary.h::LobbySend_Disconnect" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_Disconnect </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>iLobbyServerID</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>This function will the player from a specific lobby server. After disconnecting from a lobby server, you will still receive Lobby-related messages if your are connected to another lobby server.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a9">CBLobbyRcv_GroupRemove</a> for every group on that Lobby Server<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a1">CBLobbyRcv_LobbyDisconnection</a> for every Lobby Server<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the lobby server you are disconnecting from. </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a3" doxytag="GSClientLibrary.h::LobbySend_DisconnectAll" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_DisconnectAll </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="mdname1" valign="top" nowrap> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Disconnect from all the Lobby servers. You will not receive anymore lobby-related messages after calling this function.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a9">CBLobbyRcv_GroupRemove</a> for every group<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a1">CBLobbyRcv_LobbyDisconnection</a> for every Lobby Server<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a2">CBLobbyRcv_LobbyDisconnectAll<br></a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a25" doxytag="GSClientLibrary.h::LobbySend_GameConnected" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GameConnected </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Inform the lobby server that you are connected to the game server.</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the game is taking place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a26" doxytag="GSClientLibrary.h::LobbySend_GameFinish" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GameFinish </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Inform the lobby server that the game you were playing is now finished</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a23">CBLobbyRcv_GroupConfigUpdate</a> to everyone in parent lobby<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a41">CBLobbyRcv_PlayerStatusUpdate</a> to everyone in parent lobby<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a38">CBLobbyRcv_InfoRefresh<br></a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the game is taking place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a27" doxytag="GSClientLibrary.h::LobbySend_GameReady" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GameReady </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSvoid * </td>
|
||
<td class="mdname" nowrap> <em>vpGameData</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iSize</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSushort </td>
|
||
<td class="mdname" nowrap> <em>usPort</em> = 0, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szIPAddress</em> = 0</td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Called by the master, this function inform the lobby server that the host is ready to accept connection. It will set the basic game data that will be distributed among other players.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a29">CBLobbyRcv_GameReadyReply<br></a> <a class="el" href="group__group__LobbyCB.html#a23">CBLobbyRcv_GroupConfigUpdate</a> to everyone in parent lobby<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a30">CBLobbyRcv_GameStarted</a> to everyone in room<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a41">CBLobbyRcv_PlayerStatusUpdate</a> to everyone in parent lobby<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the game is taking place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>vpGameData</em> </td><td>Specific game data (i.e. DirectPlay structure) </td></tr>
|
||
<tr><td valign=top><em>iSize</em> </td><td>The size of the game data. </td></tr>
|
||
<tr><td valign=top><em>usPort</em> </td><td>The port of the game server </td></tr>
|
||
<tr><td valign=top><em>szIPAddress</em> </td><td>IP address of the game server. </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a24" doxytag="GSClientLibrary.h::LobbySend_GameStart" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GameStart </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server that the host have started his game. This call should be followed by the <a class="el" href="group__group4__1.html#a27">LobbySend_GameReady()</a> function once the host is ready to accept connection.</dd></dl>
|
||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group4__1.html#a27">LobbySend_GameReady()</a><br>
|
||
<a class="el" href="group__group4__2.html#a28">LobbyFix_GameStartReply()</a><br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a28">CBLobbyRcv_StartGameReply<br></a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the game is taking place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a18" doxytag="GSClientLibrary.h::LobbySend_GetAlternateGroupInfo" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GetAlternateGroupInfo </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Get the alternate information about a group.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a21">CBLobbyRcv_GetAlternateGroupInfoReply</a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call.</dd></dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the player is in. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located. </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a17" doxytag="GSClientLibrary.h::LobbySend_GetGroupInfo" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GetGroupInfo </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iconfig</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Get information about a group</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a6">CBLobbyRcv_RoomInfo</a> if LSM_GROUPINFO is set.<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a12">CBLobbyRcv_MemberJoined</a> if LSM_GROUPMEMBERS is set.<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a4">CBLobbyRcv_NewRoom</a> if LSM_CHILDGROUPINFO is set.<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the player is in </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>iconfig</em> </td><td>Flag of information you want to receive about the group LSM_GROUPINFO to receive information about the group. LSM_CHILDGROUPINFO to receive information about child group LSM_GROUPMEMBERS to receive list of player member of the specified group LSM_ALLINFO for all previous flags </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a15" doxytag="GSClientLibrary.h::LobbySend_GetParentGroupID" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GetParentGroupID </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Query the lobby server to get the parent group id of a group.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a20">CBLobbyRcv_ParentGroupIDReply</a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The ID of the group we want to get info from. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a31" doxytag="GSClientLibrary.h::LobbySend_GetPlayerBannedList" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GetPlayerBannedList </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Ask the lobby server about all banned players for a specific group.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a35">CBLobbyRcv_PlayerBanList<br></a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the game is taking place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a33" doxytag="GSClientLibrary.h::LobbySend_GetPlayerGroups" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_GetPlayerGroups </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSchar * </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>szUsername</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Get the groups that a player is member of</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a42">CBLobbyRcv_PlayerGroupList</a> for every group the player is in.<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>szUsername</em> </td><td>The username of the player we want to get info from </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a19" doxytag="GSClientLibrary.h::LobbySend_InitMatchResults" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_InitMatchResults </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSuint </td>
|
||
<td class="mdname1" valign="top" nowrap> <em>uiMatchID</em> </td>
|
||
<td class="md" valign="top"> ) </td>
|
||
<td class="md" nowrap></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Initialize the library score submission system, this has to be called before doing any other score submission-related function call. Note that you must initialize the score submission system prior to any match that will be submitted. This should be call after receiving the MatchStarted message, and the scores should be cleared after being submitted to the lobby server with LobbySend_SubmitMatchResult. </dd></dl>
|
||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group4__1.html#a9">LobbySend_StartMatch()</a><br>
|
||
<a class="el" href="group__group4__1.html#a21">LobbySend_SubmitMatchResult()</a><br>
|
||
<a class="el" href="group__group4__1.html#a22">LobbySend_ClearMatchResult()</a><br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>uiMatchID</em> </td><td>The match unique id as returned by CBLobbyRcv_MatchStarted </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a5" doxytag="GSClientLibrary.h::LobbySend_JoinLobby" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_JoinLobby </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szPassword</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iconfig</em> = 0</td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Join a lobby on the lobby server.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a11">CBLobbyRcv_JoinLobbyReply</a> <a class="el" href="group__group__LobbyCB.html#a7">CBLobbyRcv_LobbyInfo</a> if LSM_GROUPINFO is set<br>
|
||
::LobbyRcv_NewRoom if LSM_CHILDGROUPINFO is set<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a12">CBLobbyRcv_MemberJoined</a> if LSM_GROUPMEMBERS is set<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the lobby to join </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>szPassword</em> </td><td>Password to join lobby if needed </td></tr>
|
||
<tr><td valign=top><em>iconfig</em> </td><td>Flag of information you want to receive when joining lobby LSM_GROUPINFO to receive information about joined lobby LSM_CHILDGROUPINFO to receive information about child group of the joined lobby LSM_GROUPMEMBERS to receive list of player member of joined lobby LSM_ALLINFO for all previous flags </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a6" doxytag="GSClientLibrary.h::LobbySend_JoinRoom" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_JoinRoom </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szPassword</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSbool </td>
|
||
<td class="mdname" nowrap> <em>bVisitor</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szVersion</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iconfig</em> = 0</td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Join a room on the lobby server.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a10">CBLobbyRcv_JoinRoomReply<br></a> <a class="el" href="group__group__LobbyCB.html#a6">CBLobbyRcv_RoomInfo</a> if LSM_GROUPINFO is set.<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a12">CBLobbyRcv_MemberJoined</a> for every player in the room if LSM_GROUPMEMBERS is set.<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the room to join </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>szPassword</em> </td><td>Password to join room if needed </td></tr>
|
||
<tr><td valign=top><em>bVisitor</em> </td><td>Join as visitor if true, join as player if false </td></tr>
|
||
<tr><td valign=top><em>szVersion</em> </td><td>The version of the game played in the room </td></tr>
|
||
<tr><td valign=top><em>iconfig</em> </td><td>Flag of information you want to receive when joining lobby: LSM_GROUPINFO to receive information about the joined room LSM_GROUPMEMBERS to receive list of player member of joined room </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a7" doxytag="GSClientLibrary.h::LobbySend_LeaveGroup" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_LeaveGroup </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to leave a room or lobby.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a13">CBLobbyRcv_MemberLeave</a> for yourself.<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a22">CBLobbyRcv_GroupLeaveReply<br></a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the player want to leave </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a4" doxytag="GSClientLibrary.h::LobbySend_Login" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_Login </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szGames</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSbool </td>
|
||
<td class="mdname" nowrap> <em>bPublicIP</em> = GS_TRUE, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSushort </td>
|
||
<td class="mdname" nowrap> <em>usPlayerStatus</em> = 0</td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>This function is used to log into the lobby service. On logging to that service, the user will receive a list of all the groups on the lobby server. The parameter szGame is used to narrow the list of groups received with only those who are running the game specified in the argument field. More than one game can be specify, each ugly game name must be separated by one of those character: | ; or ,</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a0">CBLobbyRcv_LoginReply<br></a> <a class="el" href="group__group__LobbyCB.html#a5">CBLobbyRcv_NewLobby</a> for every lobby that supports the game names in szGames<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>szGames</em> </td><td>List of game separated by comma or pipe | character (can be empty) </td></tr>
|
||
<tr><td valign=top><em>bPublicIP</em> </td><td>If this flag is enabled, the ip address will be sent to players in your along with others player infos, if not your ip will not be sent to other players, thus preventing them to ping you. </td></tr>
|
||
<tr><td valign=top><em>usPlayerStatus</em> </td><td>Set the player's status flag as define in LobbyDefine.h </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a10" doxytag="GSClientLibrary.h::LobbySend_MatchFinish" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_MatchFinish </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server that you want to stop the match. Be sure before sending that Message than other players have finished there match be cause they will no longer be able to submit there scores to the lobby server.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a17">CBLobbyRcv_MatchFinishReply</a> <a class="el" href="group__group__LobbyCB.html#a41">CBLobbyRcv_PlayerStatusUpdate</a> is sent to everyone in the parent group for everyone in the room.<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a25">CBLobbyRcv_UpdateRoomConfigReply</a> is sent to everyone in the parent group<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the match will be in. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a11" doxytag="GSClientLibrary.h::LobbySend_NewMaster" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_NewMaster </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szUsername</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server to change the master for the specified group.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a16">CBLobbyRcv_MasterNewReply<br></a> <a class="el" href="group__group__LobbyCB.html#a15">CBLobbyRcv_MasterChanged</a> is sent to everyone in the parent lobby.</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the match will be in. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>szUsername</em> </td><td>The Username of the new master in the group. </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a29" doxytag="GSClientLibrary.h::LobbySend_PlayerBan" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_PlayerBan </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szUserName</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szReason</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server to ban a player from a lobby or room. The player won't be able to joined a group from which he was banned, it will also be impossible to join any child group of the banned group.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a13">CBLobbyRcv_MemberLeave</a> to all players for the player that was banned<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a33">CBLobbyRcv_PlayerBanReply<br></a> <a class="el" href="group__group__LobbyCB.html#a36">CBLobbyRcv_PlayerBanned</a> is sent to the banned player<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the game is taking place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>szUserName</em> </td><td>Username of the player that has to be banned. </td></tr>
|
||
<tr><td valign=top><em>szReason</em> </td><td>The reason the player was banned. </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a14" doxytag="GSClientLibrary.h::LobbySend_PlayerKick" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_PlayerKick </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szUserName</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szReason</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server to kick a player out of a specified group (must be master of that group)</dd></dl>
|
||
/par Callbacks: <a class="el" href="group__group__LobbyCB.html#a13">CBLobbyRcv_MemberLeave</a> to all players in parent lobby<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a41">CBLobbyRcv_PlayerStatusUpdate</a> to all players in parent lobby<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a18">CBLobbyRcv_PlayerKickReply<br></a> <a class="el" href="group__group__LobbyCB.html#a19">CBLobbyRcv_KickOut</a> to the kicked player<br>
|
||
<p>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the match will be in. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>szUserName</em> </td><td>The username of the player to kick. </td></tr>
|
||
<tr><td valign=top><em>szReason</em> </td><td>The reason the given to the kicked player for this action. </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a13" doxytag="GSClientLibrary.h::LobbySend_PlayerMatchFinished" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_PlayerMatchFinished </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server that the match you were playing as ended Everyone in the room has to call this function to confirm the end of the match.</dd></dl>
|
||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group4__1.html#a9">LobbySend_StartMatch()</a><br>
|
||
<a class="el" href="group__group4__1.html#a12">LobbySend_PlayerMatchStarted()</a><br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a41">CBLobbyRcv_PlayerStatusUpdate</a> is sent to everyone in the parent group for everyone in the room.<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the match will be in. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a12" doxytag="GSClientLibrary.h::LobbySend_PlayerMatchStarted" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_PlayerMatchStarted </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server that the match you were playing as started Everyone in the room has to call this function to confirm the start of the match</dd></dl>
|
||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group4__1.html#a9">LobbySend_StartMatch()</a><br>
|
||
<a class="el" href="group__group4__1.html#a13">LobbySend_PlayerMatchFinished()</a><br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd>None</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the match will be in. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a30" doxytag="GSClientLibrary.h::LobbySend_PlayerUnBan" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_PlayerUnBan </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szUserName</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server to un-ban a player that was previously banned from a lobby or room.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a34">CBLobbyRcv_PlayerUnBanReply<br></a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the game is taking place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>szUserName</em> </td><td>Username of the player that has to be banned. </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a20" doxytag="GSClientLibrary.h::LobbySend_SetMatchResult" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_SetMatchResult </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szUserName</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSuint </td>
|
||
<td class="mdname" nowrap> <em>uiFieldID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iFieldValue</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Set the result for a player in a match in the library's score submission system. Each player should set the result for each other player that where in the match including himself. This will insure validity of scores submitted to the LobbyServer.</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>szUserName</em> </td><td>The username of the player associated with the results </td></tr>
|
||
<tr><td valign=top><em>uiFieldID</em> </td><td>The result field id </td></tr>
|
||
<tr><td valign=top><em>iFieldValue</em> </td><td>The actual value that will be set for the specified field </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a32" doxytag="GSClientLibrary.h::LobbySend_SetPlayerInfo" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_SetPlayerInfo </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSvoid * </td>
|
||
<td class="mdname" nowrap> <em>vpPlayerInfo</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iPlayerInfoSize</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Set player specific information stored on the server</dd></dl>
|
||
<dl compact><dt><b>Callback:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a39">CBLobbyRcv_SetPlayerInfoReply<br></a> <a class="el" href="group__group__LobbyCB.html#a40">CBLobbyRcv_PlayerInfoUpdate</a> is sent to all players<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>vpPlayerInfo</em> </td><td>Pointer to player info data buffer </td></tr>
|
||
<tr><td valign=top><em>iPlayerInfoSize</em> </td><td>of the player info data buffer </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a9" doxytag="GSClientLibrary.h::LobbySend_StartMatch" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_StartMatch </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSuint </td>
|
||
<td class="mdname" nowrap> <em>uiMode</em> = 0</td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server that you are ready to start the match: the message will be passed allong the member of the room and the match will start.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a14">CBLobbyRcv_StartMatchReply<br></a> <a class="el" href="group__group__LobbyCB.html#a24">CBLobbyRcv_MatchStarted</a> is sent to everyone in the room<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a25">CBLobbyRcv_UpdateRoomConfigReply</a> is sent to everyone in the parent group<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a41">CBLobbyRcv_PlayerStatusUpdate</a> is sent to everyone in the parent group for everyone in the room.<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>uiMode</em> </td><td>The mode of the Match </td></tr>
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the match will be in. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a21" doxytag="GSClientLibrary.h::LobbySend_SubmitMatchResult" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_SubmitMatchResult </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Send the compiled scores of a match to the lobby server for archiving, this will send a message to the lobby server and set the match result on the server-side. You will receive a confirmation of the message sent with the CBLobbyRcv_SubmitMatchResult callback.</dd></dl>
|
||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group4__2.html#a26">LobbyFix_SubmitMatchResultReply()</a></dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a26">CBLobbyRcv_SubmitMatchResultReply</a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the match took place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a28" doxytag="GSClientLibrary.h::LobbySend_UpdateGameInfo" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_UpdateGameInfo </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSvoid * </td>
|
||
<td class="mdname" nowrap> <em>vpGameData</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iSize</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSushort </td>
|
||
<td class="mdname" nowrap> <em>usPort</em> = 0, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szIPAddress</em> = 0</td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server about new game information; this is mostly used in the host migration process, the player becoming the new master can send new game data to the lobby server which will then redistribute this data among the other players.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a32">CBLobbyRcv_UpdateGameInfoReply<br></a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group where the game is taking place. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>vpGameData</em> </td><td>Specific game data (i.e. DirectPlay structure) </td></tr>
|
||
<tr><td valign=top><em>iSize</em> </td><td>The size of the game data. </td></tr>
|
||
<tr><td valign=top><em>usPort</em> </td><td>The port of the game server </td></tr>
|
||
<tr><td valign=top><em>szIPAddress</em> </td><td>IP address of the game server. </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a23" doxytag="GSClientLibrary.h::LobbySend_UpdatePing" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_UpdatePing </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSushort </td>
|
||
<td class="mdname" nowrap> <em>usPing</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Update the ping value for a player. When the client ping the host of a game server, he can tell his ping to the other players by calling this functions which will update his ping value on the server. The server will then forward this information to the other players.</dd></dl>
|
||
<dl compact><dt><b>Related Function:</b></dt><dd><a class="el" href="group__group4__2.html#a27">LobbyFix_UpdatePing()</a></dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the group the player is in </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>usPing</em> </td><td>The new ping of the player </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<a class="anchor" name="a16" doxytag="GSClientLibrary.h::LobbySend_UpdateRoomConfig" ></a><p>
|
||
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
||
<tr>
|
||
<td class="mdRow">
|
||
<table cellpadding="0" cellspacing="0" border="0">
|
||
<tr>
|
||
<td class="md" nowrap valign="top"> GSbool LobbySend_UpdateRoomConfig </td>
|
||
<td class="md" valign="top">( </td>
|
||
<td class="md" nowrap valign="top">GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iLobbyServerID</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSbyte </td>
|
||
<td class="mdname" nowrap> <em>bDedicatedServer</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSbyte </td>
|
||
<td class="mdname" nowrap> <em>bOpen</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSbyte </td>
|
||
<td class="mdname" nowrap> <em>bScore_Submission</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iMaxPlayers</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iMaxVisitors</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSchar * </td>
|
||
<td class="mdname" nowrap> <em>szPassword</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSvoid * </td>
|
||
<td class="mdname" nowrap> <em>vpGroupInfo</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iGroupInfoSize</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>const GSvoid * </td>
|
||
<td class="mdname" nowrap> <em>vpAltGroupInfo</em>, </td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td></td>
|
||
<td class="md" nowrap>GSint </td>
|
||
<td class="mdname" nowrap> <em>iAltGroupInfoSize</em></td>
|
||
</tr>
|
||
<tr>
|
||
<td></td>
|
||
<td class="md">) </td>
|
||
<td class="md" colspan="2"></td>
|
||
</tr>
|
||
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<table cellspacing=5 cellpadding=0 border=0>
|
||
<tr>
|
||
<td>
|
||
|
||
</td>
|
||
<td>
|
||
|
||
<p>
|
||
<dl compact><dt><b>Description:</b></dt><dd>Tell the lobby server to update a specific room configuration flags (Must be master). Each of those argument can be set to -1 (in case of numeric) or NULL (in case of a GSchar*) if the argument as not changed.</dd></dl>
|
||
<dl compact><dt><b>Callbacks:</b></dt><dd><a class="el" href="group__group__LobbyCB.html#a25">CBLobbyRcv_UpdateRoomConfigReply<br></a> <a class="el" href="group__group__LobbyCB.html#a23">CBLobbyRcv_GroupConfigUpdate</a> to everyone in the parent lobby if the config flags changed.<br>
|
||
<a class="el" href="group__group__LobbyCB.html#a6">CBLobbyRcv_RoomInfo</a> if the other settings changed.<br>
|
||
</dd></dl>
|
||
<dl compact><dt><b>Returns:</b></dt><dd>Status of the function call</dd></dl>
|
||
<dl compact><dt><b>Return values:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>GS_TRUE</em> </td><td>Success </td></tr>
|
||
<tr><td valign=top><em>GS_FALSE</em> </td><td>Failure</td></tr>
|
||
</table>
|
||
</dl>
|
||
<dl compact><dt><b>Parameters:</b></dt><dd>
|
||
<table border="0" cellspacing="2" cellpadding="0">
|
||
<tr><td valign=top><em>iGroupID</em> </td><td>The id of the room we want to modify. </td></tr>
|
||
<tr><td valign=top><em>iLobbyServerID</em> </td><td>The id of the server on which the specified group is located </td></tr>
|
||
<tr><td valign=top><em>bDedicatedServer</em> </td><td>Set the Dedicated Server flag on the group Default Value: -1 </td></tr>
|
||
<tr><td valign=top><em>bOpen</em> </td><td>Set the open or close flag on the group Default Value: -1 </td></tr>
|
||
<tr><td valign=top><em>bScore_Submission</em> </td><td>Set the score submission flag on the group Default Value: -1 </td></tr>
|
||
<tr><td valign=top><em>iMaxPlayers</em> </td><td>The maximum number of player Default Value: -1 </td></tr>
|
||
<tr><td valign=top><em>iMaxVisitors</em> </td><td>The maximum number of visitors Default Value: -1 </td></tr>
|
||
<tr><td valign=top><em>szPassword</em> </td><td>The password to enter the group (PASSWORDLENGTH) Default Value: NULL </td></tr>
|
||
<tr><td valign=top><em>vpGroupInfo</em> </td><td>The group data Default Value: NULL </td></tr>
|
||
<tr><td valign=top><em>iGroupInfoSize</em> </td><td>The group data size Default Value: -1 </td></tr>
|
||
<tr><td valign=top><em>vpAltGroupInfo</em> </td><td>The alternate group info Default Value: NULL </td></tr>
|
||
<tr><td valign=top><em>iAltGroupInfoSize</em> </td><td>The alternate group info buffer size Default Value: -1 </td></tr>
|
||
</table>
|
||
</dl>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<hr>
|
||
<p align="right">
|
||
<i>Ubi.com GameService SDK - ©UbiSoft Entertainment 2002 </i><br>
|
||
<i><a href="mailto:gsdevteam@ubisoft.com">GameService development team</a></i>
|
||
</p>
|
||
</body>
|
||
</html>
|