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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>TorqueScript Reference: GameConnection Class Reference</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 style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classGameConnection-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">GameConnection Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Inherits <a class="el" href="classNetConnection.html">NetConnection</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a39c020df19f28325016df9eb4a00a80d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a39c020df19f28325016df9eb4a00a80d">activateGhosting</a> ()</td></tr>
<tr class="separator:a39c020df19f28325016df9eb4a00a80d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a749b41feae3b0b611c069c9caeed0a1d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a749b41feae3b0b611c069c9caeed0a1d">delete</a> ([reason]?)</td></tr>
<tr class="separator:a749b41feae3b0b611c069c9caeed0a1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83fc87db596edc7e4e4dbee3716e7506"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a83fc87db596edc7e4e4dbee3716e7506">resetGhosting</a> ()</td></tr>
<tr class="separator:a83fc87db596edc7e4e4dbee3716e7506"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a287585a453aa1fef3823b2987a3e7b29"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a287585a453aa1fef3823b2987a3e7b29">setConnectArgs</a> (name,[arg1,..., arg15]?)</td></tr>
<tr class="separator:a287585a453aa1fef3823b2987a3e7b29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa996b68527ba67974d831a900af0890c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#aa996b68527ba67974d831a900af0890c">setJoinPassword</a> (password)</td></tr>
<tr class="separator:aa996b68527ba67974d831a900af0890c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classNetConnection"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classNetConnection')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classNetConnection.html">NetConnection</a></td></tr>
<tr class="memitem:a3ca3a439befff371232b7e1a2a5d1a85 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a3ca3a439befff371232b7e1a2a5d1a85">checkMaxRate</a> ()</td></tr>
<tr class="separator:a3ca3a439befff371232b7e1a2a5d1a85 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b22ac32275d0e68252d525ef6c0158a inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a4b22ac32275d0e68252d525ef6c0158a">connect</a> (remoteAddress)</td></tr>
<tr class="separator:a4b22ac32275d0e68252d525ef6c0158a inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89a31bef50dd3f86c115336bf76fb2d7 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a89a31bef50dd3f86c115336bf76fb2d7">connectLocal</a> ()</td></tr>
<tr class="separator:a89a31bef50dd3f86c115336bf76fb2d7 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40b52301641600143c12e1b8032adfe2 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a40b52301641600143c12e1b8032adfe2">getAddress</a> ()</td></tr>
<tr class="separator:a40b52301641600143c12e1b8032adfe2 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a254f1b25bf6d5ffa82026e4ad18e7fc6 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a254f1b25bf6d5ffa82026e4ad18e7fc6">getGhostID</a> (S32 realID)</td></tr>
<tr class="separator:a254f1b25bf6d5ffa82026e4ad18e7fc6 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80a9c9939aba45d20838e50397755595 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a80a9c9939aba45d20838e50397755595">getPacketLoss</a> ()</td></tr>
<tr class="separator:a80a9c9939aba45d20838e50397755595 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb0422b4856ece8e4de6144cf25bcd8b inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#acb0422b4856ece8e4de6144cf25bcd8b">getPing</a> ()</td></tr>
<tr class="separator:acb0422b4856ece8e4de6144cf25bcd8b inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3cff82047c8d31164052b0b8037b30f inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#ae3cff82047c8d31164052b0b8037b30f">resolveGhostID</a> (S32 ghostID)</td></tr>
<tr class="separator:ae3cff82047c8d31164052b0b8037b30f inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84216c51a171be2df24c53de02353344 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a84216c51a171be2df24c53de02353344">resolveObjectFromGhostIndex</a> (S32 ghostIdx)</td></tr>
<tr class="separator:a84216c51a171be2df24c53de02353344 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad796615b5ffc4d20f4e48e3421ff3c47 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#ad796615b5ffc4d20f4e48e3421ff3c47">setSimulatedNetParams</a> (packetLoss, delay)</td></tr>
<tr class="separator:ad796615b5ffc4d20f4e48e3421ff3c47 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a870a183a561643e238d6fffeeaf5ba42"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a870a183a561643e238d6fffeeaf5ba42">getServerConnection</a> ()</td></tr>
<tr class="separator:a870a183a561643e238d6fffeeaf5ba42"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a39c020df19f28325016df9eb4a00a80d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void activateGhosting </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the activateGhosting method to <a class="el" href="classGameConnection.html">GameConnection</a> instance to start ghosting objects to the client. This is called on each client connection by the server. </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="classGameConnection.html#a83fc87db596edc7e4e4dbee3716e7506">resetGhosting</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a749b41feae3b0b611c069c9caeed0a1d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void delete </td>
          <td>(</td>
          <td class="paramtype">[ reason ] ?&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the delete method to destroy and disconnect the current connection, giving an optional reason. If reason is specified, it will be transmitted to the client/server on the other end of the connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">reason</td><td>A string explaining while the connection is being severed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a class="anchor" id="a870a183a561643e238d6fffeeaf5ba42"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int getServerConnection </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Get the server connection if any. </p>

</div>
</div>
<a class="anchor" id="a83fc87db596edc7e4e4dbee3716e7506"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void resetGhosting </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the resetGhosting method to reset ghosting. This in effect tells the server to resend each ghost to insure that all objects which should be ghosts and are in fact ghosted. </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="classGameConnection.html#a39c020df19f28325016df9eb4a00a80d">activateGhosting</a> </dd></dl>

</div>
</div>
<a class="anchor" id="a287585a453aa1fef3823b2987a3e7b29"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setConnectArgs </td>
          <td>(</td>
          <td class="paramtype">name&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[arg1, ..., arg15 ] ?&#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 setConnectArgs method to set the connection arguments for this client-side <a class="el" href="classGameConnection.html">GameConnection</a>. These values will be passed to the server upon establishing a connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>Generally, the first argument is the name of the player. </td></tr>
    <tr><td class="paramname">arg1</td><td>... , arg15 - 15 additional arguments may be passed. </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="classGameConnection.html#aa996b68527ba67974d831a900af0890c">setJoinPassword</a> </dd></dl>

</div>
</div>
<a class="anchor" id="aa996b68527ba67974d831a900af0890c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setJoinPassword </td>
          <td>(</td>
          <td class="paramtype">password&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setJoinPassword method to set the password required to connect to this server-side <a class="el" href="classGameConnection.html">GameConnection</a>. Pass a NULL string to clear the password. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">password</td><td>A string representing the case insensitive password to use for this server-side <a class="el" href="classGameConnection.html">GameConnection</a>. </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="classGameConnection.html#a287585a453aa1fef3823b2987a3e7b29">setConnectArgs</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>