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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
							<!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"/>
<title>Net</title>
<link href="torquedoc.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<table width="100%" class="header">
<tr>
</tr>
<tr><td class="headermenu">
	<center>
	<a class="qindex" href="index.html">Main</a> &nbsp; 
	<a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
	</center>
</td></tr>
</table>
<br>
<!-- END HEADER -->
<!-- Generated by Doxygen 1.8.3.1 -->
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Net</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf86bcb9fecf125d584a3bac81a586d67"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Net.html#gaf86bcb9fecf125d584a3bac81a586d67">addTaggedString</a> (string)</td></tr>
<tr class="separator:gaf86bcb9fecf125d584a3bac81a586d67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd78d2b3321e820ce50941a1e6de0171"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Net.html#gadd78d2b3321e820ce50941a1e6de0171">buildTaggedString</a> (format,&lt; arg1,...arg9 &gt;)</td></tr>
<tr class="separator:gadd78d2b3321e820ce50941a1e6de0171"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3dce1c07d9c2775aa41ada242d454168"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Net.html#ga3dce1c07d9c2775aa41ada242d454168">commandToClient</a> (client, func[, arg1,..., argn])</td></tr>
<tr class="separator:ga3dce1c07d9c2775aa41ada242d454168"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafdfcdc6d09826c905ee224b1106c3429"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Net.html#gafdfcdc6d09826c905ee224b1106c3429">commandToServer</a> (func[, arg1,..., argn])</td></tr>
<tr class="separator:gafdfcdc6d09826c905ee224b1106c3429"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab369c60e5ba2cb4c59418117f18d914a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Net.html#gab369c60e5ba2cb4c59418117f18d914a">getTaggedString</a> (tag)</td></tr>
<tr class="separator:gab369c60e5ba2cb4c59418117f18d914a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed69d0661105dd6db03bff8b7e858f0c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Net.html#gaed69d0661105dd6db03bff8b7e858f0c">removeTaggedString</a> (tag)</td></tr>
<tr class="separator:gaed69d0661105dd6db03bff8b7e858f0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions for use with the network; tagged strings and remote commands. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaf86bcb9fecf125d584a3bac81a586d67"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string addTaggedString </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the addTaggedString function to tag a new string and add it to the NetStringTable. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">string</td><td>The string to tagged and placed in the NetStringTable. Tagging ignores case, so tagging the same string (excluding case differences) will be ignored as a duplicated tag. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a string (containing a numeric value) equivalent to the string ID for the newly tagged string </dd></dl>

</div>
</div>
<a class="anchor" id="gadd78d2b3321e820ce50941a1e6de0171"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string buildTaggedString </td>
          <td>(</td>
          <td class="paramtype">format&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&lt; arg1,...arg9 &gt;&#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 buildTaggedString function to build a tagged string using the specified format. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">enable</td><td>A boolean value. If set to true, network packet logging is enabled, otherwise it is disabled. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a class="anchor" id="ga3dce1c07d9c2775aa41ada242d454168"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void commandToClient </td>
          <td>(</td>
          <td class="paramtype">client&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">func&#160;</td>
          <td class="paramname">[, arg1,..., argn]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the commandToClient function to issue a remote procedure call on a client. All arguments (excluding client) may be in tagged or non-tagged format. See 'Remote Procedure Call Samples' below </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">client</td><td>The numeric ID of a client gameConnection. </td></tr>
    <tr><td class="paramname">func</td><td>The suffix of the remote procedure name to be executed on the client. </td></tr>
    <tr><td class="paramname">arg1</td><td>... argn - Optional arguments to be passed to the remote procedure. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
<a class="anchor" id="gafdfcdc6d09826c905ee224b1106c3429"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void commandToServer </td>
          <td>(</td>
          <td class="paramtype">func&#160;</td>
          <td class="paramname">[, arg1,..., argn]</td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the commandToServer function to issue a remote procedure call the server. All arguments may be in tagged or non-tagged format. See 'Remote Procedure Call Samples' below </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">func</td><td>The suffix of the remote procedure name to be executed on the client. </td></tr>
    <tr><td class="paramname">arg1</td><td>... argn - Optional arguments to be passed to the remote procedure. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
<a class="anchor" id="gab369c60e5ba2cb4c59418117f18d914a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getTaggedString </td>
          <td>(</td>
          <td class="paramtype">tag&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getTaggedString function to convert a tag to a string. This is not the same a <a class="el" href="group__TaggedStrings.html#gad9b362e737f1794ee4a727df51585117">detag()</a> which can only be used within the context of a function that receives a tag. This function can be used any time and anywhere to convert a tag to a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tag</td><td>A numeric tag ID. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the string corresponding to the tag ID </dd></dl>

</div>
</div>
<a class="anchor" id="gaed69d0661105dd6db03bff8b7e858f0c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void removeTaggedString </td>
          <td>(</td>
          <td class="paramtype">tag&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the removeTaggedSTring function to remove a previously tagged string from the NetStringTable. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tag</td><td>A number tag ID. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- START FOOTER -->
<br>
<br>
<center>
	<div style="color: #777777;">
	Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
	</div>
</center>
</body>
</html>