Home Explore Help
Sign In
TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 889f61e63c
Branches Tags
Torque2D
/
TorqueScriptDocs
/
html
/
classNetConnection.html

classNetConnection.html 41 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>NetConnection Class Reference</title>
    6. 

  6. <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
    7. 

  7. </head>
    8. 

  8. <body>
    9. 

  9. <table width="100%" class="header">
    10. 

  10. <tr>
    11. 

  11. </tr>
    12. 

  12. <tr><td class="headermenu">
    13. 

  13. 	<center>
    14. 

  14. 	<a class="qindex" href="index.html">Main</a> &nbsp; 
    15. 

  15. 	<a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
    16. 

  16. 	</center>
    17. 

  17. </td></tr>
    18. 

  18. </table>
    19. 

  19. <br>
    20. 

  20. <!-- END HEADER -->
    21. 

  21. <!-- Generated by Doxygen 1.8.3.1 -->
    22. 

  22. </div><!-- top -->
    23. 

  23. <div class="header">
    24. 

  24.   <div class="summary">
    25. 

  25. <a href="#pub-methods">Methods</a> &#124;
    26. 

  26. <a href="classNetConnection-members.html">List of all members</a>  </div>
    27. 

  27.   <div class="headertitle">
    28. 

  28. <div class="title">NetConnection Class Reference</div>  </div>
    29. 

  29. </div><!--header-->
    30. 

  30. <div class="contents">
    31. 

  31. 

  32. <p>Inherits <a class="el" href="classSimGroup.html">SimGroup</a>, and <a class="el" href="classSimGroup.html">SimGroup</a>.</p>
    33. 

  33. 

  34. <p>Inherited by <a class="el" href="classGameConnection.html">GameConnection</a>, and <a class="el" href="classGameConnection.html">GameConnection</a>.</p>
    35. 

  35. <table class="memberdecls">
    36. 

  36. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    37. 

  37. Methods</h2></td></tr>
    38. 

  38. <tr class="memitem:a4000f32a9ef756449737b94fda64e9c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a4000f32a9ef756449737b94fda64e9c8">checkMaxRate</a> ()</td></tr>
    39. 

  39. <tr class="separator:a4000f32a9ef756449737b94fda64e9c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    40. 

  40. <tr class="memitem:a4000f32a9ef756449737b94fda64e9c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a4000f32a9ef756449737b94fda64e9c8">checkMaxRate</a> ()</td></tr>
    41. 

  41. <tr class="separator:a4000f32a9ef756449737b94fda64e9c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    42. 

  42. <tr class="memitem:a816fb14799aad08fb0fc7a8e49433f35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a816fb14799aad08fb0fc7a8e49433f35">connect</a> (remoteAddress)</td></tr>
    43. 

  43. <tr class="separator:a816fb14799aad08fb0fc7a8e49433f35"><td class="memSeparator" colspan="2">&#160;</td></tr>
    44. 

  44. <tr class="memitem:a816fb14799aad08fb0fc7a8e49433f35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a816fb14799aad08fb0fc7a8e49433f35">connect</a> (remoteAddress)</td></tr>
    45. 

  45. <tr class="separator:a816fb14799aad08fb0fc7a8e49433f35"><td class="memSeparator" colspan="2">&#160;</td></tr>
    46. 

  46. <tr class="memitem:a9a1f87965464ecff12b5f38a51740b36"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a9a1f87965464ecff12b5f38a51740b36">connectLocal</a> ()</td></tr>
    47. 

  47. <tr class="separator:a9a1f87965464ecff12b5f38a51740b36"><td class="memSeparator" colspan="2">&#160;</td></tr>
    48. 

  48. <tr class="memitem:a9a1f87965464ecff12b5f38a51740b36"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a9a1f87965464ecff12b5f38a51740b36">connectLocal</a> ()</td></tr>
    49. 

  49. <tr class="separator:a9a1f87965464ecff12b5f38a51740b36"><td class="memSeparator" colspan="2">&#160;</td></tr>
    50. 

  50. <tr class="memitem:a36094e8fb4028d1d042b85f9229eeece"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a36094e8fb4028d1d042b85f9229eeece">getAddress</a> ()</td></tr>
    51. 

  51. <tr class="separator:a36094e8fb4028d1d042b85f9229eeece"><td class="memSeparator" colspan="2">&#160;</td></tr>
    52. 

  52. <tr class="memitem:a36094e8fb4028d1d042b85f9229eeece"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a36094e8fb4028d1d042b85f9229eeece">getAddress</a> ()</td></tr>
    53. 

  53. <tr class="separator:a36094e8fb4028d1d042b85f9229eeece"><td class="memSeparator" colspan="2">&#160;</td></tr>
    54. 

  54. <tr class="memitem:a31af5056896cd41800b95ca63ce6de3d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a31af5056896cd41800b95ca63ce6de3d">getGhostID</a> (S32 realID)</td></tr>
    55. 

  55. <tr class="separator:a31af5056896cd41800b95ca63ce6de3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    56. 

  56. <tr class="memitem:a31af5056896cd41800b95ca63ce6de3d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a31af5056896cd41800b95ca63ce6de3d">getGhostID</a> (S32 realID)</td></tr>
    57. 

  57. <tr class="separator:a31af5056896cd41800b95ca63ce6de3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    58. 

  58. <tr class="memitem:a6f4367652c08cb4500bbb2758e8bdd46"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a6f4367652c08cb4500bbb2758e8bdd46">getGhostsActive</a> ()</td></tr>
    59. 

  59. <tr class="separator:a6f4367652c08cb4500bbb2758e8bdd46"><td class="memSeparator" colspan="2">&#160;</td></tr>
    60. 

  60. <tr class="memitem:a6f4367652c08cb4500bbb2758e8bdd46"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a6f4367652c08cb4500bbb2758e8bdd46">getGhostsActive</a> ()</td></tr>
    61. 

  61. <tr class="separator:a6f4367652c08cb4500bbb2758e8bdd46"><td class="memSeparator" colspan="2">&#160;</td></tr>
    62. 

  62. <tr class="memitem:a25487d409472ac3e38199fe2f1af3c63"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a25487d409472ac3e38199fe2f1af3c63">getPacketLoss</a> ()</td></tr>
    63. 

  63. <tr class="separator:a25487d409472ac3e38199fe2f1af3c63"><td class="memSeparator" colspan="2">&#160;</td></tr>
    64. 

  64. <tr class="memitem:a25487d409472ac3e38199fe2f1af3c63"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a25487d409472ac3e38199fe2f1af3c63">getPacketLoss</a> ()</td></tr>
    65. 

  65. <tr class="separator:a25487d409472ac3e38199fe2f1af3c63"><td class="memSeparator" colspan="2">&#160;</td></tr>
    66. 

  66. <tr class="memitem:a2794fb68f7c0fb7584dc75a4423a2238"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a2794fb68f7c0fb7584dc75a4423a2238">getPing</a> ()</td></tr>
    67. 

  67. <tr class="separator:a2794fb68f7c0fb7584dc75a4423a2238"><td class="memSeparator" colspan="2">&#160;</td></tr>
    68. 

  68. <tr class="memitem:a2794fb68f7c0fb7584dc75a4423a2238"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a2794fb68f7c0fb7584dc75a4423a2238">getPing</a> ()</td></tr>
    69. 

  69. <tr class="separator:a2794fb68f7c0fb7584dc75a4423a2238"><td class="memSeparator" colspan="2">&#160;</td></tr>
    70. 

  70. <tr class="memitem:a3da8ef5bc23fc02405c888190d166e1a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a3da8ef5bc23fc02405c888190d166e1a">resolveGhostID</a> (S32 ghostID)</td></tr>
    71. 

  71. <tr class="separator:a3da8ef5bc23fc02405c888190d166e1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    72. 

  72. <tr class="memitem:a3da8ef5bc23fc02405c888190d166e1a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a3da8ef5bc23fc02405c888190d166e1a">resolveGhostID</a> (S32 ghostID)</td></tr>
    73. 

  73. <tr class="separator:a3da8ef5bc23fc02405c888190d166e1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
    74. 

  74. <tr class="memitem:a717d1a961b20a55f84d9f4d410e5f4bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a717d1a961b20a55f84d9f4d410e5f4bc">resolveObjectFromGhostIndex</a> (S32 ghostIdx)</td></tr>
    75. 

  75. <tr class="separator:a717d1a961b20a55f84d9f4d410e5f4bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    76. 

  76. <tr class="memitem:a717d1a961b20a55f84d9f4d410e5f4bc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a717d1a961b20a55f84d9f4d410e5f4bc">resolveObjectFromGhostIndex</a> (S32 ghostIdx)</td></tr>
    77. 

  77. <tr class="separator:a717d1a961b20a55f84d9f4d410e5f4bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    78. 

  78. <tr class="memitem:ac7cf83874f24b697fc10d68cf4168b20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#ac7cf83874f24b697fc10d68cf4168b20">setSimulatedNetParams</a> (packetLoss, delay)</td></tr>
    79. 

  79. <tr class="separator:ac7cf83874f24b697fc10d68cf4168b20"><td class="memSeparator" colspan="2">&#160;</td></tr>
    80. 

  80. <tr class="memitem:ac7cf83874f24b697fc10d68cf4168b20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#ac7cf83874f24b697fc10d68cf4168b20">setSimulatedNetParams</a> (packetLoss, delay)</td></tr>
    81. 

  81. <tr class="separator:ac7cf83874f24b697fc10d68cf4168b20"><td class="memSeparator" colspan="2">&#160;</td></tr>
    82. 

  82. </table><table class="memberdecls">
    83. 

  83. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
    84. 

  84. Fields</h2></td></tr>
    85. 

  85. <tr><td colspan="2"><div class="groupHeader">SimBase</div></td></tr>
    86. 

  86. <tr class="memitem:a6dc6252d6100838345a01475ae6eec6f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a6dc6252d6100838345a01475ae6eec6f">canSaveDynamicFields</a></td></tr>
    87. 

  87. <tr class="separator:a6dc6252d6100838345a01475ae6eec6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    88. 

  88. <tr class="memitem:a7544cd0bb9fab1f6fa91c8e213ca3649"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a7544cd0bb9fab1f6fa91c8e213ca3649">internalName</a></td></tr>
    89. 

  89. <tr class="separator:a7544cd0bb9fab1f6fa91c8e213ca3649"><td class="memSeparator" colspan="2">&#160;</td></tr>
    90. 

  90. <tr class="memitem:aeb4d21bbcfaddcce9783dd190fcebe3e"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#aeb4d21bbcfaddcce9783dd190fcebe3e">parentGroup</a></td></tr>
    91. 

  91. <tr class="separator:aeb4d21bbcfaddcce9783dd190fcebe3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    92. 

  92. <tr><td colspan="2"><div class="groupHeader">Namespace Linking</div></td></tr>
    93. 

  93. <tr class="memitem:a2cc0b063411d99d571e3cb695708c2e4"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a2cc0b063411d99d571e3cb695708c2e4">superclass</a></td></tr>
    94. 

  94. <tr class="separator:a2cc0b063411d99d571e3cb695708c2e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    95. 

  95. <tr class="memitem:a5688c0e7b1b58c3ba4e5e645a16adc78"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a5688c0e7b1b58c3ba4e5e645a16adc78">class</a></td></tr>
    96. 

  96. <tr class="separator:a5688c0e7b1b58c3ba4e5e645a16adc78"><td class="memSeparator" colspan="2">&#160;</td></tr>
    97. 

  97. <tr class="inherit_header pub_attribs_classSimGroup"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimGroup')"><img src="closed.png" alt="-"/>&#160;Fields inherited from <a class="el" href="classSimGroup.html">SimGroup</a></td></tr>
    98. 

  98. <tr class="memitem:aa1a278c7138ab2ef4dca24a60c2f19ca inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#aa1a278c7138ab2ef4dca24a60c2f19ca">canSaveDynamicFields</a></td></tr>
    99. 

  99. <tr class="separator:aa1a278c7138ab2ef4dca24a60c2f19ca inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2">&#160;</td></tr>
    100. 

  100. <tr class="memitem:ad7d60aef9593ead78e46e141eef22741 inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#ad7d60aef9593ead78e46e141eef22741">internalName</a></td></tr>
    101. 

  101. <tr class="separator:ad7d60aef9593ead78e46e141eef22741 inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2">&#160;</td></tr>
    102. 

  102. <tr class="memitem:a620ad5d8e74201a9e9216aef954a2a44 inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#a620ad5d8e74201a9e9216aef954a2a44">parentGroup</a></td></tr>
    103. 

  103. <tr class="separator:a620ad5d8e74201a9e9216aef954a2a44 inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2">&#160;</td></tr>
    104. 

  104. <tr class="memitem:ad64ade6b8b7f43b1dfe019b14255e8b7 inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#ad64ade6b8b7f43b1dfe019b14255e8b7">superclass</a></td></tr>
    105. 

  105. <tr class="separator:ad64ade6b8b7f43b1dfe019b14255e8b7 inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2">&#160;</td></tr>
    106. 

  106. <tr class="memitem:a7315505335435abdcfbcfd0120b2aee6 inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#a7315505335435abdcfbcfd0120b2aee6">class</a></td></tr>
    107. 

  107. <tr class="separator:a7315505335435abdcfbcfd0120b2aee6 inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2">&#160;</td></tr>
    108. 

  108. <tr class="inherit_header pub_attribs_classSimSet"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimSet')"><img src="closed.png" alt="-"/>&#160;Fields inherited from <a class="el" href="classSimSet.html">SimSet</a></td></tr>
    109. 

  109. <tr class="memitem:a3bb18a691b65cf18937cc4ed585ded69 inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a3bb18a691b65cf18937cc4ed585ded69">canSaveDynamicFields</a></td></tr>
    110. 

  110. <tr class="separator:a3bb18a691b65cf18937cc4ed585ded69 inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
    111. 

  111. <tr class="memitem:abee96825d0871986cc0874b1f80c94c9 inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#abee96825d0871986cc0874b1f80c94c9">internalName</a></td></tr>
    112. 

  112. <tr class="separator:abee96825d0871986cc0874b1f80c94c9 inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
    113. 

  113. <tr class="memitem:a7d10db94dc624cb154e1a2661b174c1a inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a7d10db94dc624cb154e1a2661b174c1a">parentGroup</a></td></tr>
    114. 

  114. <tr class="separator:a7d10db94dc624cb154e1a2661b174c1a inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
    115. 

  115. <tr class="memitem:a68606d4133a9392219b4409e1617242f inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a68606d4133a9392219b4409e1617242f">superclass</a></td></tr>
    116. 

  116. <tr class="separator:a68606d4133a9392219b4409e1617242f inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
    117. 

  117. <tr class="memitem:a8635ee00b4d90c5163c1bdb25542e397 inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a8635ee00b4d90c5163c1bdb25542e397">class</a></td></tr>
    118. 

  118. <tr class="separator:a8635ee00b4d90c5163c1bdb25542e397 inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2">&#160;</td></tr>
    119. 

  119. <tr class="inherit_header pub_attribs_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimObject')"><img src="closed.png" alt="-"/>&#160;Fields inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
    120. 

  120. <tr class="memitem:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab49fae316a2d0c12834f50c3d77202e6">canSaveDynamicFields</a></td></tr>
    121. 

  121. <tr class="separator:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    122. 

  122. <tr class="memitem:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad03202387165717f164f996a5b22c9bb">internalName</a></td></tr>
    123. 

  123. <tr class="separator:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    124. 

  124. <tr class="memitem:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f783d7e37cad2b0a9d6f7b0d1672a28">parentGroup</a></td></tr>
    125. 

  125. <tr class="separator:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    126. 

  126. <tr class="memitem:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa0d134072878053537fefb1768b63d3f">superclass</a></td></tr>
    127. 

  127. <tr class="separator:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    128. 

  128. <tr class="memitem:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab83c7a59a66018d9b5eec3c8dcd3397d">class</a></td></tr>
    129. 

  129. <tr class="separator:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    130. 

  130. </table>
    131. 

  131. <h2 class="groupheader">Methods</h2>
    132. 

  132. <a class="anchor" id="a4000f32a9ef756449737b94fda64e9c8"></a>
    133. 

  133. <div class="memitem">
    134. 

  134. <div class="memproto">
    135. 

  135.       <table class="memname">
    136. 

  136.         <tr>
    137. 

  137.           <td class="memname">void NetConnection::checkMaxRate </td>
    138. 

  138.           <td>(</td>
    139. 

  139.           <td class="paramname"></td><td>)</td>
    140. 

  140.           <td></td>
    141. 

  141.         </tr>
    142. 

  142.       </table>
    143. 

  143. </div><div class="memdoc">
    144. 

  144. <p>Use the checkMaxRate method to retrieve the current maximum packet rate for this connection. The period may not neccesarily be one second. To adjust packet rates, see the preference variables above </p>
    145. 

  145. <dl class="section return"><dt>Returns</dt><dd>Returns an integer value representing the maximum number of packets that can be transmitted by this connection per transmission period. </dd></dl>
    146. 

  146. 

  147. </div>
    148. 

  148. </div>
    149. 

  149. <a class="anchor" id="a4000f32a9ef756449737b94fda64e9c8"></a>
    150. 

  150. <div class="memitem">
    151. 

  151. <div class="memproto">
    152. 

  152.       <table class="memname">
    153. 

  153.         <tr>
    154. 

  154.           <td class="memname">void NetConnection::checkMaxRate </td>
    155. 

  155.           <td>(</td>
    156. 

  156.           <td class="paramname"></td><td>)</td>
    157. 

  157.           <td></td>
    158. 

  158.         </tr>
    159. 

  159.       </table>
    160. 

  160. </div><div class="memdoc">
    161. 

  161. <p>Use the checkMaxRate method to retrieve the current maximum packet rate for this connection. The period may not neccesarily be one second. To adjust packet rates, see the preference variables above </p>
    162. 

  162. <dl class="section return"><dt>Returns</dt><dd>Returns an integer value representing the maximum number of packets that can be transmitted by this connection per transmission period. </dd></dl>
    163. 

  163. 

  164. </div>
    165. 

  165. </div>
    166. 

  166. <a class="anchor" id="a816fb14799aad08fb0fc7a8e49433f35"></a>
    167. 

  167. <div class="memitem">
    168. 

  168. <div class="memproto">
    169. 

  169.       <table class="memname">
    170. 

  170.         <tr>
    171. 

  171.           <td class="memname">void NetConnection::connect </td>
    172. 

  172.           <td>(</td>
    173. 

  173.           <td class="paramtype">remoteAddress&#160;</td>
    174. 

  174.           <td class="paramname"></td><td>)</td>
    175. 

  175.           <td></td>
    176. 

  176.         </tr>
    177. 

  177.       </table>
    178. 

  178. </div><div class="memdoc">
    179. 

  179. <p>Use the connect method to request a connection to a remote server at the address remoteAddress. </p>
    180. 

  180. <dl class="params"><dt>Parameters</dt><dd>
    181. 

  181.   <table class="params">
    182. 

  182.     <tr><td class="paramname">remoteAddress</td><td>A string containing an address of the form: A.B.C.D:Port, where A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536. </td></tr>
    183. 

  183.   </table>
    184. 

  184.   </dd>
    185. 

  185. </dl>
    186. 

  186. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    187. 

  187. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a9a1f87965464ecff12b5f38a51740b36">connectLocal</a>, <a class="el" href="classNetConnection.html#a36094e8fb4028d1d042b85f9229eeece">getAddress</a> </dd></dl>
    188. 

  188. 

  189. </div>
    190. 

  190. </div>
    191. 

  191. <a class="anchor" id="a816fb14799aad08fb0fc7a8e49433f35"></a>
    192. 

  192. <div class="memitem">
    193. 

  193. <div class="memproto">
    194. 

  194.       <table class="memname">
    195. 

  195.         <tr>
    196. 

  196.           <td class="memname">void NetConnection::connect </td>
    197. 

  197.           <td>(</td>
    198. 

  198.           <td class="paramtype">remoteAddress&#160;</td>
    199. 

  199.           <td class="paramname"></td><td>)</td>
    200. 

  200.           <td></td>
    201. 

  201.         </tr>
    202. 

  202.       </table>
    203. 

  203. </div><div class="memdoc">
    204. 

  204. <p>Use the connect method to request a connection to a remote server at the address remoteAddress. </p>
    205. 

  205. <dl class="params"><dt>Parameters</dt><dd>
    206. 

  206.   <table class="params">
    207. 

  207.     <tr><td class="paramname">remoteAddress</td><td>A string containing an address of the form: A.B.C.D:Port, where A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536. </td></tr>
    208. 

  208.   </table>
    209. 

  209.   </dd>
    210. 

  210. </dl>
    211. 

  211. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    212. 

  212. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a9a1f87965464ecff12b5f38a51740b36">connectLocal</a>, <a class="el" href="classNetConnection.html#a36094e8fb4028d1d042b85f9229eeece">getAddress</a> </dd></dl>
    213. 

  213. 

  214. </div>
    215. 

  215. </div>
    216. 

  216. <a class="anchor" id="a9a1f87965464ecff12b5f38a51740b36"></a>
    217. 

  217. <div class="memitem">
    218. 

  218. <div class="memproto">
    219. 

  219.       <table class="memname">
    220. 

  220.         <tr>
    221. 

  221.           <td class="memname">string NetConnection::connectLocal </td>
    222. 

  222.           <td>(</td>
    223. 

  223.           <td class="paramname"></td><td>)</td>
    224. 

  224.           <td></td>
    225. 

  225.         </tr>
    226. 

  226.       </table>
    227. 

  227. </div><div class="memdoc">
    228. 

  228. <p>Use the connectLocal method to connect the current client-side connection to a local <a class="el" href="classNetConnection.html">NetConnection</a>, that is to create an internal connection from this client to the internal server. This is accomplished through the use of a back door mechanism and has an extremely high bandwidth. </p>
    229. 

  229. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    230. 

  230. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a816fb14799aad08fb0fc7a8e49433f35">connect</a>, <a class="el" href="classNetConnection.html#a36094e8fb4028d1d042b85f9229eeece">getAddress</a> </dd></dl>
    231. 

  231. 

  232. </div>
    233. 

  233. </div>
    234. 

  234. <a class="anchor" id="a9a1f87965464ecff12b5f38a51740b36"></a>
    235. 

  235. <div class="memitem">
    236. 

  236. <div class="memproto">
    237. 

  237.       <table class="memname">
    238. 

  238.         <tr>
    239. 

  239.           <td class="memname">string NetConnection::connectLocal </td>
    240. 

  240.           <td>(</td>
    241. 

  241.           <td class="paramname"></td><td>)</td>
    242. 

  242.           <td></td>
    243. 

  243.         </tr>
    244. 

  244.       </table>
    245. 

  245. </div><div class="memdoc">
    246. 

  246. <p>Use the connectLocal method to connect the current client-side connection to a local <a class="el" href="classNetConnection.html">NetConnection</a>, that is to create an internal connection from this client to the internal server. This is accomplished through the use of a back door mechanism and has an extremely high bandwidth. </p>
    247. 

  247. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    248. 

  248. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a816fb14799aad08fb0fc7a8e49433f35">connect</a>, <a class="el" href="classNetConnection.html#a36094e8fb4028d1d042b85f9229eeece">getAddress</a> </dd></dl>
    249. 

  249. 

  250. </div>
    251. 

  251. </div>
    252. 

  252. <a class="anchor" id="a36094e8fb4028d1d042b85f9229eeece"></a>
    253. 

  253. <div class="memitem">
    254. 

  254. <div class="memproto">
    255. 

  255.       <table class="memname">
    256. 

  256.         <tr>
    257. 

  257.           <td class="memname">string NetConnection::getAddress </td>
    258. 

  258.           <td>(</td>
    259. 

  259.           <td class="paramname"></td><td>)</td>
    260. 

  260.           <td></td>
    261. 

  261.         </tr>
    262. 

  262.       </table>
    263. 

  263. </div><div class="memdoc">
    264. 

  264. <p>Use the getAddress method to get the address and port that this <a class="el" href="classNetConnection.html">NetConnection</a> is currently attached to. </p>
    265. 

  265. <dl class="section return"><dt>Returns</dt><dd>Returns the address and port that this <a class="el" href="classNetConnection.html">NetConnection</a> is currently attached to, where the addres will be of the form: A.B.C.D:Port. A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536. If the connection is local, the string 'local' will be returned. If a this <a class="el" href="classNetConnection.html">NetConnection</a> is not currently connected the method will return a NULL string. </dd></dl>
    266. 

  266. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a816fb14799aad08fb0fc7a8e49433f35">connect</a>, <a class="el" href="classNetConnection.html#a9a1f87965464ecff12b5f38a51740b36">connectLocal</a> </dd></dl>
    267. 

  267. 

  268. </div>
    269. 

  269. </div>
    270. 

  270. <a class="anchor" id="a36094e8fb4028d1d042b85f9229eeece"></a>
    271. 

  271. <div class="memitem">
    272. 

  272. <div class="memproto">
    273. 

  273.       <table class="memname">
    274. 

  274.         <tr>
    275. 

  275.           <td class="memname">string NetConnection::getAddress </td>
    276. 

  276.           <td>(</td>
    277. 

  277.           <td class="paramname"></td><td>)</td>
    278. 

  278.           <td></td>
    279. 

  279.         </tr>
    280. 

  280.       </table>
    281. 

  281. </div><div class="memdoc">
    282. 

  282. <p>Use the getAddress method to get the address and port that this <a class="el" href="classNetConnection.html">NetConnection</a> is currently attached to. </p>
    283. 

  283. <dl class="section return"><dt>Returns</dt><dd>Returns the address and port that this <a class="el" href="classNetConnection.html">NetConnection</a> is currently attached to, where the addres will be of the form: A.B.C.D:Port. A .. B are standard IP numbers between 0 and 255 and Port can be between 1000 and 65536. If the connection is local, the string 'local' will be returned. If a this <a class="el" href="classNetConnection.html">NetConnection</a> is not currently connected the method will return a NULL string. </dd></dl>
    284. 

  284. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a816fb14799aad08fb0fc7a8e49433f35">connect</a>, <a class="el" href="classNetConnection.html#a9a1f87965464ecff12b5f38a51740b36">connectLocal</a> </dd></dl>
    285. 

  285. 

  286. </div>
    287. 

  287. </div>
    288. 

  288. <a class="anchor" id="a31af5056896cd41800b95ca63ce6de3d"></a>
    289. 

  289. <div class="memitem">
    290. 

  290. <div class="memproto">
    291. 

  291.       <table class="memname">
    292. 

  292.         <tr>
    293. 

  293.           <td class="memname">int NetConnection::getGhostID </td>
    294. 

  294.           <td>(</td>
    295. 

  295.           <td class="paramtype">S32&#160;</td>
    296. 

  296.           <td class="paramname"><em>realID</em></td><td>)</td>
    297. 

  297.           <td></td>
    298. 

  298.         </tr>
    299. 

  299.       </table>
    300. 

  300. </div><div class="memdoc">
    301. 

  301. <p>Convert a real id to the ghost id for this connection.</p>
    302. 

  302. <dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>
    303. 

  303. 

  304. </div>
    305. 

  305. </div>
    306. 

  306. <a class="anchor" id="a31af5056896cd41800b95ca63ce6de3d"></a>
    307. 

  307. <div class="memitem">
    308. 

  308. <div class="memproto">
    309. 

  309.       <table class="memname">
    310. 

  310.         <tr>
    311. 

  311.           <td class="memname">int NetConnection::getGhostID </td>
    312. 

  312.           <td>(</td>
    313. 

  313.           <td class="paramtype">S32&#160;</td>
    314. 

  314.           <td class="paramname"><em>realID</em></td><td>)</td>
    315. 

  315.           <td></td>
    316. 

  316.         </tr>
    317. 

  317.       </table>
    318. 

  318. </div><div class="memdoc">
    319. 

  319. <p>Convert a real id to the ghost id for this connection.</p>
    320. 

  320. <dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>
    321. 

  321. 

  322. </div>
    323. 

  323. </div>
    324. 

  324. <a class="anchor" id="a6f4367652c08cb4500bbb2758e8bdd46"></a>
    325. 

  325. <div class="memitem">
    326. 

  326. <div class="memproto">
    327. 

  327.       <table class="memname">
    328. 

  328.         <tr>
    329. 

  329.           <td class="memname">int NetConnection::getGhostsActive </td>
    330. 

  330.           <td>(</td>
    331. 

  331.           <td class="paramname"></td><td>)</td>
    332. 

  332.           <td></td>
    333. 

  333.         </tr>
    334. 

  334.       </table>
    335. 

  335. </div><div class="memdoc">
    336. 

  336. <p>Use the getGhostsActive method to determine how many ghosts are active on a particular connection. </p>
    337. 

  337. <dl class="section return"><dt>Returns</dt><dd>Returns an integer value between 0 and inf, specifying how many objects are being ghosted to a client on the other side of a specific connection </dd></dl>
    338. 

  338. 

  339. </div>
    340. 

  340. </div>
    341. 

  341. <a class="anchor" id="a6f4367652c08cb4500bbb2758e8bdd46"></a>
    342. 

  342. <div class="memitem">
    343. 

  343. <div class="memproto">
    344. 

  344.       <table class="memname">
    345. 

  345.         <tr>
    346. 

  346.           <td class="memname">int NetConnection::getGhostsActive </td>
    347. 

  347.           <td>(</td>
    348. 

  348.           <td class="paramname"></td><td>)</td>
    349. 

  349.           <td></td>
    350. 

  350.         </tr>
    351. 

  351.       </table>
    352. 

  352. </div><div class="memdoc">
    353. 

  353. <p>Use the getGhostsActive method to determine how many ghosts are active on a particular connection. </p>
    354. 

  354. <dl class="section return"><dt>Returns</dt><dd>Returns an integer value between 0 and inf, specifying how many objects are being ghosted to a client on the other side of a specific connection </dd></dl>
    355. 

  355. 

  356. </div>
    357. 

  357. </div>
    358. 

  358. <a class="anchor" id="a25487d409472ac3e38199fe2f1af3c63"></a>
    359. 

  359. <div class="memitem">
    360. 

  360. <div class="memproto">
    361. 

  361.       <table class="memname">
    362. 

  362.         <tr>
    363. 

  363.           <td class="memname">int NetConnection::getPacketLoss </td>
    364. 

  364.           <td>(</td>
    365. 

  365.           <td class="paramname"></td><td>)</td>
    366. 

  366.           <td></td>
    367. 

  367.         </tr>
    368. 

  368.       </table>
    369. 

  369. </div><div class="memdoc">
    370. 

  370. <p>Use the getPacketLoss method to determine the current packetLoss count for this connection. </p>
    371. 

  371. <dl class="section return"><dt>Returns</dt><dd>Returns an integer value between 0 and inf, indicating the number of packets that have been lost to date on this net connection. </dd></dl>
    372. 

  372. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a2794fb68f7c0fb7584dc75a4423a2238">getPing</a> </dd></dl>
    373. 

  373. 

  374. </div>
    375. 

  375. </div>
    376. 

  376. <a class="anchor" id="a25487d409472ac3e38199fe2f1af3c63"></a>
    377. 

  377. <div class="memitem">
    378. 

  378. <div class="memproto">
    379. 

  379.       <table class="memname">
    380. 

  380.         <tr>
    381. 

  381.           <td class="memname">int NetConnection::getPacketLoss </td>
    382. 

  382.           <td>(</td>
    383. 

  383.           <td class="paramname"></td><td>)</td>
    384. 

  384.           <td></td>
    385. 

  385.         </tr>
    386. 

  386.       </table>
    387. 

  387. </div><div class="memdoc">
    388. 

  388. <p>Use the getPacketLoss method to determine the current packetLoss count for this connection. </p>
    389. 

  389. <dl class="section return"><dt>Returns</dt><dd>Returns an integer value between 0 and inf, indicating the number of packets that have been lost to date on this net connection. </dd></dl>
    390. 

  390. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a2794fb68f7c0fb7584dc75a4423a2238">getPing</a> </dd></dl>
    391. 

  391. 

  392. </div>
    393. 

  393. </div>
    394. 

  394. <a class="anchor" id="a2794fb68f7c0fb7584dc75a4423a2238"></a>
    395. 

  395. <div class="memitem">
    396. 

  396. <div class="memproto">
    397. 

  397.       <table class="memname">
    398. 

  398.         <tr>
    399. 

  399.           <td class="memname">int NetConnection::getPing </td>
    400. 

  400.           <td>(</td>
    401. 

  401.           <td class="paramname"></td><td>)</td>
    402. 

  402.           <td></td>
    403. 

  403.         </tr>
    404. 

  404.       </table>
    405. 

  405. </div><div class="memdoc">
    406. 

  406. <p>Use the getPing method to determine the round-trip travel time from this connection to the agent on the other end and back again. </p>
    407. 

  407. <dl class="section return"><dt>Returns</dt><dd>Returns an integer value representing the total time in milliseconds it takes for a ping request to travel to the agent on the other end of a connection and back to this agent. </dd></dl>
    408. 

  408. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a25487d409472ac3e38199fe2f1af3c63">getPacketLoss</a> </dd></dl>
    409. 

  409. 

  410. </div>
    411. 

  411. </div>
    412. 

  412. <a class="anchor" id="a2794fb68f7c0fb7584dc75a4423a2238"></a>
    413. 

  413. <div class="memitem">
    414. 

  414. <div class="memproto">
    415. 

  415.       <table class="memname">
    416. 

  416.         <tr>
    417. 

  417.           <td class="memname">int NetConnection::getPing </td>
    418. 

  418.           <td>(</td>
    419. 

  419.           <td class="paramname"></td><td>)</td>
    420. 

  420.           <td></td>
    421. 

  421.         </tr>
    422. 

  422.       </table>
    423. 

  423. </div><div class="memdoc">
    424. 

  424. <p>Use the getPing method to determine the round-trip travel time from this connection to the agent on the other end and back again. </p>
    425. 

  425. <dl class="section return"><dt>Returns</dt><dd>Returns an integer value representing the total time in milliseconds it takes for a ping request to travel to the agent on the other end of a connection and back to this agent. </dd></dl>
    426. 

  426. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a25487d409472ac3e38199fe2f1af3c63">getPacketLoss</a> </dd></dl>
    427. 

  427. 

  428. </div>
    429. 

  429. </div>
    430. 

  430. <a class="anchor" id="a3da8ef5bc23fc02405c888190d166e1a"></a>
    431. 

  431. <div class="memitem">
    432. 

  432. <div class="memproto">
    433. 

  433.       <table class="memname">
    434. 

  434.         <tr>
    435. 

  435.           <td class="memname">int NetConnection::resolveGhostID </td>
    436. 

  436.           <td>(</td>
    437. 

  437.           <td class="paramtype">S32&#160;</td>
    438. 

  438.           <td class="paramname"><em>ghostID</em></td><td>)</td>
    439. 

  439.           <td></td>
    440. 

  440.         </tr>
    441. 

  441.       </table>
    442. 

  442. </div><div class="memdoc">
    443. 

  443. <p>Convert a ghost id from this connection to a real id.</p>
    444. 

  444. <dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>
    445. 

  445. 

  446. </div>
    447. 

  447. </div>
    448. 

  448. <a class="anchor" id="a3da8ef5bc23fc02405c888190d166e1a"></a>
    449. 

  449. <div class="memitem">
    450. 

  450. <div class="memproto">
    451. 

  451.       <table class="memname">
    452. 

  452.         <tr>
    453. 

  453.           <td class="memname">int NetConnection::resolveGhostID </td>
    454. 

  454.           <td>(</td>
    455. 

  455.           <td class="paramtype">S32&#160;</td>
    456. 

  456.           <td class="paramname"><em>ghostID</em></td><td>)</td>
    457. 

  457.           <td></td>
    458. 

  458.         </tr>
    459. 

  459.       </table>
    460. 

  460. </div><div class="memdoc">
    461. 

  461. <p>Convert a ghost id from this connection to a real id.</p>
    462. 

  462. <dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>
    463. 

  463. 

  464. </div>
    465. 

  465. </div>
    466. 

  466. <a class="anchor" id="a717d1a961b20a55f84d9f4d410e5f4bc"></a>
    467. 

  467. <div class="memitem">
    468. 

  468. <div class="memproto">
    469. 

  469.       <table class="memname">
    470. 

  470.         <tr>
    471. 

  471.           <td class="memname">int NetConnection::resolveObjectFromGhostIndex </td>
    472. 

  472.           <td>(</td>
    473. 

  473.           <td class="paramtype">S32&#160;</td>
    474. 

  474.           <td class="paramname"><em>ghostIdx</em></td><td>)</td>
    475. 

  475.           <td></td>
    476. 

  476.         </tr>
    477. 

  477.       </table>
    478. 

  478. </div><div class="memdoc">
    479. 

  479. <p>Convert a ghost index from this connection to a real id.</p>
    480. 

  480. <dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>
    481. 

  481. 

  482. </div>
    483. 

  483. </div>
    484. 

  484. <a class="anchor" id="a717d1a961b20a55f84d9f4d410e5f4bc"></a>
    485. 

  485. <div class="memitem">
    486. 

  486. <div class="memproto">
    487. 

  487.       <table class="memname">
    488. 

  488.         <tr>
    489. 

  489.           <td class="memname">int NetConnection::resolveObjectFromGhostIndex </td>
    490. 

  490.           <td>(</td>
    491. 

  491.           <td class="paramtype">S32&#160;</td>
    492. 

  492.           <td class="paramname"><em>ghostIdx</em></td><td>)</td>
    493. 

  493.           <td></td>
    494. 

  494.         </tr>
    495. 

  495.       </table>
    496. 

  496. </div><div class="memdoc">
    497. 

  497. <p>Convert a ghost index from this connection to a real id.</p>
    498. 

  498. <dl class="section return"><dt>Returns</dt><dd>The ID as an integer </dd></dl>
    499. 

  499. 

  500. </div>
    501. 

  501. </div>
    502. 

  502. <a class="anchor" id="ac7cf83874f24b697fc10d68cf4168b20"></a>
    503. 

  503. <div class="memitem">
    504. 

  504. <div class="memproto">
    505. 

  505.       <table class="memname">
    506. 

  506.         <tr>
    507. 

  507.           <td class="memname">void NetConnection::setSimulatedNetParams </td>
    508. 

  508.           <td>(</td>
    509. 

  509.           <td class="paramtype">packetLoss&#160;</td>
    510. 

  510.           <td class="paramname">, </td>
    511. 

  511.         </tr>
    512. 

  512.         <tr>
    513. 

  513.           <td class="paramkey"></td>
    514. 

  514.           <td></td>
    515. 

  515.           <td class="paramtype">delay&#160;</td>
    516. 

  516.           <td class="paramname">&#160;</td>
    517. 

  517.         </tr>
    518. 

  518.         <tr>
    519. 

  519.           <td></td>
    520. 

  520.           <td>)</td>
    521. 

  521.           <td></td><td></td>
    522. 

  522.         </tr>
    523. 

  523.       </table>
    524. 

  524. </div><div class="memdoc">
    525. 

  525. <p>Use the setSimulatedNetParams method to force a connection to experience a certain degree of packet-loss and/or latency. This is a debug feature to allow us to see how a distributed game will behave in the face of poor connection quality. </p>
    526. 

  526. <dl class="params"><dt>Parameters</dt><dd>
    527. 

  527.   <table class="params">
    528. 

  528.     <tr><td class="paramname">packetLoss</td><td>A floating-point value between 0.0 (0%) and 1.0 (100%) dictating the percentage of packets to be artificially lost. </td></tr>
    529. 

  529.     <tr><td class="paramname">delay</td><td>An integer value specifying the number of milliseconds to insert into transmission latencies. </td></tr>
    530. 

  530.   </table>
    531. 

  531.   </dd>
    532. 

  532. </dl>
    533. 

  533. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    534. 

  534. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a25487d409472ac3e38199fe2f1af3c63">getPacketLoss</a>, <a class="el" href="classNetConnection.html#a2794fb68f7c0fb7584dc75a4423a2238">getPing</a> </dd></dl>
    535. 

  535. 

  536. </div>
    537. 

  537. </div>
    538. 

  538. <a class="anchor" id="ac7cf83874f24b697fc10d68cf4168b20"></a>
    539. 

  539. <div class="memitem">
    540. 

  540. <div class="memproto">
    541. 

  541.       <table class="memname">
    542. 

  542.         <tr>
    543. 

  543.           <td class="memname">void NetConnection::setSimulatedNetParams </td>
    544. 

  544.           <td>(</td>
    545. 

  545.           <td class="paramtype">packetLoss&#160;</td>
    546. 

  546.           <td class="paramname">, </td>
    547. 

  547.         </tr>
    548. 

  548.         <tr>
    549. 

  549.           <td class="paramkey"></td>
    550. 

  550.           <td></td>
    551. 

  551.           <td class="paramtype">delay&#160;</td>
    552. 

  552.           <td class="paramname">&#160;</td>
    553. 

  553.         </tr>
    554. 

  554.         <tr>
    555. 

  555.           <td></td>
    556. 

  556.           <td>)</td>
    557. 

  557.           <td></td><td></td>
    558. 

  558.         </tr>
    559. 

  559.       </table>
    560. 

  560. </div><div class="memdoc">
    561. 

  561. <p>Use the setSimulatedNetParams method to force a connection to experience a certain degree of packet-loss and/or latency. This is a debug feature to allow us to see how a distributed game will behave in the face of poor connection quality. </p>
    562. 

  562. <dl class="params"><dt>Parameters</dt><dd>
    563. 

  563.   <table class="params">
    564. 

  564.     <tr><td class="paramname">packetLoss</td><td>A floating-point value between 0.0 (0%) and 1.0 (100%) dictating the percentage of packets to be artificially lost. </td></tr>
    565. 

  565.     <tr><td class="paramname">delay</td><td>An integer value specifying the number of milliseconds to insert into transmission latencies. </td></tr>
    566. 

  566.   </table>
    567. 

  567.   </dd>
    568. 

  568. </dl>
    569. 

  569. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    570. 

  570. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classNetConnection.html#a25487d409472ac3e38199fe2f1af3c63">getPacketLoss</a>, <a class="el" href="classNetConnection.html#a2794fb68f7c0fb7584dc75a4423a2238">getPing</a> </dd></dl>
    571. 

  571. 

  572. </div>
    573. 

  573. </div>
    574. 

  574. <h2 class="groupheader">Member Data Documentation</h2>
    575. 

  575. <a class="anchor" id="a6dc6252d6100838345a01475ae6eec6f"></a>
    576. 

  576. <div class="memitem">
    577. 

  577. <div class="memproto">
    578. 

  578.       <table class="memname">
    579. 

  579.         <tr>
    580. 

  580.           <td class="memname">bool NetConnection::canSaveDynamicFields</td>
    581. 

  581.         </tr>
    582. 

  582.       </table>
    583. 

  583. </div><div class="memdoc">
    584. 

  584. 

  585. </div>
    586. 

  586. </div>
    587. 

  587. <a class="anchor" id="a5688c0e7b1b58c3ba4e5e645a16adc78"></a>
    588. 

  588. <div class="memitem">
    589. 

  589. <div class="memproto">
    590. 

  590.       <table class="memname">
    591. 

  591.         <tr>
    592. 

  592.           <td class="memname">string NetConnection::class</td>
    593. 

  593.         </tr>
    594. 

  594.       </table>
    595. 

  595. </div><div class="memdoc">
    596. 

  596. <p>Script SuperClass of object. </p>
    597. 

  597. 

  598. </div>
    599. 

  599. </div>
    600. 

  600. <a class="anchor" id="a7544cd0bb9fab1f6fa91c8e213ca3649"></a>
    601. 

  601. <div class="memitem">
    602. 

  602. <div class="memproto">
    603. 

  603.       <table class="memname">
    604. 

  604.         <tr>
    605. 

  605.           <td class="memname">string NetConnection::internalName</td>
    606. 

  606.         </tr>
    607. 

  607.       </table>
    608. 

  608. </div><div class="memdoc">
    609. 

  609. 

  610. </div>
    611. 

  611. </div>
    612. 

  612. <a class="anchor" id="aeb4d21bbcfaddcce9783dd190fcebe3e"></a>
    613. 

  613. <div class="memitem">
    614. 

  614. <div class="memproto">
    615. 

  615.       <table class="memname">
    616. 

  616.         <tr>
    617. 

  617.           <td class="memname">SimObjectPtr NetConnection::parentGroup</td>
    618. 

  618.         </tr>
    619. 

  619.       </table>
    620. 

  620. </div><div class="memdoc">
    621. 

  621. <p>Group hierarchy parent of the object. </p>
    622. 

  622. 

  623. </div>
    624. 

  624. </div>
    625. 

  625. <a class="anchor" id="a2cc0b063411d99d571e3cb695708c2e4"></a>
    626. 

  626. <div class="memitem">
    627. 

  627. <div class="memproto">
    628. 

  628.       <table class="memname">
    629. 

  629.         <tr>
    630. 

  630.           <td class="memname">string NetConnection::superclass</td>
    631. 

  631.         </tr>
    632. 

  632.       </table>
    633. 

  633. </div><div class="memdoc">
    634. 

  634. <p>Script Class of object. </p>
    635. 

  635. 

  636. </div>
    637. 

  637. </div>
    638. 

  638. </div><!-- contents -->
    639. 

  639. <!-- START FOOTER -->
    640. 

  640. <br>
    641. 

  641. <br>
    642. 

  642. <center>
    643. 

  643. 	<div style="color: #777777;">
    644. 

  644. 	Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
    645. 

  645. 	</div>
    646. 

  646. </center>
    647. 

  647. </body>
    648. 

  648. </html>
    649.