classRakNet_1_1TM__TeamMember.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674
  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_TeamMember 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__TeamMember.html">TM_TeamMember</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__TeamMember-members.html">List of all members</a> </div>
  56. <div class="headertitle">
  57. <div class="title">RakNet::TM_TeamMember 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>A member of one or more teams.
  61. <a href="classRakNet_1_1TM__TeamMember.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:a964be9af8c1d4e91367406379502ef56"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a964be9af8c1d4e91367406379502ef56">RequestTeam</a> (<a class="el" href="structRakNet_1_1TeamSelection.html">TeamSelection</a> teamSelection)</td></tr>
  67. <tr class="memdesc:a964be9af8c1d4e91367406379502ef56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request to join any team, a specific team, or to leave all teams. <a href="#a964be9af8c1d4e91367406379502ef56"></a><br/></td></tr>
  68. <tr class="separator:a964be9af8c1d4e91367406379502ef56"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a27aaf07915c7c5071064f3c7e7cb78bd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a27aaf07915c7c5071064f3c7e7cb78bd">RequestTeamSwitch</a> (<a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *teamToJoin, <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *teamToLeave)</td></tr>
  70. <tr class="memdesc:a27aaf07915c7c5071064f3c7e7cb78bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Similar to RequestTeam with <a class="el" href="structRakNet_1_1TeamSelection.html#acd3b970f35fa016ee969981f6d4ea1ab" title="Join a specific team if it has available slots, and is tagged with JOIN_SPECIFIC_TEAMS.">TeamSelection::SpecificTeam()</a>, but leave a team simultaneously when the desired team is joinable. <a href="#a27aaf07915c7c5071064f3c7e7cb78bd"></a><br/></td></tr>
  71. <tr class="separator:a27aaf07915c7c5071064f3c7e7cb78bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a392d7b4cf88e7a97e89ec2f974e04822"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structRakNet_1_1TeamSelection.html">TeamSelection</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a392d7b4cf88e7a97e89ec2f974e04822">GetRequestedTeam</a> (void) const </td></tr>
  73. <tr class="memdesc:a392d7b4cf88e7a97e89ec2f974e04822"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the first requested team in the list of requested teams, if you have a requested team at all. <a href="#a392d7b4cf88e7a97e89ec2f974e04822"></a><br/></td></tr>
  74. <tr class="separator:a392d7b4cf88e7a97e89ec2f974e04822"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a64d33e1745f31b05b29efa7fe1db1179"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a64d33e1745f31b05b29efa7fe1db1179">GetRequestedSpecificTeams</a> (<a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> * &gt; &amp;requestedTeams) const </td></tr>
  76. <tr class="memdesc:a64d33e1745f31b05b29efa7fe1db1179"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns pending calls to <a class="el" href="classRakNet_1_1TM__TeamMember.html#a964be9af8c1d4e91367406379502ef56" title="Request to join any team, a specific team, or to leave all teams.">RequestTeam()</a> when using TeamSelection::JOIN_SPECIFIC_TEAM. <a href="#a64d33e1745f31b05b29efa7fe1db1179"></a><br/></td></tr>
  77. <tr class="separator:a64d33e1745f31b05b29efa7fe1db1179"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ac2910cfa4dfa1660e8412132e2f2321f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#ac2910cfa4dfa1660e8412132e2f2321f">HasRequestedTeam</a> (<a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *team) const </td></tr>
  79. <tr class="memdesc:ac2910cfa4dfa1660e8412132e2f2321f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if the specified team is in the list of pending requested teams. <a href="#ac2910cfa4dfa1660e8412132e2f2321f"></a><br/></td></tr>
  80. <tr class="separator:ac2910cfa4dfa1660e8412132e2f2321f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:abb9b5a20845eb0ddabcc0cfc16ce7075"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#abb9b5a20845eb0ddabcc0cfc16ce7075">GetRequestedTeamIndex</a> (<a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *team) const </td></tr>
  82. <tr class="memdesc:abb9b5a20845eb0ddabcc0cfc16ce7075"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the index of <em>team</em> in the requested teams list. <a href="#abb9b5a20845eb0ddabcc0cfc16ce7075"></a><br/></td></tr>
  83. <tr class="separator:abb9b5a20845eb0ddabcc0cfc16ce7075"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a2c1ba2d978dc81f89fea4b819c7a8abb"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a2c1ba2d978dc81f89fea4b819c7a8abb">GetRequestedTeamCount</a> (void) const </td></tr>
  85. <tr class="separator:a2c1ba2d978dc81f89fea4b819c7a8abb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a069f3222b106da18083c3a4405cea355"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a069f3222b106da18083c3a4405cea355">CancelTeamRequest</a> (<a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *specificTeamToCancel)</td></tr>
  87. <tr class="memdesc:a069f3222b106da18083c3a4405cea355"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancels a request to join a specific team. <a href="#a069f3222b106da18083c3a4405cea355"></a><br/></td></tr>
  88. <tr class="separator:a069f3222b106da18083c3a4405cea355"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:adf88d85675c0462ee96eb58c4a1ae29c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#adf88d85675c0462ee96eb58c4a1ae29c">LeaveTeam</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>
  90. <tr class="memdesc:adf88d85675c0462ee96eb58c4a1ae29c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Leave a team. <a href="#adf88d85675c0462ee96eb58c4a1ae29c"></a><br/></td></tr>
  91. <tr class="separator:adf88d85675c0462ee96eb58c4a1ae29c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a8b4a5dd01b92259ad7f7a896ba54bf65"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a8b4a5dd01b92259ad7f7a896ba54bf65">LeaveAllTeams</a> (<a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a> noTeamSubcategory)</td></tr>
  93. <tr class="memdesc:a8b4a5dd01b92259ad7f7a896ba54bf65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Leave all teams Leaves all teams you are on, and sets <em>noTeamSubcategory</em>. <a href="#a8b4a5dd01b92259ad7f7a896ba54bf65"></a><br/></td></tr>
  94. <tr class="separator:a8b4a5dd01b92259ad7f7a896ba54bf65"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a9a0d940b22353dc806fa71bcbac025ee"><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__TeamMember.html#a9a0d940b22353dc806fa71bcbac025ee">GetCurrentTeam</a> (void) const </td></tr>
  96. <tr class="separator:a9a0d940b22353dc806fa71bcbac025ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a994cd7414421f0e01a5cc9c8b5d8c899"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a994cd7414421f0e01a5cc9c8b5d8c899">GetCurrentTeamCount</a> (void) const </td></tr>
  98. <tr class="separator:a994cd7414421f0e01a5cc9c8b5d8c899"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a8c9c72607051fb0c5769cb0d4d9b9744"><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__TeamMember.html#a8c9c72607051fb0c5769cb0d4d9b9744">GetCurrentTeamByIndex</a> (unsigned int index)</td></tr>
  100. <tr class="separator:a8c9c72607051fb0c5769cb0d4d9b9744"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a722e179863d8f3810d6ec1326c8f0782"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a722e179863d8f3810d6ec1326c8f0782">GetCurrentTeams</a> (<a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> * &gt; &amp;_teams) const </td></tr>
  102. <tr class="separator:a722e179863d8f3810d6ec1326c8f0782"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:ad1c944003544544dc286080adb1bff1b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#ad1c944003544544dc286080adb1bff1b">GetLastTeams</a> (<a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> * &gt; &amp;_teams) const </td></tr>
  104. <tr class="separator:ad1c944003544544dc286080adb1bff1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a4473bcb51cb8ef03d80a667947db44fa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a4473bcb51cb8ef03d80a667947db44fa">IsOnTeam</a> (<a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *team) const </td></tr>
  106. <tr class="separator:a4473bcb51cb8ef03d80a667947db44fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a5f8a84aba15b81123840d5b572322f09"><td class="memItemLeft" align="right" valign="top">NetworkID&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a5f8a84aba15b81123840d5b572322f09">GetNetworkID</a> (void) const </td></tr>
  108. <tr class="separator:a5f8a84aba15b81123840d5b572322f09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:abd0b7f8951bc80a89dfc3d0f9c80c48a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRakNet_1_1TM__World.html">TM_World</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#abd0b7f8951bc80a89dfc3d0f9c80c48a">GetTM_World</a> (void) const </td></tr>
  110. <tr class="separator:abd0b7f8951bc80a89dfc3d0f9c80c48a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:acc2508c4ef05bc70eeae8e66adf5cabd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#acc2508c4ef05bc70eeae8e66adf5cabd">SerializeConstruction</a> (<a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> *constructionBitstream)</td></tr>
  112. <tr class="memdesc:acc2508c4ef05bc70eeae8e66adf5cabd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes the current state of this object. <a href="#acc2508c4ef05bc70eeae8e66adf5cabd"></a><br/></td></tr>
  113. <tr class="separator:acc2508c4ef05bc70eeae8e66adf5cabd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:af6f8443d96f77d8fac58cd585ddfbb71"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#af6f8443d96f77d8fac58cd585ddfbb71">DeserializeConstruction</a> (<a class="el" href="classRakNet_1_1TeamManager.html">TeamManager</a> *teamManager, <a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> *constructionBitstream)</td></tr>
  115. <tr class="memdesc:af6f8443d96f77d8fac58cd585ddfbb71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deserializes the current state of this object. <a href="#af6f8443d96f77d8fac58cd585ddfbb71"></a><br/></td></tr>
  116. <tr class="separator:af6f8443d96f77d8fac58cd585ddfbb71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a195772fb3ee3612ad244971f5611e8fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a195772fb3ee3612ad244971f5611e8fc">SetOwner</a> (void *o)</td></tr>
  118. <tr class="separator:a195772fb3ee3612ad244971f5611e8fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a4742174a0be61be1535aa6b54bcaa90e"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a4742174a0be61be1535aa6b54bcaa90e">GetOwner</a> (void) const </td></tr>
  120. <tr class="separator:a4742174a0be61be1535aa6b54bcaa90e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a6fa3ab92747b2455230789e10997f8ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a6fa3ab92747b2455230789e10997f8ea">GetNoTeamId</a> (void) const </td></tr>
  122. <tr class="separator:a6fa3ab92747b2455230789e10997f8ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a4a27ffc59241268111f174f8c43fe663"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a27ffc59241268111f174f8c43fe663"></a>
  124. unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1TM__TeamMember.html#a4a27ffc59241268111f174f8c43fe663">GetWorldIndex</a> (void) const </td></tr>
  125. <tr class="memdesc:a4a27ffc59241268111f174f8c43fe663"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return world-&gt;GetTeamMemberIndex(this) <br/></td></tr>
  126. <tr class="separator:a4a27ffc59241268111f174f8c43fe663"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table>
  128. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  129. <div class="textblock"><p>A member of one or more teams. </p>
  130. <p>Contains data and operations on data to manage which team your game's team members are on. Best used as a composite member of your "User" or "Player" class(es). When using with <a class="el" href="classRakNet_1_1ReplicaManager3.html" title="System to help automate game object construction, destruction, and serialization.">ReplicaManager3</a>, call TM_TeamMember::ReferenceTeamMember() in <a class="el" href="classRakNet_1_1Replica3.html#a8e18c95612054b601ce0149f91a5a34d" title="Read data written by Replica3::SerializeConstruction()">Replica3::DeserializeConstruction()</a> and <a class="el" href="classRakNet_1_1TM__TeamMember.html#af6f8443d96f77d8fac58cd585ddfbb71" title="Deserializes the current state of this object.">TM_TeamMember::DeserializeConstruction()</a> in <a class="el" href="classRakNet_1_1Replica3.html#a7d612c095fa5d81c1c6fabaa1a0f2501">Replica3::PostDeserializeConstruction()</a> There is otherwise no need to manually serialize the class, as operations are networked internally. </p>
  131. </div><h2 class="groupheader">Member Function Documentation</h2>
  132. <a class="anchor" id="a069f3222b106da18083c3a4405cea355"></a>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="memname">
  136. <tr>
  137. <td class="memname">bool RakNet::TM_TeamMember::CancelTeamRequest </td>
  138. <td>(</td>
  139. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  140. <td class="paramname"><em>specificTeamToCancel</em></td><td>)</td>
  141. <td></td>
  142. </tr>
  143. </table>
  144. </div><div class="memdoc">
  145. <p>Cancels a request to join a specific team. </p>
  146. <p>Useful if you got ID_TEAM_BALANCER_REQUESTED_TEAM_FULL or ID_TEAM_BALANCER_REQUESTED_TEAM_LOCKED and changed your mind about joining the team. </p>
  147. <dl class="section note"><dt>Note</dt><dd>This is not guaranteed to work due to latency. To clarify, If the host switches your team at the same time you call CancelRequestTeam() you may still get ID_TEAM_BALANCER_TEAM_ASSIGNED for the team you tried to cancel. </dd></dl>
  148. <dl class="params"><dt>Parameters</dt><dd>
  149. <table class="params">
  150. <tr><td class="paramdir">[in]</td><td class="paramname">specificTeamToCancel</td><td>Which team to no longer join. Use 0 for all. </td></tr>
  151. </table>
  152. </dd>
  153. </dl>
  154. <dl class="section return"><dt>Returns</dt><dd>false On invalid or unnecessary operation. Otherwise returns true </dd></dl>
  155. </div>
  156. </div>
  157. <a class="anchor" id="af6f8443d96f77d8fac58cd585ddfbb71"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">bool RakNet::TM_TeamMember::DeserializeConstruction </td>
  163. <td>(</td>
  164. <td class="paramtype"><a class="el" href="classRakNet_1_1TeamManager.html">TeamManager</a> *&#160;</td>
  165. <td class="paramname"><em>teamManager</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype"><a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> *&#160;</td>
  171. <td class="paramname"><em>constructionBitstream</em>&#160;</td>
  172. </tr>
  173. <tr>
  174. <td></td>
  175. <td>)</td>
  176. <td></td><td></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>Deserializes the current state of this object. </p>
  181. <p>See SerializeConstruction for more details() </p>
  182. <dl class="section note"><dt>Note</dt><dd>DeserializeConstruction also calls ReferenceTeamMember on the passed <em>teamManager</em> instance, there is no need to do so yourself </dd></dl>
  183. <dl class="params"><dt>Parameters</dt><dd>
  184. <table class="params">
  185. <tr><td class="paramdir">[in]</td><td class="paramname">teamManager</td><td><a class="el" href="classRakNet_1_1TeamManager.html" title="Automates networking and list management for teams.">TeamManager</a> instance </td></tr>
  186. <tr><td class="paramdir">[in]</td><td class="paramname">constructionBitstream</td><td>This object serialized to a <a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> </td></tr>
  187. </table>
  188. </dd>
  189. </dl>
  190. </div>
  191. </div>
  192. <a class="anchor" id="a9a0d940b22353dc806fa71bcbac025ee"></a>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a>* RakNet::TM_TeamMember::GetCurrentTeam </td>
  198. <td>(</td>
  199. <td class="paramtype">void&#160;</td>
  200. <td class="paramname"></td><td>)</td>
  201. <td> const</td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <dl class="section return"><dt>Returns</dt><dd>Get the first team we are on, or 0 if we are not on a team. </dd></dl>
  206. </div>
  207. </div>
  208. <a class="anchor" id="a8c9c72607051fb0c5769cb0d4d9b9744"></a>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a>* RakNet::TM_TeamMember::GetCurrentTeamByIndex </td>
  214. <td>(</td>
  215. <td class="paramtype">unsigned int&#160;</td>
  216. <td class="paramname"><em>index</em></td><td>)</td>
  217. <td></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <dl class="section return"><dt>Returns</dt><dd>Returns one of the teams in the current team list, up to <a class="el" href="classRakNet_1_1TM__TeamMember.html#a994cd7414421f0e01a5cc9c8b5d8c899">GetCurrentTeamCount()</a> </dd></dl>
  222. </div>
  223. </div>
  224. <a class="anchor" id="a994cd7414421f0e01a5cc9c8b5d8c899"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">unsigned int RakNet::TM_TeamMember::GetCurrentTeamCount </td>
  230. <td>(</td>
  231. <td class="paramtype">void&#160;</td>
  232. <td class="paramname"></td><td>)</td>
  233. <td> const</td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. <dl class="section return"><dt>Returns</dt><dd>How many teams we are on </dd></dl>
  238. </div>
  239. </div>
  240. <a class="anchor" id="a722e179863d8f3810d6ec1326c8f0782"></a>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname">void RakNet::TM_TeamMember::GetCurrentTeams </td>
  246. <td>(</td>
  247. <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> * &gt; &amp;&#160;</td>
  248. <td class="paramname"><em>_teams</em></td><td>)</td>
  249. <td> const</td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <dl class="params"><dt>Parameters</dt><dd>
  254. <table class="params">
  255. <tr><td class="paramdir">[out]</td><td class="paramname">Get</td><td>all teams we are on, as a list </td></tr>
  256. </table>
  257. </dd>
  258. </dl>
  259. </div>
  260. </div>
  261. <a class="anchor" id="ad1c944003544544dc286080adb1bff1b"></a>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname">void RakNet::TM_TeamMember::GetLastTeams </td>
  267. <td>(</td>
  268. <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> * &gt; &amp;&#160;</td>
  269. <td class="paramname"><em>_teams</em></td><td>)</td>
  270. <td> const</td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. <p>For each team member, when you get ID_TEAM_BALANCER_TEAM_ASSIGNED for that member, the team list is saved. Use this function to get that list, for example to determine which teams we just left or joined </p>
  275. <dl class="params"><dt>Parameters</dt><dd>
  276. <table class="params">
  277. <tr><td class="paramdir">[out]</td><td class="paramname">_teams</td><td>The previous list of teams we were on </td></tr>
  278. </table>
  279. </dd>
  280. </dl>
  281. </div>
  282. </div>
  283. <a class="anchor" id="a5f8a84aba15b81123840d5b572322f09"></a>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">NetworkID RakNet::TM_TeamMember::GetNetworkID </td>
  289. <td>(</td>
  290. <td class="paramtype">void&#160;</td>
  291. <td class="paramname"></td><td>)</td>
  292. <td> const</td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <dl class="section return"><dt>Returns</dt><dd>The teamMemberID parameter passed to <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">TM_World::ReferenceTeamMember()</a> </dd></dl>
  297. </div>
  298. </div>
  299. <a class="anchor" id="a6fa3ab92747b2455230789e10997f8ea"></a>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="memname">
  303. <tr>
  304. <td class="memname"><a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a> RakNet::TM_TeamMember::GetNoTeamId </td>
  305. <td>(</td>
  306. <td class="paramtype">void&#160;</td>
  307. <td class="paramname"></td><td>)</td>
  308. <td> const</td>
  309. </tr>
  310. </table>
  311. </div><div class="memdoc">
  312. <dl class="section return"><dt>Returns</dt><dd>If not on a team, returns the current NoTeamId value </dd></dl>
  313. </div>
  314. </div>
  315. <a class="anchor" id="a4742174a0be61be1535aa6b54bcaa90e"></a>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <table class="memname">
  319. <tr>
  320. <td class="memname">void* RakNet::TM_TeamMember::GetOwner </td>
  321. <td>(</td>
  322. <td class="paramtype">void&#160;</td>
  323. <td class="paramname"></td><td>)</td>
  324. <td> const</td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <dl class="section return"><dt>Returns</dt><dd>Whatever was passed to <a class="el" href="classRakNet_1_1TM__TeamMember.html#a195772fb3ee3612ad244971f5611e8fc">SetOwner()</a> </dd></dl>
  329. </div>
  330. </div>
  331. <a class="anchor" id="a64d33e1745f31b05b29efa7fe1db1179"></a>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="memname">
  335. <tr>
  336. <td class="memname">void RakNet::TM_TeamMember::GetRequestedSpecificTeams </td>
  337. <td>(</td>
  338. <td class="paramtype"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; <a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> * &gt; &amp;&#160;</td>
  339. <td class="paramname"><em>requestedTeams</em></td><td>)</td>
  340. <td> const</td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>Returns pending calls to <a class="el" href="classRakNet_1_1TM__TeamMember.html#a964be9af8c1d4e91367406379502ef56" title="Request to join any team, a specific team, or to leave all teams.">RequestTeam()</a> when using TeamSelection::JOIN_SPECIFIC_TEAM. </p>
  345. <dl class="params"><dt>Parameters</dt><dd>
  346. <table class="params">
  347. <tr><td class="paramdir">[out]</td><td class="paramname">All</td><td>pending requested teams </td></tr>
  348. </table>
  349. </dd>
  350. </dl>
  351. </div>
  352. </div>
  353. <a class="anchor" id="a392d7b4cf88e7a97e89ec2f974e04822"></a>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname"><a class="el" href="structRakNet_1_1TeamSelection.html">TeamSelection</a> RakNet::TM_TeamMember::GetRequestedTeam </td>
  359. <td>(</td>
  360. <td class="paramtype">void&#160;</td>
  361. <td class="paramname"></td><td>)</td>
  362. <td> const</td>
  363. </tr>
  364. </table>
  365. </div><div class="memdoc">
  366. <p>Returns the first requested team in the list of requested teams, if you have a requested team at all. </p>
  367. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structRakNet_1_1TeamSelection.html#acd3b970f35fa016ee969981f6d4ea1ab" title="Join a specific team if it has available slots, and is tagged with JOIN_SPECIFIC_TEAMS.">TeamSelection::SpecificTeam()</a>, <a class="el" href="structRakNet_1_1TeamSelection.html#a1431b86590b2231b7b8f833d58c62699" title="Do not join a team, or leave all current teams.">TeamSelection::NoTeam()</a>, or <a class="el" href="structRakNet_1_1TeamSelection.html#aa5a3260b26e6efa68bd019a3df94cdaf" title="Join any team that has available slots and is tagged with ALLOW_JOIN_ANY_AVAILABLE_TEAM.">TeamSelection::AnyAvailable()</a> </dd></dl>
  368. </div>
  369. </div>
  370. <a class="anchor" id="a2c1ba2d978dc81f89fea4b819c7a8abb"></a>
  371. <div class="memitem">
  372. <div class="memproto">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname">unsigned int RakNet::TM_TeamMember::GetRequestedTeamCount </td>
  376. <td>(</td>
  377. <td class="paramtype">void&#160;</td>
  378. <td class="paramname"></td><td>)</td>
  379. <td> const</td>
  380. </tr>
  381. </table>
  382. </div><div class="memdoc">
  383. <dl class="section return"><dt>Returns</dt><dd>The number of teams that would be returned by a call to <a class="el" href="classRakNet_1_1TM__TeamMember.html#a64d33e1745f31b05b29efa7fe1db1179" title="Returns pending calls to RequestTeam() when using TeamSelection::JOIN_SPECIFIC_TEAM.">GetRequestedSpecificTeams()</a> </dd></dl>
  384. </div>
  385. </div>
  386. <a class="anchor" id="abb9b5a20845eb0ddabcc0cfc16ce7075"></a>
  387. <div class="memitem">
  388. <div class="memproto">
  389. <table class="memname">
  390. <tr>
  391. <td class="memname">unsigned int RakNet::TM_TeamMember::GetRequestedTeamIndex </td>
  392. <td>(</td>
  393. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  394. <td class="paramname"><em>team</em></td><td>)</td>
  395. <td> const</td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Returns the index of <em>team</em> in the requested teams list. </p>
  400. <dl class="params"><dt>Parameters</dt><dd>
  401. <table class="params">
  402. <tr><td class="paramdir">[in]</td><td class="paramname">The</td><td>team we are checking </td></tr>
  403. </table>
  404. </dd>
  405. </dl>
  406. <dl class="section return"><dt>Returns</dt><dd>-1 if we did not requested to join this team. Otherwise the index. </dd></dl>
  407. </div>
  408. </div>
  409. <a class="anchor" id="abd0b7f8951bc80a89dfc3d0f9c80c48a"></a>
  410. <div class="memitem">
  411. <div class="memproto">
  412. <table class="memname">
  413. <tr>
  414. <td class="memname"><a class="el" href="classRakNet_1_1TM__World.html">TM_World</a>* RakNet::TM_TeamMember::GetTM_World </td>
  415. <td>(</td>
  416. <td class="paramtype">void&#160;</td>
  417. <td class="paramname"></td><td>)</td>
  418. <td> const</td>
  419. </tr>
  420. </table>
  421. </div><div class="memdoc">
  422. <dl class="section return"><dt>Returns</dt><dd>The <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 that was used when calling <a class="el" href="classRakNet_1_1TM__World.html#a13c60cbb4d1894aece9e1b1b9887601f" title="Register a TM_TeamMember object with this system.">TM_World::ReferenceTeamMember()</a> </dd></dl>
  423. </div>
  424. </div>
  425. <a class="anchor" id="ac2910cfa4dfa1660e8412132e2f2321f"></a>
  426. <div class="memitem">
  427. <div class="memproto">
  428. <table class="memname">
  429. <tr>
  430. <td class="memname">bool RakNet::TM_TeamMember::HasRequestedTeam </td>
  431. <td>(</td>
  432. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  433. <td class="paramname"><em>team</em></td><td>)</td>
  434. <td> const</td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. <p>Returns if the specified team is in the list of pending requested teams. </p>
  439. <dl class="params"><dt>Parameters</dt><dd>
  440. <table class="params">
  441. <tr><td class="paramdir">[in]</td><td class="paramname">The</td><td>team we are checking </td></tr>
  442. </table>
  443. </dd>
  444. </dl>
  445. <dl class="section return"><dt>Returns</dt><dd>Did we request to join this specific team? </dd></dl>
  446. </div>
  447. </div>
  448. <a class="anchor" id="a4473bcb51cb8ef03d80a667947db44fa"></a>
  449. <div class="memitem">
  450. <div class="memproto">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">bool RakNet::TM_TeamMember::IsOnTeam </td>
  454. <td>(</td>
  455. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  456. <td class="paramname"><em>team</em></td><td>)</td>
  457. <td> const</td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <dl class="params"><dt>Parameters</dt><dd>
  462. <table class="params">
  463. <tr><td class="paramdir">[in]</td><td class="paramname">The</td><td>team we are checking </td></tr>
  464. </table>
  465. </dd>
  466. </dl>
  467. <dl class="section return"><dt>Returns</dt><dd>Are we on this team? </dd></dl>
  468. </div>
  469. </div>
  470. <a class="anchor" id="a8b4a5dd01b92259ad7f7a896ba54bf65"></a>
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">bool RakNet::TM_TeamMember::LeaveAllTeams </td>
  476. <td>(</td>
  477. <td class="paramtype"><a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a>&#160;</td>
  478. <td class="paramname"><em>noTeamSubcategory</em></td><td>)</td>
  479. <td></td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. <p>Leave all teams Leaves all teams you are on, and sets <em>noTeamSubcategory</em>. </p>
  484. <dl class="section note"><dt>Note</dt><dd>This is the same as and just calls RequestTeam(TeamSelection::NoTeam(noTeamSubcategory)); </dd></dl>
  485. <dl class="section return"><dt>Returns</dt><dd>false On invalid or unnecessary operation. Otherwise returns true </dd></dl>
  486. </div>
  487. </div>
  488. <a class="anchor" id="adf88d85675c0462ee96eb58c4a1ae29c"></a>
  489. <div class="memitem">
  490. <div class="memproto">
  491. <table class="memname">
  492. <tr>
  493. <td class="memname">bool RakNet::TM_TeamMember::LeaveTeam </td>
  494. <td>(</td>
  495. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  496. <td class="paramname"><em>team</em>, </td>
  497. </tr>
  498. <tr>
  499. <td class="paramkey"></td>
  500. <td></td>
  501. <td class="paramtype"><a class="el" href="group__TEAM__MANAGER__GROUP.html#gadd1e99b7724ceb0f6794f46de31a6b02">NoTeamId</a>&#160;</td>
  502. <td class="paramname"><em>_noTeamSubcategory</em>&#160;</td>
  503. </tr>
  504. <tr>
  505. <td></td>
  506. <td>)</td>
  507. <td></td><td></td>
  508. </tr>
  509. </table>
  510. </div><div class="memdoc">
  511. <p>Leave a team. </p>
  512. <p>Leaves a team that you are on. Always succeeds provided you are on that team Generates ID_TEAM_BALANCER_TEAM_ASSIGNED on all systems on success. If you leave the last team you are on, <em>noTeamSubcategory</em> is set as well. </p>
  513. <dl class="params"><dt>Parameters</dt><dd>
  514. <table class="params">
  515. <tr><td class="paramdir">[in]</td><td class="paramname">team</td><td>Which team to leave </td></tr>
  516. <tr><td class="paramdir">[in]</td><td class="paramname">_noTeamSubcategory</td><td>If the team member has been removed from all teams, which subcategory of NoTeamId to set them to </td></tr>
  517. </table>
  518. </dd>
  519. </dl>
  520. <dl class="section return"><dt>Returns</dt><dd>false On invalid or unnecessary operation. Otherwise returns true </dd></dl>
  521. </div>
  522. </div>
  523. <a class="anchor" id="a964be9af8c1d4e91367406379502ef56"></a>
  524. <div class="memitem">
  525. <div class="memproto">
  526. <table class="memname">
  527. <tr>
  528. <td class="memname">bool RakNet::TM_TeamMember::RequestTeam </td>
  529. <td>(</td>
  530. <td class="paramtype"><a class="el" href="structRakNet_1_1TeamSelection.html">TeamSelection</a>&#160;</td>
  531. <td class="paramname"><em>teamSelection</em></td><td>)</td>
  532. <td></td>
  533. </tr>
  534. </table>
  535. </div><div class="memdoc">
  536. <p>Request to join any team, a specific team, or to leave all teams. </p>
  537. <p>Function will return false on invalid operations, such as joining a team you are already on. Will also fail with TeamSelection::JOIN_ANY_AVAILABLE_TEAM if you are currently on a team. On success, every system will get ID_TEAM_BALANCER_TEAM_ASSIGNED. Use TeamManager::DecomposeTeamAssigned() to get details of which team member the message refers to. On failure, all systems will get ID_TEAM_BALANCER_REQUESTED_TEAM_FULL or ID_TEAM_BALANCER_REQUESTED_TEAM_LOCKED. Use <a class="el" href="classRakNet_1_1TeamManager.html#a47aa6ab98611642ae31e60f91ea3a4fc" title="When you get ID_TEAM_BALANCER_REQUESTED_TEAM_FULL, pass the packet to this function to read out param...">TeamManager::DecomposeTeamFull()</a> and <a class="el" href="classRakNet_1_1TeamManager.html#a850f25565938281baf0c1b3cba64560d" title="When you get ID_TEAM_BALANCER_REQUESTED_TEAM_LOCKED, pass the packet to this function to read out par...">TeamManager::DecomposeTeamLocked()</a> to get details of which team member the message refers to. </p>
  538. <dl class="section note"><dt>Note</dt><dd>Joining a specific team with this function may result in being on more than one team at once, even if you call the function while locally only on one team. If your game depends on only being on one team at a team, use <a class="el" href="classRakNet_1_1TM__TeamMember.html#a27aaf07915c7c5071064f3c7e7cb78bd" title="Similar to RequestTeam with TeamSelection::SpecificTeam(), but leave a team simultaneously when the d...">RequestTeamSwitch()</a> instead with the parameter teamToLeave set to 0 </dd></dl>
  539. <dl class="params"><dt>Parameters</dt><dd>
  540. <table class="params">
  541. <tr><td class="paramdir">[in]</td><td class="paramname"><a class="el" href="structRakNet_1_1TeamSelection.html#aa5a3260b26e6efa68bd019a3df94cdaf" title="Join any team that has available slots and is tagged with ALLOW_JOIN_ANY_AVAILABLE_TEAM.">TeamSelection::AnyAvailable()</a>,<a class="el" href="structRakNet_1_1TeamSelection.html#acd3b970f35fa016ee969981f6d4ea1ab" title="Join a specific team if it has available slots, and is tagged with JOIN_SPECIFIC_TEAMS.">TeamSelection::SpecificTeam()</a>,or</td><td><a class="el" href="structRakNet_1_1TeamSelection.html#a1431b86590b2231b7b8f833d58c62699" title="Do not join a team, or leave all current teams.">TeamSelection::NoTeam()</a> </td></tr>
  542. </table>
  543. </dd>
  544. </dl>
  545. <dl class="section return"><dt>Returns</dt><dd>false On invalid or unnecessary operation. Otherwise returns true </dd></dl>
  546. </div>
  547. </div>
  548. <a class="anchor" id="a27aaf07915c7c5071064f3c7e7cb78bd"></a>
  549. <div class="memitem">
  550. <div class="memproto">
  551. <table class="memname">
  552. <tr>
  553. <td class="memname">bool RakNet::TM_TeamMember::RequestTeamSwitch </td>
  554. <td>(</td>
  555. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  556. <td class="paramname"><em>teamToJoin</em>, </td>
  557. </tr>
  558. <tr>
  559. <td class="paramkey"></td>
  560. <td></td>
  561. <td class="paramtype"><a class="el" href="classRakNet_1_1TM__Team.html">TM_Team</a> *&#160;</td>
  562. <td class="paramname"><em>teamToLeave</em>&#160;</td>
  563. </tr>
  564. <tr>
  565. <td></td>
  566. <td>)</td>
  567. <td></td><td></td>
  568. </tr>
  569. </table>
  570. </div><div class="memdoc">
  571. <p>Similar to RequestTeam with <a class="el" href="structRakNet_1_1TeamSelection.html#acd3b970f35fa016ee969981f6d4ea1ab" title="Join a specific team if it has available slots, and is tagged with JOIN_SPECIFIC_TEAMS.">TeamSelection::SpecificTeam()</a>, but leave a team simultaneously when the desired team is joinable. </p>
  572. <dl class="params"><dt>Parameters</dt><dd>
  573. <table class="params">
  574. <tr><td class="paramdir">[in]</td><td class="paramname">teamToJoin</td><td>Which team to join </td></tr>
  575. <tr><td class="paramdir">[in]</td><td class="paramname">teamToLeave</td><td>If 0, means leave all current teams. Otherwise, leave the specified team. </td></tr>
  576. </table>
  577. </dd>
  578. </dl>
  579. <dl class="section return"><dt>Returns</dt><dd>false On invalid or unnecessary operation. Otherwise returns true </dd></dl>
  580. </div>
  581. </div>
  582. <a class="anchor" id="acc2508c4ef05bc70eeae8e66adf5cabd"></a>
  583. <div class="memitem">
  584. <div class="memproto">
  585. <table class="memname">
  586. <tr>
  587. <td class="memname">void RakNet::TM_TeamMember::SerializeConstruction </td>
  588. <td>(</td>
  589. <td class="paramtype"><a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> *&#160;</td>
  590. <td class="paramname"><em>constructionBitstream</em></td><td>)</td>
  591. <td></td>
  592. </tr>
  593. </table>
  594. </div><div class="memdoc">
  595. <p>Serializes the current state of this object. </p>
  596. <p>To replicate a <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> on another system, first instantiate the object using your own code, or a system such as <a class="el" href="classRakNet_1_1ReplicaManager3.html" title="System to help automate game object construction, destruction, and serialization.">ReplicaManager3</a>. Next, call <a class="el" href="classRakNet_1_1TM__TeamMember.html#acc2508c4ef05bc70eeae8e66adf5cabd" title="Serializes the current state of this object.">SerializeConstruction()</a> from whichever system owns the team member Last, call <a class="el" href="classRakNet_1_1TM__TeamMember.html#af6f8443d96f77d8fac58cd585ddfbb71" title="Deserializes the current state of this object.">DeserializeConstruction()</a> on the newly created <a class="el" href="classRakNet_1_1TM__TeamMember.html" title="A member of one or more teams.">TM_TeamMember</a> </p>
  597. <dl class="section note"><dt>Note</dt><dd>You must instantiate and deserialize all <a class="el" href="classRakNet_1_1TM__Team.html" title="A team, containing a list of TM_TeamMember instances.">TM_Team</a> instances that the team member refers to before calling DesrializeConstruction(). ReplicaManager3::PostSerializeConstruction() and ReplicaManager3::PostDeserializeConstruction() will ensure this. </dd></dl>
  598. <dl class="params"><dt>Parameters</dt><dd>
  599. <table class="params">
  600. <tr><td class="paramdir">[out]</td><td class="paramname">constructionBitstream</td><td>This object serialized to a <a class="el" href="classRakNet_1_1BitStream.html">BitStream</a> </td></tr>
  601. </table>
  602. </dd>
  603. </dl>
  604. </div>
  605. </div>
  606. <a class="anchor" id="a195772fb3ee3612ad244971f5611e8fc"></a>
  607. <div class="memitem">
  608. <div class="memproto">
  609. <table class="memname">
  610. <tr>
  611. <td class="memname">void RakNet::TM_TeamMember::SetOwner </td>
  612. <td>(</td>
  613. <td class="paramtype">void *&#160;</td>
  614. <td class="paramname"><em>o</em></td><td>)</td>
  615. <td></td>
  616. </tr>
  617. </table>
  618. </div><div class="memdoc">
  619. <dl class="params"><dt>Parameters</dt><dd>
  620. <table class="params">
  621. <tr><td class="paramdir">[in]</td><td class="paramname">o</td><td>Stores a void* for your own use. If using composition, this is useful to store a pointer to the containing object. </td></tr>
  622. </table>
  623. </dd>
  624. </dl>
  625. </div>
  626. </div>
  627. <hr/>The documentation for this class was generated from the following file:<ul>
  628. <li>D:/temp/RakNet_PC/Source/<a class="el" href="TeamManager_8h.html">TeamManager.h</a></li>
  629. </ul>
  630. </div><!-- contents -->
  631. <!-- start footer part -->
  632. <hr class="footer"/><address class="footer"><small>
  633. Generated on Mon Jun 2 2014 20:10:29 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  634. <img class="footer" src="doxygen.png" alt="doxygen"/>
  635. </a> 1.8.2
  636. </small></address>
  637. </body>
  638. </html>
粤ICP备19079148号