| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382 |
- <!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>GameConnection Class Reference</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>
- <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="classGameConnection-members.html">List of all members</a> |
- <a href="#pub-methods">Public Member Functions</a> </div>
- <div class="headertitle">
- <div class="title">GameConnection Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Inherits <a class="el" href="classNetConnection.html">NetConnection</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:aae6f076477c9bee0fe1d22cc4b69385d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#aae6f076477c9bee0fe1d22cc4b69385d">activateGhosting</a> ()</td></tr>
- <tr class="separator:aae6f076477c9bee0fe1d22cc4b69385d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8c1afc71c96219c63948e2a36e104e57"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a8c1afc71c96219c63948e2a36e104e57">delete</a> ([reason])</td></tr>
- <tr class="separator:a8c1afc71c96219c63948e2a36e104e57"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab07ff90379ffea4e33800280af760fe9"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#ab07ff90379ffea4e33800280af760fe9">getServerConnection</a> ()</td></tr>
- <tr class="separator:ab07ff90379ffea4e33800280af760fe9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7e714bcbd2d24eb4b8fa5a44825e07b3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a7e714bcbd2d24eb4b8fa5a44825e07b3">resetGhosting</a> ()</td></tr>
- <tr class="separator:a7e714bcbd2d24eb4b8fa5a44825e07b3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a17819f931be7592b288d81bdd3ad3487"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a17819f931be7592b288d81bdd3ad3487">setConnectArgs</a> (name[, arg1,..., arg15])</td></tr>
- <tr class="separator:a17819f931be7592b288d81bdd3ad3487"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8b6d8c3655724e220aff56dfd475ddb9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a8b6d8c3655724e220aff56dfd475ddb9">setJoinPassword</a> (password)</td></tr>
- <tr class="separator:a8b6d8c3655724e220aff56dfd475ddb9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classNetConnection"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classNetConnection')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classNetConnection.html">NetConnection</a></td></tr>
- <tr class="memitem:ab8475e70ea66bfc544c5491347fe38f4 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#ab8475e70ea66bfc544c5491347fe38f4">checkMaxRate</a> ()</td></tr>
- <tr class="separator:ab8475e70ea66bfc544c5491347fe38f4 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a539defe4d081884888dda262de4e89d0 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a539defe4d081884888dda262de4e89d0">connect</a> (remoteAddress)</td></tr>
- <tr class="separator:a539defe4d081884888dda262de4e89d0 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a995984350042598e0eb95bbadf226745 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a995984350042598e0eb95bbadf226745">connectLocal</a> ()</td></tr>
- <tr class="separator:a995984350042598e0eb95bbadf226745 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abfad7e00431ab14466e3008555eee011 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#abfad7e00431ab14466e3008555eee011">getAddress</a> ()</td></tr>
- <tr class="separator:abfad7e00431ab14466e3008555eee011 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a17376582de3a284244f308a7ea551f47 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a17376582de3a284244f308a7ea551f47">getGhostID</a> (S32 realID)</td></tr>
- <tr class="separator:a17376582de3a284244f308a7ea551f47 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af7b0afc983858a2612e54d892bd0de67 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#af7b0afc983858a2612e54d892bd0de67">getGhostsActive</a> ()</td></tr>
- <tr class="separator:af7b0afc983858a2612e54d892bd0de67 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a632f0cd2948810693bbaf118a2fe00a4 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a632f0cd2948810693bbaf118a2fe00a4">getPacketLoss</a> ()</td></tr>
- <tr class="separator:a632f0cd2948810693bbaf118a2fe00a4 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a92e94648c1f6f34c6bee72f27f1defb4 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a92e94648c1f6f34c6bee72f27f1defb4">getPing</a> ()</td></tr>
- <tr class="separator:a92e94648c1f6f34c6bee72f27f1defb4 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a07157d754490fc6aed64bdedb35f5622 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a07157d754490fc6aed64bdedb35f5622">resolveGhostID</a> (S32 ghostID)</td></tr>
- <tr class="separator:a07157d754490fc6aed64bdedb35f5622 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acdacb0bbe334bba999239e443de59891 inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#acdacb0bbe334bba999239e443de59891">resolveObjectFromGhostIndex</a> (S32 ghostIdx)</td></tr>
- <tr class="separator:acdacb0bbe334bba999239e443de59891 inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2a4c64c516a1358daa85ea8cff510f3d inherit pub_methods_classNetConnection"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a2a4c64c516a1358daa85ea8cff510f3d">setSimulatedNetParams</a> (packetLoss, delay)</td></tr>
- <tr class="separator:a2a4c64c516a1358daa85ea8cff510f3d inherit pub_methods_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr><td colspan="2"><div class="groupHeader">SimBase</div></td></tr>
- <tr class="memitem:abd8e696bb1478e5e012bb9710b15f687"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#abd8e696bb1478e5e012bb9710b15f687">canSaveDynamicFields</a></td></tr>
- <tr class="separator:abd8e696bb1478e5e012bb9710b15f687"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a39473f888e926b4b4a1e0ef36b98d0c4"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a39473f888e926b4b4a1e0ef36b98d0c4">internalName</a></td></tr>
- <tr class="separator:a39473f888e926b4b4a1e0ef36b98d0c4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa419fa9900f505d26ca26104b24a2554"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#aa419fa9900f505d26ca26104b24a2554">parentGroup</a></td></tr>
- <tr class="separator:aa419fa9900f505d26ca26104b24a2554"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Namespace Linking</div></td></tr>
- <tr class="memitem:a46ab78731d39b384e11ee45c0417c231"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#a46ab78731d39b384e11ee45c0417c231">superclass</a></td></tr>
- <tr class="separator:a46ab78731d39b384e11ee45c0417c231"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adac623a9dfc1017c112e0856f6f7216f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classGameConnection.html#adac623a9dfc1017c112e0856f6f7216f">class</a></td></tr>
- <tr class="separator:adac623a9dfc1017c112e0856f6f7216f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_classNetConnection"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classNetConnection')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classNetConnection.html">NetConnection</a></td></tr>
- <tr class="memitem:a6dc6252d6100838345a01475ae6eec6f inherit pub_attribs_classNetConnection"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a6dc6252d6100838345a01475ae6eec6f">canSaveDynamicFields</a></td></tr>
- <tr class="separator:a6dc6252d6100838345a01475ae6eec6f inherit pub_attribs_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7544cd0bb9fab1f6fa91c8e213ca3649 inherit pub_attribs_classNetConnection"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a7544cd0bb9fab1f6fa91c8e213ca3649">internalName</a></td></tr>
- <tr class="separator:a7544cd0bb9fab1f6fa91c8e213ca3649 inherit pub_attribs_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aeb4d21bbcfaddcce9783dd190fcebe3e inherit pub_attribs_classNetConnection"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#aeb4d21bbcfaddcce9783dd190fcebe3e">parentGroup</a></td></tr>
- <tr class="separator:aeb4d21bbcfaddcce9783dd190fcebe3e inherit pub_attribs_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2cc0b063411d99d571e3cb695708c2e4 inherit pub_attribs_classNetConnection"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a2cc0b063411d99d571e3cb695708c2e4">superclass</a></td></tr>
- <tr class="separator:a2cc0b063411d99d571e3cb695708c2e4 inherit pub_attribs_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5688c0e7b1b58c3ba4e5e645a16adc78 inherit pub_attribs_classNetConnection"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classNetConnection.html#a5688c0e7b1b58c3ba4e5e645a16adc78">class</a></td></tr>
- <tr class="separator:a5688c0e7b1b58c3ba4e5e645a16adc78 inherit pub_attribs_classNetConnection"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_classSimGroup"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimGroup')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classSimGroup.html">SimGroup</a></td></tr>
- <tr class="memitem:aa1a278c7138ab2ef4dca24a60c2f19ca inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#aa1a278c7138ab2ef4dca24a60c2f19ca">canSaveDynamicFields</a></td></tr>
- <tr class="separator:aa1a278c7138ab2ef4dca24a60c2f19ca inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad7d60aef9593ead78e46e141eef22741 inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#ad7d60aef9593ead78e46e141eef22741">internalName</a></td></tr>
- <tr class="separator:ad7d60aef9593ead78e46e141eef22741 inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a620ad5d8e74201a9e9216aef954a2a44 inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#a620ad5d8e74201a9e9216aef954a2a44">parentGroup</a></td></tr>
- <tr class="separator:a620ad5d8e74201a9e9216aef954a2a44 inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad64ade6b8b7f43b1dfe019b14255e8b7 inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#ad64ade6b8b7f43b1dfe019b14255e8b7">superclass</a></td></tr>
- <tr class="separator:ad64ade6b8b7f43b1dfe019b14255e8b7 inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7315505335435abdcfbcfd0120b2aee6 inherit pub_attribs_classSimGroup"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimGroup.html#a7315505335435abdcfbcfd0120b2aee6">class</a></td></tr>
- <tr class="separator:a7315505335435abdcfbcfd0120b2aee6 inherit pub_attribs_classSimGroup"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_classSimSet"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimSet')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classSimSet.html">SimSet</a></td></tr>
- <tr class="memitem:a3bb18a691b65cf18937cc4ed585ded69 inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a3bb18a691b65cf18937cc4ed585ded69">canSaveDynamicFields</a></td></tr>
- <tr class="separator:a3bb18a691b65cf18937cc4ed585ded69 inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abee96825d0871986cc0874b1f80c94c9 inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#abee96825d0871986cc0874b1f80c94c9">internalName</a></td></tr>
- <tr class="separator:abee96825d0871986cc0874b1f80c94c9 inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7d10db94dc624cb154e1a2661b174c1a inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a7d10db94dc624cb154e1a2661b174c1a">parentGroup</a></td></tr>
- <tr class="separator:a7d10db94dc624cb154e1a2661b174c1a inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a68606d4133a9392219b4409e1617242f inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a68606d4133a9392219b4409e1617242f">superclass</a></td></tr>
- <tr class="separator:a68606d4133a9392219b4409e1617242f inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8635ee00b4d90c5163c1bdb25542e397 inherit pub_attribs_classSimSet"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a8635ee00b4d90c5163c1bdb25542e397">class</a></td></tr>
- <tr class="separator:a8635ee00b4d90c5163c1bdb25542e397 inherit pub_attribs_classSimSet"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_attribs_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimObject')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
- <tr class="memitem:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab49fae316a2d0c12834f50c3d77202e6">canSaveDynamicFields</a></td></tr>
- <tr class="separator:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad03202387165717f164f996a5b22c9bb">internalName</a></td></tr>
- <tr class="separator:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">SimObjectPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f783d7e37cad2b0a9d6f7b0d1672a28">parentGroup</a></td></tr>
- <tr class="separator:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa0d134072878053537fefb1768b63d3f">superclass</a></td></tr>
- <tr class="separator:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab83c7a59a66018d9b5eec3c8dcd3397d">class</a></td></tr>
- <tr class="separator:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="aae6f076477c9bee0fe1d22cc4b69385d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void GameConnection::activateGhosting </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the activateGhosting method to <a class="el" href="classGameConnection.html">GameConnection</a> instance to start ghosting objects to the client. This is called on each client connection by the server. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGameConnection.html#a7e714bcbd2d24eb4b8fa5a44825e07b3">resetGhosting</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a8c1afc71c96219c63948e2a36e104e57"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void GameConnection::delete </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the delete method to destroy and disconnect the current connection, giving an optional reason. If reason is specified, it will be transmitted to the client/server on the other end of the connection. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">reason</td><td>A string explaining while the connection is being severed. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- <p>Reimplemented from <a class="el" href="classSimObject.html#a0407d340f60883977e60e7414f804be8">SimObject</a>.</p>
- </div>
- </div>
- <a class="anchor" id="ab07ff90379ffea4e33800280af760fe9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual int GameConnection::getServerConnection </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the server connection if any. </p>
- </div>
- </div>
- <a class="anchor" id="a7e714bcbd2d24eb4b8fa5a44825e07b3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void GameConnection::resetGhosting </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the resetGhosting method to reset ghosting. This in effect tells the server to resend each ghost to insure that all objects which should be ghosts and are in fact ghosted. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGameConnection.html#aae6f076477c9bee0fe1d22cc4b69385d">activateGhosting</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a17819f931be7592b288d81bdd3ad3487"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void GameConnection::setConnectArgs </td>
- <td>(</td>
- <td class="paramtype">name </td>
- <td class="paramname">[, arg1,..., arg15]</td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the setConnectArgs method to set the connection arguments for this client-side <a class="el" href="classGameConnection.html">GameConnection</a>. These values will be passed to the server upon establishing a connection. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">name</td><td>Generally, the first argument is the name of the player. </td></tr>
- <tr><td class="paramname">arg1</td><td>... , arg15 - 15 additional arguments may be passed. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGameConnection.html#a8b6d8c3655724e220aff56dfd475ddb9">setJoinPassword</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a8b6d8c3655724e220aff56dfd475ddb9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void GameConnection::setJoinPassword </td>
- <td>(</td>
- <td class="paramtype">password </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Use the setJoinPassword method to set the password required to connect to this server-side <a class="el" href="classGameConnection.html">GameConnection</a>. Pass a NULL string to clear the password. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">password</td><td>A string representing the case insensitive password to use for this server-side <a class="el" href="classGameConnection.html">GameConnection</a>. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classGameConnection.html#a17819f931be7592b288d81bdd3ad3487">setConnectArgs</a> </dd></dl>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a class="anchor" id="abd8e696bb1478e5e012bb9710b15f687"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool GameConnection::canSaveDynamicFields</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="adac623a9dfc1017c112e0856f6f7216f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string GameConnection::class</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Script SuperClass of object. </p>
- </div>
- </div>
- <a class="anchor" id="a39473f888e926b4b4a1e0ef36b98d0c4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string GameConnection::internalName</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="aa419fa9900f505d26ca26104b24a2554"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">SimObjectPtr GameConnection::parentGroup</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Group hierarchy parent of the object. </p>
- </div>
- </div>
- <a class="anchor" id="a46ab78731d39b384e11ee45c0417c231"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string GameConnection::superclass</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Script Class of object. </p>
- </div>
- </div>
- </div><!-- contents -->
- <!-- START FOOTER -->
- <br>
- <br>
- <center>
- <div style="color: #777777;">
- Copyright © 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
- </div>
- </center>
- </body>
- </html>
|