edg-l/ddnet
1
0
Fork 0
mirror of https://github.com/ddnet/ddnet.git synced 2024-09-21 01:54:19 +00:00
Code Issues Packages Projects Releases Wiki Activity
ddnet/docs/output/files2/e_if_client-h.html

127 lines
56 KiB
HTML
Raw Normal View History

added documentation
2008-08-05 21:37:33 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><title>Client Interface</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CSection"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="Client_Interface"></a>Client Interface</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#Client_Interface" >Client Interface</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#Client_States" >Client States</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#Image_Formats" >Image Formats</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#Texture_Loading_Flags" >Texture Loading Flags</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#Server_Browser_Sorting" >Server Browser Sorting</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#Structures" >Structures</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#SERVER_INFO_PLAYER" >SERVER_INFO_PLAYER</a></td><td class=SDescription></td></tr><tr class="SClass"><td class=SEntry><a href="#SERVER_INFO" >SERVER_INFO</a></td><td class=SDescription></td></tr><tr class="SSection"><td class=SEntry><a href="#Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Time" >Time</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#client_tick" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">client_tick</a></td><td class=SDescription>Returns the tick of the current snapshot.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#client_intratick" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">client_intratick</a></td><td class=SDescription>Returns the current intratick.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#client_predtick" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">client_predtick</a></td><td class=SDescription>Returns the current predicted tick.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#client_predintratick" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">client_predintratick</a></td><td class=SDescription>Returns the current preticted intra tick.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#client_ticktime" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">client_ticktime</a></td><td class=SDescription>TODO</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#client_tickspeed" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">client_tickspeed</a></td><td class=SDescription>Returns how many ticks per second the client is doing.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#client_frametime" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">client_frametime</a></td><td class=SDescription>Returns how long time the last frame took to process.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#client_localtime" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">client_localtime</a></td><td class=SDescription>Returns the clients local time.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Server_Browser" >Server Browser</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#client_serverbrowse_refresh" id=link9 onMouseOver="ShowTip(event,
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="Constants"></a>Constants</h2><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent1 SMarked"><td class=SEntry><a href="#Client_States" >Client States</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent1"><td class=SEntry><a href="#Image_Formats" >Image Formats</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent1 SMarked"><td class=SEntry><a href="#Texture_Loading_Flags" >Texture Loading Flags</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent1"><td class=SEntry><a href="#Server_Browser_Sorting" >Server Browser Sorting</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Constants"></a>Constants</h3></div></div>
<div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="Client_States"></a>Client States</h3><div class=CBody><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry><a name="CLIENTSTATE_OFFLINE"></a>CLIENTSTATE_OFFLINE</td><td class=CDLDescription>The client is offline.</td></tr><tr><td class=CDLEntry><a name="CLIENTSTATE_CONNECTING"></a>CLIENTSTATE_CONNECTING</td><td class=CDLDescription>The client is trying to connect to a server.</td></tr><tr><td class=CDLEntry><a name="CLIENTSTATE_LOADING"></a>CLIENTSTATE_LOADING</td><td class=CDLDescription>The client has connected to a server and is loading resources.</td></tr><tr><td class=CDLEntry><a name="CLIENTSTATE_ONLINE"></a>CLIENTSTATE_ONLINE</td><td class=CDLDescription>The client is connected to a server and running the game.</td></tr><tr><td class=CDLEntry><a name="CLIENTSTATE_QUITING"></a>CLIENTSTATE_QUITING</td><td class=CDLDescription>The client is quiting.</td></tr></table></div></div></div>
<div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="Image_Formats"></a>Image Formats</h3><div class=CBody><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry><a name="IMG_AUTO"></a>IMG_AUTO</td><td class=CDLDescription>Lets the engine choose the format.</td></tr><tr><td class=CDLEntry><a name="IMG_RGB"></a>IMG_RGB</td><td class=CDLDescription>8-Bit uncompressed RGB</td></tr><tr><td class=CDLEntry><a name="IMG_RGBA"></a>IMG_RGBA</td><td class=CDLDescription>8-Bit uncompressed RGBA</td></tr><tr><td class=CDLEntry><a name="IMG_ALPHA"></a>IMG_ALPHA</td><td class=CDLDescription>8-Bit uncompressed alpha</td></tr></table></div></div></div>
<div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="Texture_Loading_Flags"></a>Texture Loading Flags</h3><div class=CBody><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry><a name="TEXLOAD_NORESAMPLE"></a>TEXLOAD_NORESAMPLE</td><td class=CDLDescription>Prevents the texture from any resampling</td></tr></table></div></div></div>
<div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="Server_Browser_Sorting"></a>Server Browser Sorting</h3><div class=CBody><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry><a name="BROWSESORT_NAME"></a>BROWSESORT_NAME</td><td class=CDLDescription>Sort by name.</td></tr><tr><td class=CDLEntry><a name="BROWSESORT_PING"></a>BROWSESORT_PING</td><td class=CDLDescription>Sort by ping.</td></tr><tr><td class=CDLEntry><a name="BROWSESORT_MAP"></a>BROWSESORT_MAP</td><td class=CDLDescription>Sort by map</td></tr><tr><td class=CDLEntry><a name="BROWSESORT_GAMETYPE"></a>BROWSESORT_GAMETYPE</td><td class=CDLDescription>Sort by game type.&nbsp; DM, TDM etc.</td></tr><tr><td class=CDLEntry><a name="BROWSESORT_PROGRESSION"></a>BROWSESORT_PROGRESSION</td><td class=CDLDescription>Sort by progression.</td></tr><tr><td class=CDLEntry><a name="BROWSESORT_NUMPLAYERS"></a>BROWSESORT_NUMPLAYERS</td><td class=CDLDescription>Sort after how many players there are on the server.</td></tr></table></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="Structures"></a>Structures</h2><div class=CBody></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="SERVER_INFO_PLAYER"></a>SERVER_INFO_PLAYER</h2><div class=CBody></div></div></div>
<div class="CClass"><div class=CTopic><h2 class=CTitle><a name="SERVER_INFO"></a>SERVER_INFO</h2><div class=CBody></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="Functions"></a>Functions</h2><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Time" >Time</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#client_tick" id=link31 onMouseOver="ShowTip(event, 'tt1', 'link31')" onMouseOut="HideTip('tt1')">client_tick</a></td><td class=SDescription>Returns the tick of the current snapshot.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#client_intratick" id=link32 onMouseOver="ShowTip(event, 'tt2', 'link32')" onMouseOut="HideTip('tt2')">client_intratick</a></td><td class=SDescription>Returns the current intratick.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#client_predtick" id=link33 onMouseOver="ShowTip(event, 'tt3', 'link33')" onMouseOut="HideTip('tt3')">client_predtick</a></td><td class=SDescription>Returns the current predicted tick.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#client_predintratick" id=link34 onMouseOver="ShowTip(event, 'tt4', 'link34')" onMouseOut="HideTip('tt4')">client_predintratick</a></td><td class=SDescription>Returns the current preticted intra tick.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#client_ticktime" id=link35 onMouseOver="ShowTip(event, 'tt5', 'link35')" onMouseOut="HideTip('tt5')">client_ticktime</a></td><td class=SDescription>TODO</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#client_tickspeed" id=link36 onMouseOver="ShowTip(event, 'tt6', 'link36')" onMouseOut="HideTip('tt6')">client_tickspeed</a></td><td class=SDescription>Returns how many ticks per second the client is doing.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#client_frametime" id=link37 onMouseOver="ShowTip(event, 'tt7', 'link37')" onMouseOut="HideTip('tt7')">client_frametime</a></td><td class=SDescription>Returns how long time the last frame took to process.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#client_localtime" id=link38 onMouseOver="ShowTip(event, 'tt8', 'link38')" onMouseOut="HideTip('tt8')">client_localtime</a></td><td class=SDescription>Returns the clients local time.</td></tr><tr class="SGroup"><td class=SEntry><a href="#Server_Browser" >Server Browser</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#client_serverbrowse_refresh" id=link39 onMouseOver="ShowTip(event, 'tt9', 'link39')" onMouseOut="HideTip('tt9')">client_serverbrowse_refresh</a></td><td class=SDescription>Issues a refresh of the server browser.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#client_serverbrowse_sorted_get" id=link40 onMouseOver="ShowTip(event, 'tt10', 'link40')" onMouseOut="HideTip('tt10')">client_serverbrowse_sorted_get</a></td><td class=SDescription>Returns server info from the sorted list.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#client_serverbrowse_sorted_num" id=link41 onMouseOver="ShowTip(event, 'tt11', 'link41')" onMouseOut="HideTip('tt11')">client_serverbrowse_sorted_num</a></td><td class=SDescription>Returns how many servers there are in the sorted list.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#client_serverbrowse_get" id=link42 onMouseOver="ShowTip(event, 'tt12', 'link42')" onMouseOut="HideTip('tt12')">client_serverbrowse_get</a></td><td class=SDescription>TODO</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#client_serverbrowse_num" id=link43 onMouseOver="ShowTip(event, 'tt13', 'link43')" onMouseOut="HideTip('tt13')">client_serverbrowse_num</a></td><td class=SDescription>TODO</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#client_serverbrowse_num_requests" id=link44 onMouseOver="ShowTip(event, 'tt14', 'link44')" onMouseOut="HideTip('tt14')">client_se
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Time"></a>Time</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_tick"></a>client_tick</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_tick()</td></tr></table></blockquote><p>Returns the tick of the current snapshot.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_intratick"></a>client_intratick</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_intratick()</td></tr></table></blockquote><p>Returns the current intratick.</p><h4 class=CHeading>Remarks</h4><p>The intratick is how far gone the time is from the previous snapshot to the current.&nbsp; 0.0 means that it on the previous snapshot.&nbsp; 0.5 means that it&rsquo;s halfway to the current, and 1.0 means that it is on the current snapshot.&nbsp; It can go beyond 1.0 which means that the client has started to extrapolate due to lack of data from the server.</p><h4 class=CHeading>See Also</h4><p><a href="#client_tick" class=LFunction id=link61 onMouseOver="ShowTip(event, 'tt1', 'link61')" onMouseOut="HideTip('tt1')">client_tick</a></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_predtick"></a>client_predtick</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_predtick()</td></tr></table></blockquote><p>Returns the current predicted tick.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_predintratick"></a>client_predintratick</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_predintratick()</td></tr></table></blockquote><p>Returns the current preticted intra tick.</p><h4 class=CHeading>Remarks</h4><p>This is the same as <a href="#client_intratick" class=LFunction id=link62 onMouseOver="ShowTip(event, 'tt2', 'link62')" onMouseOut="HideTip('tt2')">client_intratick</a> but for the current predicted tick and previous predicted tick.</p><h4 class=CHeading>See Also</h4><p><a href="#client_intratick" class=LFunction id=link63 onMouseOver="ShowTip(event, 'tt2', 'link63')" onMouseOut="HideTip('tt2')">client_intratick</a></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_ticktime"></a>client_ticktime</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_ticktime()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_tickspeed"></a>client_tickspeed</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_tickspeed()</td></tr></table></blockquote><p>Returns how many ticks per second the client is doing.</p><h4 class=CHeading>Remarks</h4><p>This will be the same as the server tick speed.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_frametime"></a>client_frametime</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_frametime()</td></tr></table></blockquote><p>Returns how long time the last frame took to process.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_localtime"></a>client_localtime</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_localtime()</td></tr></table></blockquote><p>Returns the clients local time.</p><h4 class=CHeading>Remarks</h4><p>The local time is set to 0 when the client starts and when it connects to a server.&nbsp; Can be used for client side effects.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Server_Browser"></a>Server Browser</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_serverbrowse_refresh"></a>client_serverbrowse_refresh</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>void client_serverbrowse_refresh(</td><td class=PType nowrap>int&nbsp;</td><td class=PParameter nowrap>lan</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Issues a refresh of the server browser.</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>lan</td><td class=CDLDescription>Tells the function if it should do a LAN listing or an Internet listing.</td></tr></table><h4 class=CHeading>Remarks</h4><p>This will cause a broadcast on the local network if the lan argument is set.&nbsp; Otherwise it call ask all the master servers for their servers lists.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_serverbrowse_sorted_get"></a>client_serverbrowse_sorted_get</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>SERVER_INFO *client_serverbrowse_sorted_get(</td><td class=PType nowrap>int&nbsp;</td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns server info from the sorted list.</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>index</td><td class=CDLDescription>Zero based index into the sorted list.</td></tr></table><h4 class=CHeading>See Also</h4><p><a href="#client_serverbrowse_sorted_num" class=LFunction id=link64 onMouseOver="ShowTip(event, 'tt11', 'link64')" onMouseOut="HideTip('tt11')">client_serverbrowse_sorted_num</a></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_serverbrowse_sorted_num"></a>client_serverbrowse_sorted_num</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_serverbrowse_sorted_num()</td></tr></table></blockquote><p>Returns how many servers there are in the sorted list.</p><h4 class=CHeading>See Also</h4><p><a href="#client_serverbrowse_sorted_get" class=LFunction id=link65 onMouseOver="ShowTip(event, 'tt10', 'link65')" onMouseOut="HideTip('tt10')">client_serverbrowse_sorted_get</a></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_serverbrowse_get"></a>client_serverbrowse_get</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>SERVER_INFO *client_serverbrowse_get(</td><td class=PType nowrap>int&nbsp;</td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_serverbrowse_num"></a>client_serverbrowse_num</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_serverbrowse_num()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_serverbrowse_num_requests"></a>client_serverbrowse_num_requests</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_serverbrowse_num_requests()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_serverbrowse_update"></a>client_serverbrowse_update</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>void client_serverbrowse_update()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_serverbrowse_lan"></a>client_serverbrowse_lan</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_serverbrowse_lan()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Actions"></a>Actions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_connect"></a>client_connect</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>void client_connect(</td><td class=PTypePrefix nowrap>const&nbsp;</td><td class=PType nowrap>char&nbsp;</td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap>address</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Connects to a server at the specified address.</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>address</td><td class=CDLDescription>Address of the server to connect to.</td></tr></table><h4 class=CHeading>See Also</h4><p><a href="#client_disconnect" class=LFunction id=link66 onMouseOver="ShowTip(event, 'tt18', 'link66')" onMouseOut="HideTip('tt18')">client_disconnect</a></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_disconnect"></a>client_disconnect</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>void client_disconnect()</td></tr></table></blockquote><p>Disconnects from the current server.</p><h4 class=CHeading>Remarks</h4><p>Does nothing if not connected to a server.</p><h4 class=CHeading>See Also</h4><p>&lt;client_connect, client_quit&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_quit"></a>client_quit</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>void client_quit()</td></tr></table></blockquote><p>Tells to client to shutdown.</p><h4 class=CHeading>See Also</h4><p><a href="#client_disconnect" class=LFunction id=link67 onMouseOver="ShowTip(event, 'tt18', 'link67')" onMouseOut="HideTip('tt18')">client_disconnect</a></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_rcon"></a>client_rcon</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>void client_rcon(</td><td class=PTypePrefix nowrap>const&nbsp;</td><td class=PType nowrap>char&nbsp;</td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap>cmd</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sends a command to the server to execute on it&rsquo;s console.</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>cmd</td><td class=CDLDescription>The command to send.</td></tr></table><h4 class=CHeading>Remarks</h4><p>The client must have the correct rcon password to connect.</p><h4 class=CHeading>See Also</h4><p>&lt;client_rcon_auth, client_rcon_authed&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_rcon_auth"></a>client_rcon_auth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>void client_rcon_auth(</td><td class=PTypePrefix nowrap>const&nbsp;</td><td class=PType nowrap>char&nbsp;</td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap>name,</td></tr><tr><td></td><td class=PTypePrefix nowrap>const&nbsp;</td><td class=PType nowrap>char&nbsp;</td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap>password</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;client_rcon, client_rcon_authed&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_rcon_authed"></a>client_rcon_authed</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_rcon_authed()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;client_rcon, client_rcon_auth&gt;</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Other"></a>Other</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_get_input"></a>client_get_input</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>int *client_get_input(</td><td class=PType nowrap>int&nbsp;</td><td class=PParameter nowrap>tick</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_direct_input"></a>client_direct_input</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>void client_direct_input(</td><td class=PType nowrap>int&nbsp;</td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap>input,</td></tr><tr><td></td><td class=PType nowrap>int&nbsp;</td><td class=PParameterPrefix nowrap></td><td class=PParameter nowrap>size</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_error_string"></a>client_error_string</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>const char *client_error_string()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_connection_problems"></a>client_connection_problems</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_connection_problems()</td></tr></table></blockquote><p>Returns 1 if the client is connection problems.</p><h4 class=CHeading>Remarks</h4><p>Connections problems usually means that the client havn&rsquo;t recvived any data from the server in a while.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_state"></a>client_state</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_state()</td></tr></table></blockquote><p>Returns the state of the client.</p><h4 class=CHeading>See Also</h4><p><a href="#Client_States" class=LConstant >Client States</a></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_mapdownload_amount"></a>client_mapdownload_amount</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_mapdownload_amount()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_mapdownload_totalsize"></a>client_mapdownload_totalsize</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_mapdownload_totalsize()</td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="client_save_line"></a>client_save_line</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>void client_save_line(</td><td class=PTypePrefix nowrap>const&nbsp;</td><td class=PType nowrap>char&nbsp;</td><td class=PParameterPrefix nowrap>*</td><td class=PParameter nowrap>line</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>TODO</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>arg1</td><td class=CDLDescription>desc</td></tr></table><h4 class=CHeading>Returns</h4><h4 class=CHeading>See Also</h4><p>&lt;other_func&gt;</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<div id=Menu><div class=MEntry><div class=MFile><a href="e_system-h.html">OS Abstraction</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Engine</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="e_if_msg-h.html">Messaging</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Client</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Overview</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="docs/client_time-txt.html">Time on the client</a></div></div><div class=MEntry><div class=MFile><a href="docs/prediction-txt.html">Prediction</a></div></div><div class=MEntry><div class=MFile><a href="docs/snapshots-txt.html">Snapshots</a></div></div><div class=MEntry><div class=MFile><a href="docs/server_op-txt.html">Server Operation</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Reference</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="e_if_modc-h.html">Client Hooks</a></div></div><div class=MEntry><div class=MFile id=MSelected>Client Interface</div></div><div class=MEntry><div class=MFile><a href="e_if_other-h.html">Engine Interface</a></div></div><div class=MEntry><div class=MFile><a href="e_if_gfx-h.html">Graphics</a></div></div><div class=MEntry><div class=MFile><a href="e_if_inp-h.html">Input</a></div></div><div class=MEntry><div class=MFile><a href="e_if_snd-h.html">Sound</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Server</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Reference</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="e_if_mods-h.html">Server Hooks</a></div></div><div class=MEntry><div class=MFile><a href="e_if_server-h.html">Server Interface</a></div></div></div></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">Game</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MFile><a href="../files/server/gs_common-hpp.html">Entity</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">Index</a><div class=MGroupContent id=MGroupContent8><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Constants.html">Constants</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Variables.html">Variables</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Constants">Constants</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([2, 3, 6, 1], 9);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_tick()</td></tr></table></blockquote>Returns the tick of the current snapshot.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_intratick()</td></tr></table></blockquote>Returns the current intratick.</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_predtick()</td></tr></table></blockquote>Returns the current predicted tick.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_predintratick()</td></tr></table></blockquote>Returns the current preticted intra tick.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_ticktime()</td></tr></table></blockquote>TODO</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_tickspeed()</td></tr></table></blockquote>Returns how many ticks per second the client is doing.</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_frametime()</td></tr></table></blockquote>Returns how long time the last frame took to process.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>float client_localtime()</td></tr></table></blockquote>Returns the clients local time.</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>void client_serverbrowse_refresh(</td><td class=PType nowrap>int&nbsp;</td><td class=PParameter nowrap>lan</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Issues a refresh of the server browser.</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>SERVER_INFO *client_serverbrowse_sorted_get(</td><td class=PType nowrap>int&nbsp;</td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns server info from the sorted list.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_serverbrowse_sorted_num()</td></tr></table></blockquote>Returns how many servers there are in the sorted list.</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>SERVER_INFO *client_serverbrowse_get(</td><td class=PType nowrap>int&nbsp;</td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>TODO</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_serverbrowse_num()</td></tr></table></blockquote>TODO</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>int client_serverbrowse_num_requests()</td></tr></table></blockquote>TODO</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>void client_serverbrowse_update()</td></tr></table></blo
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
Reference in a new issue Copy permalink