classRakNet_1_1TM__World.html 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>RakNet: RakNet::TM_World Class Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="jquery.js"></script>
  9. <script type="text/javascript" src="dynsections.js"></script>
  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11. </head>
  12. <body>
  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14. <div id="titlearea">
  15. <table cellspacing="0" cellpadding="0">
  16. <tbody>
  17. <tr style="height: 56px;">
  18. <td style="padding-left: 0.5em;">
  19. <div id="projectname">RakNet
  20. &#160;<span id="projectnumber">4.0</span>
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.2 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. <div id="navrow2" class="tabs2">
  40. <ul class="tablist">
  41. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  42. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  43. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  44. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  45. </ul>
  46. </div>
  47. <div id="nav-path" class="navpath">
  48. <ul>
  49. <li class="navelem"><a class="el" href="namespaceRakNet.html">RakNet</a></li><li class="navelem"><a class="el" href="classRakNet_1_1TM__World.html">TM_World</a></li> </ul>
  50. </div>
  51. </div><!-- top -->
  52. <div class="header">
  53. <div class="summary">
  54. <a href="#pub-methods">Public Member Functions</a> &#124;
  55. <a href="classRakNet_1_1TM__World-members.html">List of all members</a> </div>
  56. <div class="headertitle">
  57. <div class="title">RakNet::TM_World Class Reference<div class="ingroups"><a class="el" href="group__TEAM__MANAGER__GROUP.html">TeamManager</a></div></div> </div>
  58. </div><!--header-->
  59. <div class="contents">
  60. <p>Stores a list of teams which may be enforcing a balanced number of members.
  61. <a href="classRakNet_1_1TM__World.html#details">More...</a></p>
  62. <p><code>#include &lt;TeamManager.h&gt;</code></p>
  63. <table class="memberdecls">
  64. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  65. Public Member Functions</h2></td></tr>
  66. <tr class="memitem:a46ee77c66df1ded03e7af23de26d6a21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRakNet_1_1TeamManager.html">TeamManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a46ee77c66df1ded03e7af23de26d6a21">GetTeamManager</a> (void) const </td></tr>
  67. <tr class="separator:a46ee77c66df1ded03e7af23de26d6a21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a75531795fd1adc74d7edae660c4ecc17"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a75531795fd1adc74d7edae660c4ecc17">AddParticipant</a> (<a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> rakNetGUID)</td></tr>
  69. <tr class="memdesc:a75531795fd1adc74d7edae660c4ecc17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new system to send team and team member updates to. <a href="#a75531795fd1adc74d7edae660c4ecc17"></a><br/></td></tr>
  70. <tr class="separator:a75531795fd1adc74d7edae660c4ecc17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a044530223e75239d58e9fedac0f955d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a044530223e75239d58e9fedac0f955d6">RemoveParticipant</a> (<a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> rakNetGUID)</td></tr>
  72. <tr class="memdesc:a044530223e75239d58e9fedac0f955d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a system that was previously added with <a class="el" href="classRakNet_1_1TM__World.html#a75531795fd1adc74d7edae660c4ecc17" title="Add a new system to send team and team member updates to.">AddParticipant()</a> <a href="#a044530223e75239d58e9fedac0f955d6"></a><br/></td></tr>
  73. <tr class="separator:a044530223e75239d58e9fedac0f955d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ac8dcf8b1d3643370b36b4dd01c10e84b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#ac8dcf8b1d3643370b36b4dd01c10e84b">SetAutoManageConnections</a> (bool autoAdd)</td></tr>
  75. <tr class="memdesc:ac8dcf8b1d3643370b36b4dd01c10e84b"><td class="mdescLeft">&#160;</td><td class="mdescRight">If true, all new connections are added to this world using <a class="el" href="classRakNet_1_1TM__World.html#a75531795fd1adc74d7edae660c4ecc17" title="Add a new system to send team and team member updates to.">AddParticipant()</a> <a href="#ac8dcf8b1d3643370b36b4dd01c10e84b"></a><br/></td></tr>
  76. <tr class="separator:ac8dcf8b1d3643370b36b4dd01c10e84b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a15d2a091425d1facb24fc16042a8879a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a15d2a091425d1facb24fc16042a8879a">GetParticipantList</a> (<a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> &gt; &amp;participantList)</td></tr>
  78. <tr class="separator:a15d2a091425d1facb24fc16042a8879a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:ad6a408626e8bd92a9bdcb3dc8709c581"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#ad6a408626e8bd92a9bdcb3dc8709c581">ReferenceTeam</a> (<a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *team, NetworkID networkId, bool applyBalancing)</td></tr>
  80. <tr class="memdesc:ad6a408626e8bd92a9bdcb3dc8709c581"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> object with this system. <a href="#ad6a408626e8bd92a9bdcb3dc8709c581"></a><br/></td></tr>
  81. <tr class="separator:ad6a408626e8bd92a9bdcb3dc8709c581"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a6b5e4a60afeebfb5999e59507ce81bbc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a6b5e4a60afeebfb5999e59507ce81bbc">DereferenceTeam</a> (<a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *team, <a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a> noTeamSubcategory)</td></tr>
  83. <tr class="memdesc:a6b5e4a60afeebfb5999e59507ce81bbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters the associated <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> object with this system. Call when a <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> instance is no longer needed. <a href="#a6b5e4a60afeebfb5999e59507ce81bbc"></a><br/></td></tr>
  84. <tr class="separator:a6b5e4a60afeebfb5999e59507ce81bbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ae86d1f83c9cebe13595baa6ff52dff2a"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#ae86d1f83c9cebe13595baa6ff52dff2a">GetTeamCount</a> (void) const </td></tr>
  86. <tr class="separator:ae86d1f83c9cebe13595baa6ff52dff2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a8c43678d874b42f86499e77a88aa884c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a8c43678d874b42f86499e77a88aa884c">GetTeamByIndex</a> (unsigned int index) const </td></tr>
  88. <tr class="separator:a8c43678d874b42f86499e77a88aa884c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a53c289dec148fba3411ad9caf194b755"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a53c289dec148fba3411ad9caf194b755">GetTeamByNetworkID</a> (NetworkID teamId)</td></tr>
  90. <tr class="separator:a53c289dec148fba3411ad9caf194b755"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a9b5f501e063bcfa0fa132187a809deab"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a9b5f501e063bcfa0fa132187a809deab">GetTeamIndex</a> (const <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *team) const </td></tr>
  92. <tr class="memdesc:a9b5f501e063bcfa0fa132187a809deab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverse of <a class="el" href="classRakNet_1_1TM__World.html#a8c43678d874b42f86499e77a88aa884c">GetTeamByIndex()</a> <a href="#a9b5f501e063bcfa0fa132187a809deab"></a><br/></td></tr>
  93. <tr class="separator:a9b5f501e063bcfa0fa132187a809deab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a13c60cbb4d1894aece9e1b1b9887601f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f">ReferenceTeamMember</a> (<a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a> *teamMember, NetworkID networkId)</td></tr>
  95. <tr class="memdesc:a13c60cbb4d1894aece9e1b1b9887601f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> object with this system. <a href="#a13c60cbb4d1894aece9e1b1b9887601f"></a><br/></td></tr>
  96. <tr class="separator:a13c60cbb4d1894aece9e1b1b9887601f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a165d4a76ef25f863832e2b161f5ad65e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a165d4a76ef25f863832e2b161f5ad65e">DereferenceTeamMember</a> (<a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a> *teamMember)</td></tr>
  98. <tr class="memdesc:a165d4a76ef25f863832e2b161f5ad65e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters the associated <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> object with this system. Call when a <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> instance is no longer needed. <a href="#a165d4a76ef25f863832e2b161f5ad65e"></a><br/></td></tr>
  99. <tr class="separator:a165d4a76ef25f863832e2b161f5ad65e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a15184c05210e998e0423cbd7761d5d14"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a15184c05210e998e0423cbd7761d5d14">GetTeamMemberCount</a> (void) const </td></tr>
  101. <tr class="separator:a15184c05210e998e0423cbd7761d5d14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a379fb348c0e195f8ffb26b1bf9b77d58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a379fb348c0e195f8ffb26b1bf9b77d58">GetTeamMemberByIndex</a> (unsigned int index) const </td></tr>
  103. <tr class="separator:a379fb348c0e195f8ffb26b1bf9b77d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a94e7ff18a9c8d1f8ee15fdc549969a70"><td class="memItemLeft" align="right" valign="top">NetworkID&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a94e7ff18a9c8d1f8ee15fdc549969a70">GetTeamMemberIDByIndex</a> (unsigned int index) const </td></tr>
  105. <tr class="separator:a94e7ff18a9c8d1f8ee15fdc549969a70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ad807e20ea5c412f6dc320ca8791f34ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#ad807e20ea5c412f6dc320ca8791f34ee">GetTeamMemberByNetworkID</a> (NetworkID teamMemberId)</td></tr>
  107. <tr class="separator:ad807e20ea5c412f6dc320ca8791f34ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:abd1031731c52b56fa3c4d7064e77cb0d"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#abd1031731c52b56fa3c4d7064e77cb0d">GetTeamMemberIndex</a> (const <a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a> *teamMember) const </td></tr>
  109. <tr class="memdesc:abd1031731c52b56fa3c4d7064e77cb0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverse of <a class="el" href="classRakNet_1_1TM__World.html#a379fb348c0e195f8ffb26b1bf9b77d58">GetTeamMemberByIndex()</a> <a href="#abd1031731c52b56fa3c4d7064e77cb0d"></a><br/></td></tr>
  110. <tr class="separator:abd1031731c52b56fa3c4d7064e77cb0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a4e7c82a962fd92acc364383598570eca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a4e7c82a962fd92acc364383598570eca">SetBalanceTeams</a> (bool balanceTeams, <a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a> noTeamSubcategory)</td></tr>
  112. <tr class="memdesc:a4e7c82a962fd92acc364383598570eca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force or stop forcing teams to be balanced. <a href="#a4e7c82a962fd92acc364383598570eca"></a><br/></td></tr>
  113. <tr class="separator:a4e7c82a962fd92acc364383598570eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a3084f7e97c4282d6656dd9ce63bb334a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a3084f7e97c4282d6656dd9ce63bb334a">GetBalanceTeams</a> (void) const </td></tr>
  115. <tr class="separator:a3084f7e97c4282d6656dd9ce63bb334a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a8de7c1244f4b38d2ad612c3c98d614ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a8de7c1244f4b38d2ad612c3c98d614ca">SetHost</a> (<a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> _hostGuid)</td></tr>
  117. <tr class="memdesc:a8de7c1244f4b38d2ad612c3c98d614ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the host that will perform balancing calculations and send notifications. <a href="#a8de7c1244f4b38d2ad612c3c98d614ca"></a><br/></td></tr>
  118. <tr class="separator:a8de7c1244f4b38d2ad612c3c98d614ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a89c3bf192788644eb502c7fa68c4b481"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a89c3bf192788644eb502c7fa68c4b481">GetHost</a> (void) const </td></tr>
  120. <tr class="separator:a89c3bf192788644eb502c7fa68c4b481"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a973b1f63787919a8baf3fa890f821d89"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__REPLICA__MANAGER__GROUP3.html#ga44b59af8e882248f61aa41d8ace38bf7">WorldId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#a973b1f63787919a8baf3fa890f821d89">GetWorldId</a> (void) const </td></tr>
  122. <tr class="separator:a973b1f63787919a8baf3fa890f821d89"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:affc5857f6a15ce211e8bd892394c23f5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__World.html#affc5857f6a15ce211e8bd892394c23f5">Clear</a> (void)</td></tr>
  124. <tr class="memdesc:affc5857f6a15ce211e8bd892394c23f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all memory and reset everything. <a href="#affc5857f6a15ce211e8bd892394c23f5"></a><br/></td></tr>
  125. <tr class="separator:affc5857f6a15ce211e8bd892394c23f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table>
  127. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  128. <div class="textblock"><p>Stores a list of teams which may be enforcing a balanced number of members. </p>
  129. <p>Each <a class="el" href="classRakNet_1_1TM__World.html" title="Stores a list of teams which may be enforcing a balanced number of members.">TM_World</a> instance is independent of other <a class="el" href="classRakNet_1_1TM__World.html" title="Stores a list of teams which may be enforcing a balanced number of members.">TM_World</a> world instances. This enables you to host multiple games on a single computer. Not currently supported to have the same <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> or <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> in more than one world at a time, but easily added on request. </p>
  130. </div><h2 class="groupheader">Member Function Documentation</h2>
  131. <a class="anchor" id="a75531795fd1adc74d7edae660c4ecc17"></a>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">void RakNet::TM_World::AddParticipant </td>
  137. <td>(</td>
  138. <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
  139. <td class="paramname"><em>rakNetGUID</em></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Add a new system to send team and team member updates to. </p>
  145. <dl class="params"><dt>Parameters</dt><dd>
  146. <table class="params">
  147. <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGUID</td><td>GUID of the system you are adding. See Packet::rakNetGUID or RakPeerInterface::GetGUIDFromSystemAddress() </td></tr>
  148. </table>
  149. </dd>
  150. </dl>
  151. </div>
  152. </div>
  153. <a class="anchor" id="affc5857f6a15ce211e8bd892394c23f5"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">void RakNet::TM_World::Clear </td>
  159. <td>(</td>
  160. <td class="paramtype">void&#160;</td>
  161. <td class="paramname"></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. <p>Clear all memory and reset everything. </p>
  167. <p>It is up to the user to deallocate pointers passed to <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">ReferenceTeamMember()</a> or <a class="el" href="classRakNet_1_1TM__World.html#ad6a408626e8bd92a9bdcb3dc8709c581" title="Register a TM_Team object with this system.">ReferenceTeam()</a>, if so desired. </p>
  168. </div>
  169. </div>
  170. <a class="anchor" id="a6b5e4a60afeebfb5999e59507ce81bbc"></a>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">void RakNet::TM_World::DereferenceTeam </td>
  176. <td>(</td>
  177. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  178. <td class="paramname"><em>team</em>, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype"><a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a>&#160;</td>
  184. <td class="paramname"><em>noTeamSubcategory</em>&#160;</td>
  185. </tr>
  186. <tr>
  187. <td></td>
  188. <td>)</td>
  189. <td></td><td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Unregisters the associated <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> object with this system. Call when a <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> instance is no longer needed. </p>
  194. <dl class="params"><dt>Parameters</dt><dd>
  195. <table class="params">
  196. <tr><td class="paramdir">[in]</td><td class="paramname">team</td><td>Which team instance to unregister </td></tr>
  197. <tr><td class="paramdir">[in]</td><td class="paramname">noTeamSubcategory</td><td>All players on this team are kicked off. If these players then have no team, they are set to this no team category. </td></tr>
  198. </table>
  199. </dd>
  200. </dl>
  201. </div>
  202. </div>
  203. <a class="anchor" id="a165d4a76ef25f863832e2b161f5ad65e"></a>
  204. <div class="memitem">
  205. <div class="memproto">
  206. <table class="memname">
  207. <tr>
  208. <td class="memname">void RakNet::TM_World::DereferenceTeamMember </td>
  209. <td>(</td>
  210. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a> *&#160;</td>
  211. <td class="paramname"><em>teamMember</em></td><td>)</td>
  212. <td></td>
  213. </tr>
  214. </table>
  215. </div><div class="memdoc">
  216. <p>Unregisters the associated <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> object with this system. Call when a <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> instance is no longer needed. </p>
  217. <dl class="section note"><dt>Note</dt><dd>This is called by the destructor of <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> automatically, so you do not normally need to call this function </dd></dl>
  218. </div>
  219. </div>
  220. <a class="anchor" id="a3084f7e97c4282d6656dd9ce63bb334a"></a>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">bool RakNet::TM_World::GetBalanceTeams </td>
  226. <td>(</td>
  227. <td class="paramtype">void&#160;</td>
  228. <td class="paramname"></td><td>)</td>
  229. <td> const</td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <dl class="section return"><dt>Returns</dt><dd><em>balanceTeams</em> parameter of <a class="el" href="classRakNet_1_1TM__World.html#a4e7c82a962fd92acc364383598570eca" title="Force or stop forcing teams to be balanced.">SetBalanceTeams()</a>, or the default </dd></dl>
  234. </div>
  235. </div>
  236. <a class="anchor" id="a89c3bf192788644eb502c7fa68c4b481"></a>
  237. <div class="memitem">
  238. <div class="memproto">
  239. <table class="memname">
  240. <tr>
  241. <td class="memname"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> RakNet::TM_World::GetHost </td>
  242. <td>(</td>
  243. <td class="paramtype">void&#160;</td>
  244. <td class="paramname"></td><td>)</td>
  245. <td> const</td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <dl class="section return"><dt>Returns</dt><dd>Returns the current host, or UNASSIGNED_RAKNET_GUID if unknown </dd></dl>
  250. </div>
  251. </div>
  252. <a class="anchor" id="a15d2a091425d1facb24fc16042a8879a"></a>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">void RakNet::TM_World::GetParticipantList </td>
  258. <td>(</td>
  259. <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> &gt; &amp;&#160;</td>
  260. <td class="paramname"><em>participantList</em></td><td>)</td>
  261. <td></td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Get the participants added with <a class="el" href="classRakNet_1_1TM__World.html#a75531795fd1adc74d7edae660c4ecc17" title="Add a new system to send team and team member updates to.">AddParticipant()</a> </p>
  266. <dl class="params"><dt>Parameters</dt><dd>
  267. <table class="params">
  268. <tr><td class="paramdir">[out]</td><td class="paramname">participantList</td><td>Participants added with <a class="el" href="classRakNet_1_1TM__World.html#a75531795fd1adc74d7edae660c4ecc17" title="Add a new system to send team and team member updates to.">AddParticipant()</a>; </td></tr>
  269. </table>
  270. </dd>
  271. </dl>
  272. </div>
  273. </div>
  274. <a class="anchor" id="a8c43678d874b42f86499e77a88aa884c"></a>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="memname">
  278. <tr>
  279. <td class="memname"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a>* RakNet::TM_World::GetTeamByIndex </td>
  280. <td>(</td>
  281. <td class="paramtype">unsigned int&#160;</td>
  282. <td class="paramname"><em>index</em></td><td>)</td>
  283. <td> const</td>
  284. </tr>
  285. </table>
  286. </div><div class="memdoc">
  287. <dl class="params"><dt>Parameters</dt><dd>
  288. <table class="params">
  289. <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>A value between 0 and <a class="el" href="classRakNet_1_1TM__World.html#ae86d1f83c9cebe13595baa6ff52dff2a">GetTeamCount()</a> </td></tr>
  290. </table>
  291. </dd>
  292. </dl>
  293. <dl class="section return"><dt>Returns</dt><dd>Returns whatever was passed to <em>team</em> in the function <a class="el" href="classRakNet_1_1TM__World.html#ad6a408626e8bd92a9bdcb3dc8709c581" title="Register a TM_Team object with this system.">ReferenceTeam()</a> in the order it was called. </dd></dl>
  294. </div>
  295. </div>
  296. <a class="anchor" id="a53c289dec148fba3411ad9caf194b755"></a>
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a>* RakNet::TM_World::GetTeamByNetworkID </td>
  302. <td>(</td>
  303. <td class="paramtype">NetworkID&#160;</td>
  304. <td class="paramname"><em>teamId</em></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <dl class="params"><dt>Parameters</dt><dd>
  310. <table class="params">
  311. <tr><td class="paramdir">[in]</td><td class="paramname">teamId</td><td>Value passed to <a class="el" href="classRakNet_1_1TM__World.html#ad6a408626e8bd92a9bdcb3dc8709c581" title="Register a TM_Team object with this system.">ReferenceTeam()</a> </td></tr>
  312. </table>
  313. </dd>
  314. </dl>
  315. <dl class="section return"><dt>Returns</dt><dd>Returns whatever was passed to <em>team</em> in the function <a class="el" href="classRakNet_1_1TM__World.html#ad6a408626e8bd92a9bdcb3dc8709c581" title="Register a TM_Team object with this system.">ReferenceTeam()</a> with this NetworkID. </dd></dl>
  316. </div>
  317. </div>
  318. <a class="anchor" id="ae86d1f83c9cebe13595baa6ff52dff2a"></a>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname">unsigned int RakNet::TM_World::GetTeamCount </td>
  324. <td>(</td>
  325. <td class="paramtype">void&#160;</td>
  326. <td class="paramname"></td><td>)</td>
  327. <td> const</td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <dl class="section return"><dt>Returns</dt><dd>Number of teams uniquely added with <a class="el" href="classRakNet_1_1TM__World.html#ad6a408626e8bd92a9bdcb3dc8709c581" title="Register a TM_Team object with this system.">ReferenceTeam()</a> </dd></dl>
  332. </div>
  333. </div>
  334. <a class="anchor" id="a9b5f501e063bcfa0fa132187a809deab"></a>
  335. <div class="memitem">
  336. <div class="memproto">
  337. <table class="memname">
  338. <tr>
  339. <td class="memname">unsigned int RakNet::TM_World::GetTeamIndex </td>
  340. <td>(</td>
  341. <td class="paramtype">const <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  342. <td class="paramname"><em>team</em></td><td>)</td>
  343. <td> const</td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <p>Inverse of <a class="el" href="classRakNet_1_1TM__World.html#a8c43678d874b42f86499e77a88aa884c">GetTeamByIndex()</a> </p>
  348. <dl class="params"><dt>Parameters</dt><dd>
  349. <table class="params">
  350. <tr><td class="paramdir">[in]</td><td class="paramname">team</td><td>Which taem </td></tr>
  351. </table>
  352. </dd>
  353. </dl>
  354. <dl class="section return"><dt>Returns</dt><dd>The index of the specified team, or -1 if not found </dd></dl>
  355. </div>
  356. </div>
  357. <a class="anchor" id="a46ee77c66df1ded03e7af23de26d6a21"></a>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <table class="memname">
  361. <tr>
  362. <td class="memname"><a class="el" href="classRakNet_1_1TeamManager.html">TeamManager</a>* RakNet::TM_World::GetTeamManager </td>
  363. <td>(</td>
  364. <td class="paramtype">void&#160;</td>
  365. <td class="paramname"></td><td>)</td>
  366. <td> const</td>
  367. </tr>
  368. </table>
  369. </div><div class="memdoc">
  370. <dl class="section return"><dt>Returns</dt><dd>Returns the plugin that created this <a class="el" href="classRakNet_1_1TM__World.html" title="Stores a list of teams which may be enforcing a balanced number of members.">TM_World</a> instance </dd></dl>
  371. </div>
  372. </div>
  373. <a class="anchor" id="a379fb348c0e195f8ffb26b1bf9b77d58"></a>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <table class="memname">
  377. <tr>
  378. <td class="memname"><a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a>* RakNet::TM_World::GetTeamMemberByIndex </td>
  379. <td>(</td>
  380. <td class="paramtype">unsigned int&#160;</td>
  381. <td class="paramname"><em>index</em></td><td>)</td>
  382. <td> const</td>
  383. </tr>
  384. </table>
  385. </div><div class="memdoc">
  386. <dl class="params"><dt>Parameters</dt><dd>
  387. <table class="params">
  388. <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>A value between 0 and <a class="el" href="classRakNet_1_1TM__World.html#a15184c05210e998e0423cbd7761d5d14">GetTeamMemberCount()</a> </td></tr>
  389. </table>
  390. </dd>
  391. </dl>
  392. <dl class="section return"><dt>Returns</dt><dd>Returns whatever was passed to <em>team</em> in the function <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">ReferenceTeamMember()</a> in the order it was called. </dd></dl>
  393. </div>
  394. </div>
  395. <a class="anchor" id="ad807e20ea5c412f6dc320ca8791f34ee"></a>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname"><a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a>* RakNet::TM_World::GetTeamMemberByNetworkID </td>
  401. <td>(</td>
  402. <td class="paramtype">NetworkID&#160;</td>
  403. <td class="paramname"><em>teamMemberId</em></td><td>)</td>
  404. <td></td>
  405. </tr>
  406. </table>
  407. </div><div class="memdoc">
  408. <dl class="params"><dt>Parameters</dt><dd>
  409. <table class="params">
  410. <tr><td class="paramdir">[in]</td><td class="paramname">teamId</td><td>Value passed to <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">ReferenceTeamMember()</a> </td></tr>
  411. </table>
  412. </dd>
  413. </dl>
  414. <dl class="section return"><dt>Returns</dt><dd>Returns Returns whatever was passed to <em>team</em> in the function <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">ReferenceTeamMember()</a> with this NetworkID </dd></dl>
  415. </div>
  416. </div>
  417. <a class="anchor" id="a15184c05210e998e0423cbd7761d5d14"></a>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname">unsigned int RakNet::TM_World::GetTeamMemberCount </td>
  423. <td>(</td>
  424. <td class="paramtype">void&#160;</td>
  425. <td class="paramname"></td><td>)</td>
  426. <td> const</td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <dl class="section return"><dt>Returns</dt><dd>Number of team members uniquely added with <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">ReferenceTeamMember()</a> </dd></dl>
  431. </div>
  432. </div>
  433. <a class="anchor" id="a94e7ff18a9c8d1f8ee15fdc549969a70"></a>
  434. <div class="memitem">
  435. <div class="memproto">
  436. <table class="memname">
  437. <tr>
  438. <td class="memname">NetworkID RakNet::TM_World::GetTeamMemberIDByIndex </td>
  439. <td>(</td>
  440. <td class="paramtype">unsigned int&#160;</td>
  441. <td class="paramname"><em>index</em></td><td>)</td>
  442. <td> const</td>
  443. </tr>
  444. </table>
  445. </div><div class="memdoc">
  446. <dl class="params"><dt>Parameters</dt><dd>
  447. <table class="params">
  448. <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>A value between 0 and <a class="el" href="classRakNet_1_1TM__World.html#a15184c05210e998e0423cbd7761d5d14">GetTeamMemberCount()</a> </td></tr>
  449. </table>
  450. </dd>
  451. </dl>
  452. <dl class="section return"><dt>Returns</dt><dd>Returns whatever was passed to <em>teamMemberID</em> in the function <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">ReferenceTeamMember()</a> in the order it was called. </dd></dl>
  453. </div>
  454. </div>
  455. <a class="anchor" id="abd1031731c52b56fa3c4d7064e77cb0d"></a>
  456. <div class="memitem">
  457. <div class="memproto">
  458. <table class="memname">
  459. <tr>
  460. <td class="memname">unsigned int RakNet::TM_World::GetTeamMemberIndex </td>
  461. <td>(</td>
  462. <td class="paramtype">const <a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a> *&#160;</td>
  463. <td class="paramname"><em>teamMember</em></td><td>)</td>
  464. <td> const</td>
  465. </tr>
  466. </table>
  467. </div><div class="memdoc">
  468. <p>Inverse of <a class="el" href="classRakNet_1_1TM__World.html#a379fb348c0e195f8ffb26b1bf9b77d58">GetTeamMemberByIndex()</a> </p>
  469. <dl class="params"><dt>Parameters</dt><dd>
  470. <table class="params">
  471. <tr><td class="paramdir">[in]</td><td class="paramname">team</td><td>Which team member </td></tr>
  472. </table>
  473. </dd>
  474. </dl>
  475. <dl class="section return"><dt>Returns</dt><dd>The index of the specified team member, or -1 if not found </dd></dl>
  476. </div>
  477. </div>
  478. <a class="anchor" id="a973b1f63787919a8baf3fa890f821d89"></a>
  479. <div class="memitem">
  480. <div class="memproto">
  481. <table class="memname">
  482. <tr>
  483. <td class="memname"><a class="el" href="group__REPLICA__MANAGER__GROUP3.html#ga44b59af8e882248f61aa41d8ace38bf7">WorldId</a> RakNet::TM_World::GetWorldId </td>
  484. <td>(</td>
  485. <td class="paramtype">void&#160;</td>
  486. <td class="paramname"></td><td>)</td>
  487. <td> const</td>
  488. </tr>
  489. </table>
  490. </div><div class="memdoc">
  491. <dl class="section return"><dt>Returns</dt><dd>The <em>worldId</em> passed to TeamManagr::AddWorld() </dd></dl>
  492. </div>
  493. </div>
  494. <a class="anchor" id="ad6a408626e8bd92a9bdcb3dc8709c581"></a>
  495. <div class="memitem">
  496. <div class="memproto">
  497. <table class="memname">
  498. <tr>
  499. <td class="memname">void RakNet::TM_World::ReferenceTeam </td>
  500. <td>(</td>
  501. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  502. <td class="paramname"><em>team</em>, </td>
  503. </tr>
  504. <tr>
  505. <td class="paramkey"></td>
  506. <td></td>
  507. <td class="paramtype">NetworkID&#160;</td>
  508. <td class="paramname"><em>networkId</em>, </td>
  509. </tr>
  510. <tr>
  511. <td class="paramkey"></td>
  512. <td></td>
  513. <td class="paramtype">bool&#160;</td>
  514. <td class="paramname"><em>applyBalancing</em>&#160;</td>
  515. </tr>
  516. <tr>
  517. <td></td>
  518. <td>)</td>
  519. <td></td><td></td>
  520. </tr>
  521. </table>
  522. </div><div class="memdoc">
  523. <p>Register a <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> object with this system. </p>
  524. <p>Your game should contain instances of <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a>, for example by using composition with your game's Team or PlayerList class Tell <a class="el" href="classRakNet_1_1TeamManager.html" title="Automates networking and list management for teams.">TeamManager</a> about these instances using <a class="el" href="classRakNet_1_1TM__World.html#ad6a408626e8bd92a9bdcb3dc8709c581" title="Register a TM_Team object with this system.">ReferenceTeam()</a>. </p>
  525. <dl class="section note"><dt>Note</dt><dd>The destrutor of <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> calls <a class="el" href="classRakNet_1_1TM__World.html#a6b5e4a60afeebfb5999e59507ce81bbc" title="Unregisters the associated TM_Team object with this system. Call when a TM_Team instance is no longer...">DereferenceTeam()</a> automatically. </dd></dl>
  526. <dl class="params"><dt>Parameters</dt><dd>
  527. <table class="params">
  528. <tr><td class="paramdir">[in]</td><td class="paramname">team</td><td>The instance you are registering </td></tr>
  529. <tr><td class="paramdir">[in]</td><td class="paramname">networkId</td><td>Identifies this instance. This value is independent of values used by <a class="el" href="classRakNet_1_1NetworkIDManager.html">NetworkIDManager</a>. You can use the same value as the object that contains this instance. </td></tr>
  530. <tr><td class="paramdir">[in]</td><td class="paramname">applyBalancing</td><td>Whether or not to include this team for balancing when calling <a class="el" href="classRakNet_1_1TM__World.html#a4e7c82a962fd92acc364383598570eca" title="Force or stop forcing teams to be balanced.">SetBalanceTeams()</a>. </td></tr>
  531. </table>
  532. </dd>
  533. </dl>
  534. </div>
  535. </div>
  536. <a class="anchor" id="a13c60cbb4d1894aece9e1b1b9887601f"></a>
  537. <div class="memitem">
  538. <div class="memproto">
  539. <table class="memname">
  540. <tr>
  541. <td class="memname">void RakNet::TM_World::ReferenceTeamMember </td>
  542. <td>(</td>
  543. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__TeamMember.html">TM_TeamMember</a> *&#160;</td>
  544. <td class="paramname"><em>teamMember</em>, </td>
  545. </tr>
  546. <tr>
  547. <td class="paramkey"></td>
  548. <td></td>
  549. <td class="paramtype">NetworkID&#160;</td>
  550. <td class="paramname"><em>networkId</em>&#160;</td>
  551. </tr>
  552. <tr>
  553. <td></td>
  554. <td>)</td>
  555. <td></td><td></td>
  556. </tr>
  557. </table>
  558. </div><div class="memdoc">
  559. <p>Register a <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> object with this system. </p>
  560. <p>Your game should contain instances of <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a>, for example by using composition with your game's User or Player classes Tell <a class="el" href="classRakNet_1_1TeamManager.html" title="Automates networking and list management for teams.">TeamManager</a> about these instances using <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">ReferenceTeamMember()</a>. </p>
  561. <dl class="section note"><dt>Note</dt><dd>The destrutor of <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> calls <a class="el" href="classRakNet_1_1TM__World.html#a165d4a76ef25f863832e2b161f5ad65e" title="Unregisters the associated TM_TeamMember object with this system. Call when a TM_TeamMember instance ...">DereferenceTeamMember()</a> automatically. </dd></dl>
  562. <dl class="params"><dt>Parameters</dt><dd>
  563. <table class="params">
  564. <tr><td class="paramdir">[in]</td><td class="paramname">teamMember</td><td>The instance you are registering </td></tr>
  565. <tr><td class="paramdir">[in]</td><td class="paramname">networkId</td><td>Identifies this instance. This value is independent of values used by <a class="el" href="classRakNet_1_1NetworkIDManager.html">NetworkIDManager</a>. You can use the same value as the object that contains this instance </td></tr>
  566. </table>
  567. </dd>
  568. </dl>
  569. </div>
  570. </div>
  571. <a class="anchor" id="a044530223e75239d58e9fedac0f955d6"></a>
  572. <div class="memitem">
  573. <div class="memproto">
  574. <table class="memname">
  575. <tr>
  576. <td class="memname">void RakNet::TM_World::RemoveParticipant </td>
  577. <td>(</td>
  578. <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
  579. <td class="paramname"><em>rakNetGUID</em></td><td>)</td>
  580. <td></td>
  581. </tr>
  582. </table>
  583. </div><div class="memdoc">
  584. <p>Remove a system that was previously added with <a class="el" href="classRakNet_1_1TM__World.html#a75531795fd1adc74d7edae660c4ecc17" title="Add a new system to send team and team member updates to.">AddParticipant()</a> </p>
  585. <p>Systems that disconnect are removed automatically </p>
  586. <dl class="params"><dt>Parameters</dt><dd>
  587. <table class="params">
  588. <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGUID</td><td>GUID of the system you are removing. See Packet::rakNetGUID or RakPeerInterface::GetGUIDFromSystemAddress() </td></tr>
  589. </table>
  590. </dd>
  591. </dl>
  592. </div>
  593. </div>
  594. <a class="anchor" id="ac8dcf8b1d3643370b36b4dd01c10e84b"></a>
  595. <div class="memitem">
  596. <div class="memproto">
  597. <table class="memname">
  598. <tr>
  599. <td class="memname">void RakNet::TM_World::SetAutoManageConnections </td>
  600. <td>(</td>
  601. <td class="paramtype">bool&#160;</td>
  602. <td class="paramname"><em>autoAdd</em></td><td>)</td>
  603. <td></td>
  604. </tr>
  605. </table>
  606. </div><div class="memdoc">
  607. <p>If true, all new connections are added to this world using <a class="el" href="classRakNet_1_1TM__World.html#a75531795fd1adc74d7edae660c4ecc17" title="Add a new system to send team and team member updates to.">AddParticipant()</a> </p>
  608. <p>Defaults to true </p>
  609. <dl class="params"><dt>Parameters</dt><dd>
  610. <table class="params">
  611. <tr><td class="paramdir">[in]</td><td class="paramname">autoAdd</td><td>Setting to set </td></tr>
  612. </table>
  613. </dd>
  614. </dl>
  615. </div>
  616. </div>
  617. <a class="anchor" id="a4e7c82a962fd92acc364383598570eca"></a>
  618. <div class="memitem">
  619. <div class="memproto">
  620. <table class="memname">
  621. <tr>
  622. <td class="memname">bool RakNet::TM_World::SetBalanceTeams </td>
  623. <td>(</td>
  624. <td class="paramtype">bool&#160;</td>
  625. <td class="paramname"><em>balanceTeams</em>, </td>
  626. </tr>
  627. <tr>
  628. <td class="paramkey"></td>
  629. <td></td>
  630. <td class="paramtype"><a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a>&#160;</td>
  631. <td class="paramname"><em>noTeamSubcategory</em>&#160;</td>
  632. </tr>
  633. <tr>
  634. <td></td>
  635. <td>)</td>
  636. <td></td><td></td>
  637. </tr>
  638. </table>
  639. </div><div class="memdoc">
  640. <p>Force or stop forcing teams to be balanced. </p>
  641. <p>For each team added with <a class="el" href="classRakNet_1_1TM__World.html#ad6a408626e8bd92a9bdcb3dc8709c581" title="Register a TM_Team object with this system.">ReferenceTeam()</a> and <em>applyBalancing</em> set to true, players on unbalanced teams will be redistributed While active, players can only join balanced teams if doing so would not cause that team to become unbalanced. If a player on the desired team also wants to switch, then both players will switch simultaneously. Otherwise, ID_TEAM_BALANCER_REQUESTED_TEAM_FULL will be returned to the requester and switching will occur when possible. If balanceTeams is true and later set to false, players waiting on ID_TEAM_BALANCER_REQUESTED_TEAM_FULL will be able to join the desired team immediately provided it is not full. </p>
  642. <dl class="params"><dt>Parameters</dt><dd>
  643. <table class="params">
  644. <tr><td class="paramdir">[in]</td><td class="paramname">balanceTeams</td><td>Whether to activate or deactivate team balancing. </td></tr>
  645. <tr><td class="paramdir">[in]</td><td class="paramname">noTeamSubcategory</td><td>If a player is kicked off a team and is no longer on any team, his or her noTeamSubcategory is set to this value </td></tr>
  646. </table>
  647. </dd>
  648. </dl>
  649. </div>
  650. </div>
  651. <a class="anchor" id="a8de7c1244f4b38d2ad612c3c98d614ca"></a>
  652. <div class="memitem">
  653. <div class="memproto">
  654. <table class="memname">
  655. <tr>
  656. <td class="memname">void RakNet::TM_World::SetHost </td>
  657. <td>(</td>
  658. <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
  659. <td class="paramname"><em>_hostGuid</em></td><td>)</td>
  660. <td></td>
  661. </tr>
  662. </table>
  663. </div><div class="memdoc">
  664. <p>Set the host that will perform balancing calculations and send notifications. </p>
  665. <p>Operations that can cause conflicts due to latency, such as joining teams, are operated on by the host. The result is sent to all systems added with <a class="el" href="classRakNet_1_1TM__World.html#a75531795fd1adc74d7edae660c4ecc17" title="Add a new system to send team and team member updates to.">AddParticipant()</a> For a client/server game, call <a class="el" href="classRakNet_1_1TM__World.html#a8de7c1244f4b38d2ad612c3c98d614ca" title="Set the host that will perform balancing calculations and send notifications.">SetHost()</a> with the server's <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> value on all systems (including the server itself). If you call TeamManager::SetTopology(TM_CLIENT_SERVER), the server will also relay messages between participants. For a peer to peer game, call <a class="el" href="classRakNet_1_1TM__World.html#a8de7c1244f4b38d2ad612c3c98d614ca" title="Set the host that will perform balancing calculations and send notifications.">SetHost()</a> on the same peer when host migration occurs. Use TeamManager::SetTopology(TM_PEER_TO_PEER) in this case. </p>
  666. <dl class="section note"><dt>Note</dt><dd>If using FullyConnectedMesh2, <a class="el" href="classRakNet_1_1TM__World.html#a8de7c1244f4b38d2ad612c3c98d614ca" title="Set the host that will perform balancing calculations and send notifications.">SetHost()</a> is called automatically when ID_FCM2_NEW_HOST is returned. </dd></dl>
  667. <dl class="params"><dt>Parameters</dt><dd>
  668. <table class="params">
  669. <tr><td class="paramdir">[in]</td><td class="paramname">_hostGuid</td><td>The host, which is the system that will serialize and resolve team disputes and calculate team balancing. </td></tr>
  670. </table>
  671. </dd>
  672. </dl>
  673. </div>
  674. </div>
  675. <hr/>The documentation for this class was generated from the following file:<ul>
  676. <li>D:/temp/RakNet_PC/Source/<a class="el" href="TeamManager_8h.html">TeamManager.h</a></li>
  677. </ul>
  678. </div><!-- contents -->
  679. <!-- start footer part -->
  680. <hr class="footer"/><address class="footer"><small>
  681. Generated on Mon Jun 2 2014 20:10:29 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  682. <img class="footer" src="doxygen.png" alt="doxygen"/>
  683. </a> 1.8.2
  684. </small></address>
  685. </body>
  686. </html>
粤ICP备19079148号