group__Network.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: Network</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#func-members">Functions</a> </div>
  45. <div class="headertitle"><div class="title">Network<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <table class="memberdecls">
  49. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  50. Functions</h2></td></tr>
  51. <tr class="memitem:gace152ad690855ad58b8755fce7a5ae25" id="r_gace152ad690855ad58b8755fce7a5ae25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Network.html#gace152ad690855ad58b8755fce7a5ae25">addTaggedString</a> (string)</td></tr>
  52. <tr class="separator:gace152ad690855ad58b8755fce7a5ae25"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:ga2c52ccd4ce526e3136bc3d9c8216d850" id="r_ga2c52ccd4ce526e3136bc3d9c8216d850"><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__Network.html#ga2c52ccd4ce526e3136bc3d9c8216d850">allowConnections</a> (enable)</td></tr>
  54. <tr class="separator:ga2c52ccd4ce526e3136bc3d9c8216d850"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:gab39b9c89828a060dcd9c459c72f998fc" id="r_gab39b9c89828a060dcd9c459c72f998fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Network.html#gab39b9c89828a060dcd9c459c72f998fc">buildTaggedString</a> (format, [arg1,...arg9]?)</td></tr>
  56. <tr class="separator:gab39b9c89828a060dcd9c459c72f998fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ga4a34796142df76366772edeed19979f2" id="r_ga4a34796142df76366772edeed19979f2"><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__Network.html#ga4a34796142df76366772edeed19979f2">closeNetPort</a> ()</td></tr>
  58. <tr class="memdesc:ga4a34796142df76366772edeed19979f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the current network port. <br /></td></tr>
  59. <tr class="separator:ga4a34796142df76366772edeed19979f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:gaf0145c2fb2ff8f188c7d79bea1b3fbb7" id="r_gaf0145c2fb2ff8f188c7d79bea1b3fbb7"><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__Network.html#gaf0145c2fb2ff8f188c7d79bea1b3fbb7">commandToClient</a> (client, func, [arg1,..., argn]?)</td></tr>
  61. <tr class="separator:gaf0145c2fb2ff8f188c7d79bea1b3fbb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:gad9edc3be9e4252b858c411f67a69cf7a" id="r_gad9edc3be9e4252b858c411f67a69cf7a"><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__Network.html#gad9edc3be9e4252b858c411f67a69cf7a">commandToNamedServer</a> (...)</td></tr>
  63. <tr class="separator:gad9edc3be9e4252b858c411f67a69cf7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:gacdd112b86030708f6404bc736d232645" id="r_gacdd112b86030708f6404bc736d232645"><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__Network.html#gacdd112b86030708f6404bc736d232645">commandToServer</a> (func, [arg1,..., argn]?)</td></tr>
  65. <tr class="separator:gacdd112b86030708f6404bc736d232645"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:ga1e432870515a39e5ad85f35b78cd8f21" id="r_ga1e432870515a39e5ad85f35b78cd8f21"><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__Network.html#ga1e432870515a39e5ad85f35b78cd8f21">DNetSetLogging</a> (bool enabled)</td></tr>
  67. <tr class="separator:ga1e432870515a39e5ad85f35b78cd8f21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ga0359e690478eae53a0b89f009334687e" id="r_ga0359e690478eae53a0b89f009334687e"><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__Network.html#ga0359e690478eae53a0b89f009334687e">dumpNetStringTable</a> ()</td></tr>
  69. <tr class="separator:ga0359e690478eae53a0b89f009334687e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:ga3ff2f15eccf099b4dd07a3c94788cdbb" id="r_ga3ff2f15eccf099b4dd07a3c94788cdbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Network.html#ga3ff2f15eccf099b4dd07a3c94788cdbb">getTaggedString</a> (tag)</td></tr>
  71. <tr class="separator:ga3ff2f15eccf099b4dd07a3c94788cdbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ga2f76d72acd0943474ba7bfc993b5b579" id="r_ga2f76d72acd0943474ba7bfc993b5b579"><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__Network.html#ga2f76d72acd0943474ba7bfc993b5b579">isAddressTypeAvailable</a> (int addressType)</td></tr>
  73. <tr class="separator:ga2f76d72acd0943474ba7bfc993b5b579"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:gaed69d0661105dd6db03bff8b7e858f0c" id="r_gaed69d0661105dd6db03bff8b7e858f0c"><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__Network.html#gaed69d0661105dd6db03bff8b7e858f0c">removeTaggedString</a> (tag)</td></tr>
  75. <tr class="separator:gaed69d0661105dd6db03bff8b7e858f0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga6b9f8e8cdfc8857a48732ff62646ba8a" id="r_ga6b9f8e8cdfc8857a48732ff62646ba8a"><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__Network.html#ga6b9f8e8cdfc8857a48732ff62646ba8a">setNetPort</a> (int port, bind)</td></tr>
  77. <tr class="separator:ga6b9f8e8cdfc8857a48732ff62646ba8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table>
  79. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  80. <h2 class="groupheader">Function Documentation</h2>
  81. <a id="gace152ad690855ad58b8755fce7a5ae25" name="gace152ad690855ad58b8755fce7a5ae25"></a>
  82. <h2 class="memtitle"><span class="permalink"><a href="#gace152ad690855ad58b8755fce7a5ae25">&#9670;&#160;</a></span>addTaggedString()</h2>
  83. <div class="memitem">
  84. <div class="memproto">
  85. <table class="memname">
  86. <tr>
  87. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> addTaggedString </td>
  88. <td>(</td>
  89. <td class="paramtype">string&#160;</td>
  90. <td class="paramname"></td><td>)</td>
  91. <td></td>
  92. </tr>
  93. </table>
  94. </div><div class="memdoc">
  95. <p>Use the addTaggedString function to tag a new string and add it to the NetStringTable. </p><dl class="params"><dt>Parameters</dt><dd>
  96. <table class="params">
  97. <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>
  98. </table>
  99. </dd>
  100. </dl>
  101. <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>
  102. </div>
  103. </div>
  104. <a id="ga2c52ccd4ce526e3136bc3d9c8216d850" name="ga2c52ccd4ce526e3136bc3d9c8216d850"></a>
  105. <h2 class="memtitle"><span class="permalink"><a href="#ga2c52ccd4ce526e3136bc3d9c8216d850">&#9670;&#160;</a></span>allowConnections()</h2>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> allowConnections </td>
  111. <td>(</td>
  112. <td class="paramtype">enable&#160;</td>
  113. <td class="paramname"></td><td>)</td>
  114. <td></td>
  115. </tr>
  116. </table>
  117. </div><div class="memdoc">
  118. <p>Use the allowConnections to enable (or disable) remote connections to the local game server. </p><dl class="params"><dt>Parameters</dt><dd>
  119. <table class="params">
  120. <tr><td class="paramname">enable</td><td>A boolean value enabling, or disabling connections to the local server. </td></tr>
  121. </table>
  122. </dd>
  123. </dl>
  124. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  125. </div>
  126. </div>
  127. <a id="gab39b9c89828a060dcd9c459c72f998fc" name="gab39b9c89828a060dcd9c459c72f998fc"></a>
  128. <h2 class="memtitle"><span class="permalink"><a href="#gab39b9c89828a060dcd9c459c72f998fc">&#9670;&#160;</a></span>buildTaggedString()</h2>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> buildTaggedString </td>
  134. <td>(</td>
  135. <td class="paramtype">format&#160;</td>
  136. <td class="paramname">, </td>
  137. </tr>
  138. <tr>
  139. <td class="paramkey"></td>
  140. <td></td>
  141. <td class="paramtype">[arg1, ...arg9] ?&#160;</td>
  142. <td class="paramname">&#160;</td>
  143. </tr>
  144. <tr>
  145. <td></td>
  146. <td>)</td>
  147. <td></td><td></td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. <p>Use the buildTaggedString function to build a tagged string using the specified format. </p><dl class="params"><dt>Parameters</dt><dd>
  152. <table class="params">
  153. <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>
  154. </table>
  155. </dd>
  156. </dl>
  157. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  158. </div>
  159. </div>
  160. <a id="ga4a34796142df76366772edeed19979f2" name="ga4a34796142df76366772edeed19979f2"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#ga4a34796142df76366772edeed19979f2">&#9670;&#160;</a></span>closeNetPort()</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> closeNetPort </td>
  167. <td>(</td>
  168. <td class="paramname"></td><td>)</td>
  169. <td></td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. <p>Closes the current network port. </p>
  174. </div>
  175. </div>
  176. <a id="gaf0145c2fb2ff8f188c7d79bea1b3fbb7" name="gaf0145c2fb2ff8f188c7d79bea1b3fbb7"></a>
  177. <h2 class="memtitle"><span class="permalink"><a href="#gaf0145c2fb2ff8f188c7d79bea1b3fbb7">&#9670;&#160;</a></span>commandToClient()</h2>
  178. <div class="memitem">
  179. <div class="memproto">
  180. <table class="memname">
  181. <tr>
  182. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> commandToClient </td>
  183. <td>(</td>
  184. <td class="paramtype">client&#160;</td>
  185. <td class="paramname">, </td>
  186. </tr>
  187. <tr>
  188. <td class="paramkey"></td>
  189. <td></td>
  190. <td class="paramtype">func&#160;</td>
  191. <td class="paramname">, </td>
  192. </tr>
  193. <tr>
  194. <td class="paramkey"></td>
  195. <td></td>
  196. <td class="paramtype">[arg1, ... , argn] ?&#160;</td>
  197. <td class="paramname">&#160;</td>
  198. </tr>
  199. <tr>
  200. <td></td>
  201. <td>)</td>
  202. <td></td><td></td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <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>
  207. <table class="params">
  208. <tr><td class="paramname">client</td><td>The numeric ID of a client gameConnection. </td></tr>
  209. <tr><td class="paramname">func</td><td>The suffix of the remote procedure name to be executed on the client. </td></tr>
  210. <tr><td class="paramname">arg1</td><td>... argn - Optional arguments to be passed to the remote procedure. </td></tr>
  211. </table>
  212. </dd>
  213. </dl>
  214. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  215. </div>
  216. </div>
  217. <a id="gad9edc3be9e4252b858c411f67a69cf7a" name="gad9edc3be9e4252b858c411f67a69cf7a"></a>
  218. <h2 class="memtitle"><span class="permalink"><a href="#gad9edc3be9e4252b858c411f67a69cf7a">&#9670;&#160;</a></span>commandToNamedServer()</h2>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <table class="memname">
  222. <tr>
  223. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> commandToNamedServer </td>
  224. <td>(</td>
  225. <td class="paramtype">&#160;</td>
  226. <td class="paramname"><em>...</em></td><td>)</td>
  227. <td></td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. </div>
  232. </div>
  233. <a id="gacdd112b86030708f6404bc736d232645" name="gacdd112b86030708f6404bc736d232645"></a>
  234. <h2 class="memtitle"><span class="permalink"><a href="#gacdd112b86030708f6404bc736d232645">&#9670;&#160;</a></span>commandToServer()</h2>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> commandToServer </td>
  240. <td>(</td>
  241. <td class="paramtype">func&#160;</td>
  242. <td class="paramname">, </td>
  243. </tr>
  244. <tr>
  245. <td class="paramkey"></td>
  246. <td></td>
  247. <td class="paramtype">[arg1, ... , argn] ?&#160;</td>
  248. <td class="paramname">&#160;</td>
  249. </tr>
  250. <tr>
  251. <td></td>
  252. <td>)</td>
  253. <td></td><td></td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <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>
  258. <table class="params">
  259. <tr><td class="paramname">func</td><td>The suffix of the remote procedure name to be executed on the client. </td></tr>
  260. <tr><td class="paramname">arg1</td><td>... argn - Optional arguments to be passed to the remote procedure. </td></tr>
  261. </table>
  262. </dd>
  263. </dl>
  264. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  265. </div>
  266. </div>
  267. <a id="ga1e432870515a39e5ad85f35b78cd8f21" name="ga1e432870515a39e5ad85f35b78cd8f21"></a>
  268. <h2 class="memtitle"><span class="permalink"><a href="#ga1e432870515a39e5ad85f35b78cd8f21">&#9670;&#160;</a></span>DNetSetLogging()</h2>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> DNetSetLogging </td>
  274. <td>(</td>
  275. <td class="paramtype">bool&#160;</td>
  276. <td class="paramname"><em>enabled</em></td><td>)</td>
  277. <td></td>
  278. </tr>
  279. </table>
  280. </div><div class="memdoc">
  281. </div>
  282. </div>
  283. <a id="ga0359e690478eae53a0b89f009334687e" name="ga0359e690478eae53a0b89f009334687e"></a>
  284. <h2 class="memtitle"><span class="permalink"><a href="#ga0359e690478eae53a0b89f009334687e">&#9670;&#160;</a></span>dumpNetStringTable()</h2>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="memname">
  288. <tr>
  289. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> dumpNetStringTable </td>
  290. <td>(</td>
  291. <td class="paramname"></td><td>)</td>
  292. <td></td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Use the dumpNetStringTable function to dump a list of all the currently registered NetStringTable entries, including the times each has been referenced, the total entry count, and the current 'highest' reference string. For this to work, the engine must have been compiled with TORQUE_DEBUG defined </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  297. </div>
  298. </div>
  299. <a id="ga3ff2f15eccf099b4dd07a3c94788cdbb" name="ga3ff2f15eccf099b4dd07a3c94788cdbb"></a>
  300. <h2 class="memtitle"><span class="permalink"><a href="#ga3ff2f15eccf099b4dd07a3c94788cdbb">&#9670;&#160;</a></span>getTaggedString()</h2>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getTaggedString </td>
  306. <td>(</td>
  307. <td class="paramtype">tag&#160;</td>
  308. <td class="paramname"></td><td>)</td>
  309. <td></td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. <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#ga55d22abc645afba4556c1d911563faed">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>
  314. <table class="params">
  315. <tr><td class="paramname">tag</td><td>A numeric tag ID. </td></tr>
  316. </table>
  317. </dd>
  318. </dl>
  319. <dl class="section return"><dt>Returns</dt><dd>Returns the string corresponding to the tag ID </dd></dl>
  320. </div>
  321. </div>
  322. <a id="ga2f76d72acd0943474ba7bfc993b5b579" name="ga2f76d72acd0943474ba7bfc993b5b579"></a>
  323. <h2 class="memtitle"><span class="permalink"><a href="#ga2f76d72acd0943474ba7bfc993b5b579">&#9670;&#160;</a></span>isAddressTypeAvailable()</h2>
  324. <div class="memitem">
  325. <div class="memproto">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isAddressTypeAvailable </td>
  329. <td>(</td>
  330. <td class="paramtype">int&#160;</td>
  331. <td class="paramname"><em>addressType</em></td><td>)</td>
  332. <td></td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>Determines if a specified address type can be reached. </p><dl class="params"><dt>Parameters</dt><dd>
  337. <table class="params">
  338. <tr><td class="paramname">protocol</td><td>id </td></tr>
  339. </table>
  340. </dd>
  341. </dl>
  342. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false on fail </dd></dl>
  343. </div>
  344. </div>
  345. <a id="gaed69d0661105dd6db03bff8b7e858f0c" name="gaed69d0661105dd6db03bff8b7e858f0c"></a>
  346. <h2 class="memtitle"><span class="permalink"><a href="#gaed69d0661105dd6db03bff8b7e858f0c">&#9670;&#160;</a></span>removeTaggedString()</h2>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> removeTaggedString </td>
  352. <td>(</td>
  353. <td class="paramtype">tag&#160;</td>
  354. <td class="paramname"></td><td>)</td>
  355. <td></td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <p>Use the removeTaggedSTring function to remove a previously tagged string from the NetStringTable. </p><dl class="params"><dt>Parameters</dt><dd>
  360. <table class="params">
  361. <tr><td class="paramname">tag</td><td>A number tag ID. </td></tr>
  362. </table>
  363. </dd>
  364. </dl>
  365. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  366. </div>
  367. </div>
  368. <a id="ga6b9f8e8cdfc8857a48732ff62646ba8a" name="ga6b9f8e8cdfc8857a48732ff62646ba8a"></a>
  369. <h2 class="memtitle"><span class="permalink"><a href="#ga6b9f8e8cdfc8857a48732ff62646ba8a">&#9670;&#160;</a></span>setNetPort()</h2>
  370. <div class="memitem">
  371. <div class="memproto">
  372. <table class="memname">
  373. <tr>
  374. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setNetPort </td>
  375. <td>(</td>
  376. <td class="paramtype">int&#160;</td>
  377. <td class="paramname"><em>port</em>, </td>
  378. </tr>
  379. <tr>
  380. <td class="paramkey"></td>
  381. <td></td>
  382. <td class="paramtype">bind&#160;</td>
  383. <td class="paramname">&#160;</td>
  384. </tr>
  385. <tr>
  386. <td></td>
  387. <td>)</td>
  388. <td></td><td></td>
  389. </tr>
  390. </table>
  391. </div><div class="memdoc">
  392. <p>Set the network port for the game to use. </p><dl class="params"><dt>Parameters</dt><dd>
  393. <table class="params">
  394. <tr><td class="paramname">The</td><td>requested port as an integer </td></tr>
  395. </table>
  396. </dd>
  397. </dl>
  398. <dl class="section return"><dt>Returns</dt><dd>Returns true on success, false on fail </dd></dl>
  399. </div>
  400. </div>
  401. </div><!-- contents -->
  402. <!-- start footer part -->
  403. <hr class="footer"/><address class="footer"><small>
  404. 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
  405. </small></address>
  406. </body>
  407. </html>