TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TorqueScript Reference: Server Query</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Server Query<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5c0da89e26d191e9607aff504eeb10d6" id="r_ga5c0da89e26d191e9607aff504eeb10d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#ga5c0da89e26d191e9607aff504eeb10d6">cancelServerQuery</a> ()</td></tr>
<tr class="separator:ga5c0da89e26d191e9607aff504eeb10d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9dc15c45ed6d42ea0a767564d97f290c" id="r_ga9dc15c45ed6d42ea0a767564d97f290c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#ga9dc15c45ed6d42ea0a767564d97f290c">getServerCount</a> ()</td></tr>
<tr class="separator:ga9dc15c45ed6d42ea0a767564d97f290c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga926286177017b7281705c73fa3bc559b" id="r_ga926286177017b7281705c73fa3bc559b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#ga926286177017b7281705c73fa3bc559b">queryLanServers</a> (port, flags, gametype, missiontype, minplayers, maxplayers, maxbots, regionmask, maxping, mincpu, filterflags)</td></tr>
<tr class="separator:ga926286177017b7281705c73fa3bc559b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf401a7d408f1e5164310c79dad5883b7" id="r_gaf401a7d408f1e5164310c79dad5883b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a> (flags, gametype, missiontype, minplayers, maxplayers, maxbots, regionmask, maxping, mincpu, filterflags)</td></tr>
<tr class="separator:gaf401a7d408f1e5164310c79dad5883b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga655ef178e4b707ae10c2ba76d7543330" id="r_ga655ef178e4b707ae10c2ba76d7543330"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#ga655ef178e4b707ae10c2ba76d7543330">querySingleServer</a> (address[, flags])</td></tr>
<tr class="separator:ga655ef178e4b707ae10c2ba76d7543330"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef228ddc156ea24517a72d709ae86ef3" id="r_gaef228ddc156ea24517a72d709ae86ef3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#gaef228ddc156ea24517a72d709ae86ef3">setServerInfo</a> (index)</td></tr>
<tr class="separator:gaef228ddc156ea24517a72d709ae86ef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11c2bbe6fff9f46c098f6e68b80ac0e3" id="r_ga11c2bbe6fff9f46c098f6e68b80ac0e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#ga11c2bbe6fff9f46c098f6e68b80ac0e3">startHeartbeat</a> ()</td></tr>
<tr class="separator:ga11c2bbe6fff9f46c098f6e68b80ac0e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga23da1e7cb06a96d0cd5a67bf459b4f23" id="r_ga23da1e7cb06a96d0cd5a67bf459b4f23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#ga23da1e7cb06a96d0cd5a67bf459b4f23">stopHeartbeat</a> ()</td></tr>
<tr class="separator:ga23da1e7cb06a96d0cd5a67bf459b4f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacfabfa305a9728ed21d9e8011ae173f0" id="r_gacfabfa305a9728ed21d9e8011ae173f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ServerQueryFunctions.html#gacfabfa305a9728ed21d9e8011ae173f0">stopServerQuery</a> ()</td></tr>
<tr class="separator:gacfabfa305a9728ed21d9e8011ae173f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga5c0da89e26d191e9607aff504eeb10d6" name="ga5c0da89e26d191e9607aff504eeb10d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5c0da89e26d191e9607aff504eeb10d6">&#9670;&#160;</a></span>cancelServerQuery()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> cancelServerQuery </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the cancelServerQuery function to cancel a previous query*() call. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>queryLANServers, <a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a>, <a class="el" href="group__ServerQueryFunctions.html#ga655ef178e4b707ae10c2ba76d7543330">querySingleServer</a> </dd></dl>

</div>
</div>
<a id="ga9dc15c45ed6d42ea0a767564d97f290c" name="ga9dc15c45ed6d42ea0a767564d97f290c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9dc15c45ed6d42ea0a767564d97f290c">&#9670;&#160;</a></span>getServerCount()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int getServerCount </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getServerCount function to determine the number of game servers found on the last queryLANServers() or <a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer()</a> call. This value is important because it allows us to properly index when calling <a class="el" href="group__ServerQueryFunctions.html#gaef228ddc156ea24517a72d709ae86ef3">setServerInfo()</a>. </p><dl class="section return"><dt>Returns</dt><dd>Returns a numeric value equal to the number of game servers found on the last queryLANServers() or <a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer()</a> call. Returns 0 if the function was not called, or none were found. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>queryLANServers, <a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a>, <a class="el" href="group__ServerQueryFunctions.html#gaef228ddc156ea24517a72d709ae86ef3">setServerInfo</a> </dd></dl>

</div>
</div>
<a id="ga926286177017b7281705c73fa3bc559b" name="ga926286177017b7281705c73fa3bc559b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga926286177017b7281705c73fa3bc559b">&#9670;&#160;</a></span>queryLanServers()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> queryLanServers </td>
          <td>(</td>
          <td class="paramtype">port&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">flags&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gametype&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">missiontype&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">minplayers&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">maxplayers&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">maxbots&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">regionmask&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">maxping&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">mincpu&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">filterflags&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the queryLANServers function to establish whether any game servers of the required specification(s) are available on the local area network (LAN). </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">port</td><td>Look for any game servers advertising at this port. Set to 0 if you don't care what port the game server is using. </td></tr>
    <tr><td class="paramname">flags</td><td>Look for any game servers with these special flags set. Set to 0 for no flags. </td></tr>
    <tr><td class="paramname">gametype</td><td>Look for any game servers playing a game type that matches this string. Set to the NULL string to look for any game type. </td></tr>
    <tr><td class="paramname">missiontype</td><td>Look for any game servers playing a mission type that matches this string. Set to the NULL string to look for any mission type. </td></tr>
    <tr><td class="paramname">minplayers</td><td>Look for any game servers with this number of players or more. Set to 0 for no lower limit. </td></tr>
    <tr><td class="paramname">maxplayers</td><td>Look for any game servers with this number of players or fewer. Set to 0 for no upper limit. </td></tr>
    <tr><td class="paramname">maxbots</td><td>Look for any game servers with this number of AI controlled players or fewer. Set to 0 for no limit. </td></tr>
    <tr><td class="paramname">regionmask</td><td>Look for any master servers, on our master server list, in this region. Set to 0 to examine all regions. </td></tr>
    <tr><td class="paramname">maxping</td><td>Look for any game servers with a PING rate equal to or lower than this. Set to 0 for no upper PING limit. </td></tr>
    <tr><td class="paramname">mincpu</td><td>Look for any game servers with a CPU (clock speed) equal or greater than this. Set to 0 for no CPU (clock speed) limit. </td></tr>
    <tr><td class="paramname">filterflags</td><td>Look for any game servers with this game version number or higher. Set to 0 to find all versions. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ServerQueryFunctions.html#ga9dc15c45ed6d42ea0a767564d97f290c">getServerCount</a>, <a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a>, <a class="el" href="group__ServerQueryFunctions.html#gaef228ddc156ea24517a72d709ae86ef3">setServerInfo</a>, <a class="el" href="group__ServerQueryFunctions.html#gacfabfa305a9728ed21d9e8011ae173f0">stopServerQuery</a> </dd></dl>

</div>
</div>
<a id="gaf401a7d408f1e5164310c79dad5883b7" name="gaf401a7d408f1e5164310c79dad5883b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf401a7d408f1e5164310c79dad5883b7">&#9670;&#160;</a></span>queryMasterServer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> queryMasterServer </td>
          <td>(</td>
          <td class="paramtype">flags&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">gametype&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">missiontype&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">minplayers&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">maxplayers&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">maxbots&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">regionmask&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">maxping&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">mincpu&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">filterflags&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the queryMasterServer function to query all master servers in the master server list and to establish if they are aware of any game servers that meet the specified requirements, as established by the arguments passed to this function. In order for this function to do anything, a list of master servers must have been previously specified. This list may contain one or more server addresses. A call to this function will search all servers in the list. To specify a list, simply create a set of array entries like this:$pref::Master[0] = \2:192.168.123.15:28002\;$pref::Master[1] = \2:192.168.123.2:28002\;The format of these values is ==&gt; Region Number : IP Address : Port NumberThese values should be specified in either the client's or the server's preferences file (prefs.cs). You may specifiy it elsewhere, however be sure that it is specified prior to this function being called and before any other functions that rely on it. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">flags</td><td>Look for any game servers with these special flags set. Set to 0 for no flags. </td></tr>
    <tr><td class="paramname">gametype</td><td>Look for any game servers playing a game type that matches this string. Set to the NULL string to look for any game type. </td></tr>
    <tr><td class="paramname">missiontype</td><td>Look for any game servers playing a mission type that matches this string. Set to the NULL string to look for any mission type. </td></tr>
    <tr><td class="paramname">minplayers</td><td>Look for any game servers with this number of players or more. Set to 0 for no lower limit. </td></tr>
    <tr><td class="paramname">maxplayers</td><td>Look for any game servers with this number of players or fewer. Set to 0 for no upper limit. </td></tr>
    <tr><td class="paramname">maxbots</td><td>Look for any game servers with this number of AI controlled players or fewer. Set to 0 for no limit. </td></tr>
    <tr><td class="paramname">regionmask</td><td>Look for any master servers, on our master server list, in this region. Set to 0 to examine all regions. </td></tr>
    <tr><td class="paramname">maxping</td><td>Look for any game servers with a PING rate equal to or lower than this. Set to 0 for no upper PING limit. </td></tr>
    <tr><td class="paramname">mincpu</td><td>Look for any game servers with a CPU (clock speed) equal or greater than this. Set to 0 for no CPU (clock speed) limit. </td></tr>
    <tr><td class="paramname">filterflags</td><td>Look for any game servers with this game version number or higher. Set to 0 to find all versions. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ServerQueryFunctions.html#ga9dc15c45ed6d42ea0a767564d97f290c">getServerCount</a>, queryLANServers, <a class="el" href="group__ServerQueryFunctions.html#gaef228ddc156ea24517a72d709ae86ef3">setServerInfo</a>, <a class="el" href="group__ServerQueryFunctions.html#ga11c2bbe6fff9f46c098f6e68b80ac0e3">startHeartbeat</a>, <a class="el" href="group__ServerQueryFunctions.html#gacfabfa305a9728ed21d9e8011ae173f0">stopServerQuery</a> </dd></dl>

</div>
</div>
<a id="ga655ef178e4b707ae10c2ba76d7543330" name="ga655ef178e4b707ae10c2ba76d7543330"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga655ef178e4b707ae10c2ba76d7543330">&#9670;&#160;</a></span>querySingleServer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> querySingleServer </td>
          <td>(</td>
          <td class="paramtype">address&#160;</td>
          <td class="paramname">[, flags]</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the querySingleServer function to re-query a previously queried lan server, OR a game server found with queryLANServers or with queryMasterServer and selected with setServerInfo. This will refresh the information stored by TGE about this server. It will not however modify the values of the $ServerInfo::* global variables. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">address</td><td>The IP address and Port to re-query, i.e. \192.168.123.2:28000. </td></tr>
    <tr><td class="paramname">flags</td><td>No longer used. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ServerQueryFunctions.html#ga9dc15c45ed6d42ea0a767564d97f290c">getServerCount</a>, queryLANServers, <a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a>, <a class="el" href="group__ServerQueryFunctions.html#gaef228ddc156ea24517a72d709ae86ef3">setServerInfo</a>, <a class="el" href="group__ServerQueryFunctions.html#gacfabfa305a9728ed21d9e8011ae173f0">stopServerQuery</a> </dd></dl>

</div>
</div>
<a id="gaef228ddc156ea24517a72d709ae86ef3" name="gaef228ddc156ea24517a72d709ae86ef3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaef228ddc156ea24517a72d709ae86ef3">&#9670;&#160;</a></span>setServerInfo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setServerInfo </td>
          <td>(</td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setServerInfo function to set the values of the $ServerInfo::* global variables with information for a server found with queryLANServers or with queryMasterServer. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">index</td><td>The index of the server to get information about. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Will return true if the information was successfully set, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ServerQueryFunctions.html#ga9dc15c45ed6d42ea0a767564d97f290c">getServerCount</a>, queryLANServers, <a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a>, <a class="el" href="group__ServerQueryFunctions.html#ga655ef178e4b707ae10c2ba76d7543330">querySingleServer</a> </dd></dl>

</div>
</div>
<a id="ga11c2bbe6fff9f46c098f6e68b80ac0e3" name="ga11c2bbe6fff9f46c098f6e68b80ac0e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11c2bbe6fff9f46c098f6e68b80ac0e3">&#9670;&#160;</a></span>startHeartbeat()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> startHeartbeat </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the startHeartbeat function to start advertising this game serer to any master servers on the master server list. In order for this function to do anything, a list of master servers must have been previously specified. This list may contain one or more server addresses. Once this function is called, the game server will re-advertise itself to all the master servers on its master server lits every two minutes. To specify a list, simply create a set of array entries like this:$pref::Master[0] = \2:192.168.123.15:28002\;$pref::Master[1] = \2:192.168.123.2:28002\;The format of these values is ==&gt; Region Number : IP Address : Port NumberThese values should be specified in either the client's or the server's preferences file (prefs.cs). You may specifiy it elsewhere, however be sure that it is specified prior to this function being called and before any other functions that rely on it. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a>, <a class="el" href="group__ServerQueryFunctions.html#ga23da1e7cb06a96d0cd5a67bf459b4f23">stopHeartbeat</a> </dd></dl>

</div>
</div>
<a id="ga23da1e7cb06a96d0cd5a67bf459b4f23" name="ga23da1e7cb06a96d0cd5a67bf459b4f23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga23da1e7cb06a96d0cd5a67bf459b4f23">&#9670;&#160;</a></span>stopHeartbeat()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> stopHeartbeat </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the startHeartbeat function to stop advertising this game serer to any master servers on the master server list. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a>, <a class="el" href="group__ServerQueryFunctions.html#ga11c2bbe6fff9f46c098f6e68b80ac0e3">startHeartbeat</a> </dd></dl>

</div>
</div>
<a id="gacfabfa305a9728ed21d9e8011ae173f0" name="gacfabfa305a9728ed21d9e8011ae173f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacfabfa305a9728ed21d9e8011ae173f0">&#9670;&#160;</a></span>stopServerQuery()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> stopServerQuery </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the stopServerQuery function to cancel any outstanding server queries. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>queryLANServers, <a class="el" href="group__ServerQueryFunctions.html#gaf401a7d408f1e5164310c79dad5883b7">queryMasterServer</a>, <a class="el" href="group__ServerQueryFunctions.html#ga655ef178e4b707ae10c2ba76d7543330">querySingleServer</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>