Inicio Explorar Ayuda
Registro Iniciar sesión
samien
/
RakNet
1
0
Fork 0
Archivos Incidencias 0 Pull Requests 0 Wiki
Rama: master
Ramas Etiquetas
RakNet
/
Help
/
Doxygen
/
html
/
classRakNet_1_1RoomsPlugin.html

classRakNet_1_1RoomsPlugin.html 56 KB
Permalink Histórico Raw

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

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

  3. <head>
    4. 

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

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <title>RakNet: RakNet::RoomsPlugin Class Reference</title>
    7. 

  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    8. 

  8. <script type="text/javascript" src="jquery.js"></script>
    9. 

  9. <script type="text/javascript" src="dynsections.js"></script>
    10. 

  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    14. 

  14. <div id="titlearea">
    15. 

  15. <table cellspacing="0" cellpadding="0">
    16. 

  16.  <tbody>
    17. 

  17.  <tr style="height: 56px;">
    18. 

  18.   <td style="padding-left: 0.5em;">
    19. 

  19.    <div id="projectname">RakNet
    20. 

  20.    &#160;<span id="projectnumber">4.0</span>
    21. 

  21.    </div>
    22. 

  22.   </td>
    23. 

  23.  </tr>
    24. 

  24.  </tbody>
    25. 

  25. </table>
    26. 

  26. </div>
    27. 

  27. <!-- end header part -->
    28. 

  28. <!-- Generated by Doxygen 1.8.2 -->
    29. 

  29.   <div id="navrow1" class="tabs">
    30. 

  30.     <ul class="tablist">
    31. 

  31.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    32. 

  32.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    33. 

  33.       <li><a href="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    35. 

  35.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    36. 

  36.       <li><a href="files.html"><span>Files</span></a></li>
    37. 

  37.     </ul>
    38. 

  38.   </div>
    39. 

  39.   <div id="navrow2" class="tabs2">
    40. 

  40.     <ul class="tablist">
    41. 

  41.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
    42. 

  42.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
    43. 

  43.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
    44. 

  44.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    45. 

  45.     </ul>
    46. 

  46.   </div>
    47. 

  47. <div id="nav-path" class="navpath">
    48. 

  48.   <ul>
    49. 

  49. <li class="navelem"><a class="el" href="namespaceRakNet.html">RakNet</a></li><li class="navelem"><a class="el" href="classRakNet_1_1RoomsPlugin.html">RoomsPlugin</a></li>  </ul>
    50. 

  50. </div>
    51. 

  51. </div><!-- top -->
    52. 

  52. <div class="header">
    53. 

  53.   <div class="summary">
    54. 

  54. <a href="#pub-methods">Public Member Functions</a> &#124;
    55. 

  55. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
    56. 

  56. <a href="#pub-attribs">Public Attributes</a> &#124;
    57. 

  57. <a href="classRakNet_1_1RoomsPlugin-members.html">List of all members</a>  </div>
    58. 

  58.   <div class="headertitle">
    59. 

  59. <div class="title">RakNet::RoomsPlugin Class Reference<div class="ingroups"><a class="el" href="group__ROOMS__GROUP.html">RoomsPlugin</a></div></div>  </div>
    60. 

  60. </div><!--header-->
    61. 

  61. <div class="contents">
    62. 

  62. 

  63. <p>Used to create rooms for players where they can matchmake.  
    64. 

  64.  <a href="classRakNet_1_1RoomsPlugin.html#details">More...</a></p>
    65. 

  65. 

  66. <p><code>#include &lt;RoomsPlugin.h&gt;</code></p>
    67. 

  67. <div class="dynheader">
    68. 

  68. Inheritance diagram for RakNet::RoomsPlugin:</div>
    69. 

  69. <div class="dyncontent">
    70. 

  70.  <div class="center">
    71. 

  71.   <img src="classRakNet_1_1RoomsPlugin.png" usemap="#RakNet::RoomsPlugin_map" alt=""/>
    72. 

  72.   <map id="RakNet::RoomsPlugin_map" name="RakNet::RoomsPlugin_map">
    73. 

  73. <area href="classRakNet_1_1PluginInterface2.html" alt="RakNet::PluginInterface2" shape="rect" coords="0,0,150,24"/>
    74. 

  74. </map>
    75. 

  75.  </div></div>
    76. 

  76. <table class="memberdecls">
    77. 

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

  78. Public Member Functions</h2></td></tr>
    79. 

  79. <tr class="memitem:a14cfd5d620048075b0240e17f1480f59"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a14cfd5d620048075b0240e17f1480f59">SetOrderingChannel</a> (char oc)</td></tr>
    80. 

  80. <tr class="memdesc:a14cfd5d620048075b0240e17f1480f59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ordering channel to send messages on.  <a href="#a14cfd5d620048075b0240e17f1480f59"></a><br/></td></tr>
    81. 

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

  82. <tr class="memitem:a21bd54606b77dfb03b9b8ad6654e958c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a21bd54606b77dfb03b9b8ad6654e958c">SetSendPriority</a> (<a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a> pp)</td></tr>
    83. 

  83. <tr class="memdesc:a21bd54606b77dfb03b9b8ad6654e958c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send priority to send messages on.  <a href="#a21bd54606b77dfb03b9b8ad6654e958c"></a><br/></td></tr>
    84. 

  84. <tr class="separator:a21bd54606b77dfb03b9b8ad6654e958c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    85. 

  85. <tr class="memitem:a92be4d16a2a000e1547750ac667c627f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a92be4d16a2a000e1547750ac667c627f">SetRoomsCallback</a> (RoomsCallback *_roomsCallback)</td></tr>
    86. 

  86. <tr class="memdesc:a92be4d16a2a000e1547750ac667c627f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the callback to get notification and <a class="el" href="classRakNet_1_1RoomsPlugin.html#a88194af5ce6cbc83a1af4b4bae7c56b1" title="Execute a function, using the system address passed to SetServerAddress();.">ExecuteFunc()</a> results.  <a href="#a92be4d16a2a000e1547750ac667c627f"></a><br/></td></tr>
    87. 

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

  88. <tr class="memitem:af5b0ede7fe5bc2dd5e3cf113a69460c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#af5b0ede7fe5bc2dd5e3cf113a69460c0">AddRoomsCallback</a> (RoomsCallback *_roomsCallback)</td></tr>
    89. 

  89. <tr class="memdesc:af5b0ede7fe5bc2dd5e3cf113a69460c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a callback to get notification and <a class="el" href="classRakNet_1_1RoomsPlugin.html#a88194af5ce6cbc83a1af4b4bae7c56b1" title="Execute a function, using the system address passed to SetServerAddress();.">ExecuteFunc()</a> results.  <a href="#af5b0ede7fe5bc2dd5e3cf113a69460c0"></a><br/></td></tr>
    90. 

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

  91. <tr class="memitem:aa4f30b65c7dec91c6b35670e7bccc45a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#aa4f30b65c7dec91c6b35670e7bccc45a">RemoveRoomsCallback</a> (RoomsCallback *_roomsCallback)</td></tr>
    92. 

  92. <tr class="memdesc:aa4f30b65c7dec91c6b35670e7bccc45a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a callback to get notification and <a class="el" href="classRakNet_1_1RoomsPlugin.html#a88194af5ce6cbc83a1af4b4bae7c56b1" title="Execute a function, using the system address passed to SetServerAddress();.">ExecuteFunc()</a> results.  <a href="#aa4f30b65c7dec91c6b35670e7bccc45a"></a><br/></td></tr>
    93. 

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

  94. <tr class="memitem:a88194af5ce6cbc83a1af4b4bae7c56b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a88194af5ce6cbc83a1af4b4bae7c56b1">ExecuteFunc</a> (<a class="el" href="structRakNet_1_1RoomsPluginFunc.html">RoomsPluginFunc</a> *func)</td></tr>
    95. 

  95. <tr class="memdesc:a88194af5ce6cbc83a1af4b4bae7c56b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute a function, using the system address passed to <a class="el" href="classRakNet_1_1RoomsPlugin.html#a6bbf9f7511bfa2fad06154abee6da29d" title="Sets the remote server address that is running RoomsPlugin. Send calls will go to this function...">SetServerAddress()</a>;.  <a href="#a88194af5ce6cbc83a1af4b4bae7c56b1"></a><br/></td></tr>
    96. 

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

  97. <tr class="memitem:adb7c9ffbdd1e5e29bf473e7c3208a14a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#adb7c9ffbdd1e5e29bf473e7c3208a14a">ExecuteFunc</a> (<a class="el" href="structRakNet_1_1RoomsPluginFunc.html">RoomsPluginFunc</a> *func, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteAddress)</td></tr>
    98. 

  98. <tr class="memdesc:adb7c9ffbdd1e5e29bf473e7c3208a14a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute a function, with a specific address.  <a href="#adb7c9ffbdd1e5e29bf473e7c3208a14a"></a><br/></td></tr>
    99. 

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

  100. <tr class="memitem:a6bbf9f7511bfa2fad06154abee6da29d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a6bbf9f7511bfa2fad06154abee6da29d">SetServerAddress</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress)</td></tr>
    101. 

  101. <tr class="memdesc:a6bbf9f7511bfa2fad06154abee6da29d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the remote server address that is running <a class="el" href="classRakNet_1_1RoomsPlugin.html" title="Used to create rooms for players where they can matchmake.">RoomsPlugin</a>. Send calls will go to this function.  <a href="#a6bbf9f7511bfa2fad06154abee6da29d"></a><br/></td></tr>
    102. 

  102. <tr class="separator:a6bbf9f7511bfa2fad06154abee6da29d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    103. 

  103. <tr class="memitem:a576456ad92b65ac2a65ddfb2cc8263eb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a576456ad92b65ac2a65ddfb2cc8263eb">LoginRoomsParticipant</a> (<a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a> userName, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> roomsParticipantAddress, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> guid, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> loginServerAddress)</td></tr>
    104. 

  104. <tr class="memdesc:a576456ad92b65ac2a65ddfb2cc8263eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a participant to the system.  <a href="#a576456ad92b65ac2a65ddfb2cc8263eb"></a><br/></td></tr>
    105. 

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

  106. <tr class="memitem:ac08db9467e22f1227acc34cce7ffdb33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#ac08db9467e22f1227acc34cce7ffdb33">LogoffRoomsParticipant</a> (<a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a> userName, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> loginServerAddress)</td></tr>
    107. 

  107. <tr class="memdesc:ac08db9467e22f1227acc34cce7ffdb33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes a participant from the system.  <a href="#ac08db9467e22f1227acc34cce7ffdb33"></a><br/></td></tr>
    108. 

  108. <tr class="separator:ac08db9467e22f1227acc34cce7ffdb33"><td class="memSeparator" colspan="2">&#160;</td></tr>
    109. 

  109. <tr class="memitem:a4e50b77329efb0e37cf2fce84dcca655"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e50b77329efb0e37cf2fce84dcca655"></a>
    110. 

  110. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a4e50b77329efb0e37cf2fce84dcca655">ClearRoomMembers</a> ()</td></tr>
    111. 

  111. <tr class="memdesc:a4e50b77329efb0e37cf2fce84dcca655"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear all users. <br/></td></tr>
    112. 

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

  113. <tr class="memitem:a01127b5eb8a069c7c0ee9a90d77e5882"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a01127b5eb8a069c7c0ee9a90d77e5882">ChangeHandle</a> (<a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a> oldHandle, <a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a> newHandle)</td></tr>
    114. 

  114. <tr class="memdesc:a01127b5eb8a069c7c0ee9a90d77e5882"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the handle a user.  <a href="#a01127b5eb8a069c7c0ee9a90d77e5882"></a><br/></td></tr>
    115. 

  115. <tr class="separator:a01127b5eb8a069c7c0ee9a90d77e5882"><td class="memSeparator" colspan="2">&#160;</td></tr>
    116. 

  116. <tr class="memitem:a2f7d51bd655dad92b8d72c67957a62b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a2f7d51bd655dad92b8d72c67957a62b4">AddLoginServerAddress</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress)</td></tr>
    117. 

  117. <tr class="memdesc:a2f7d51bd655dad92b8d72c67957a62b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> to a list that will be checked when <a class="el" href="classRakNet_1_1RoomsPlugin.html#a576456ad92b65ac2a65ddfb2cc8263eb" title="Add a participant to the system.">LoginRoomsParticipant()</a> and <a class="el" href="classRakNet_1_1RoomsPlugin.html#ac08db9467e22f1227acc34cce7ffdb33" title="Removes a participant from the system.">LogoffRoomsParticipant()</a> is called.  <a href="#a2f7d51bd655dad92b8d72c67957a62b4"></a><br/></td></tr>
    118. 

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

  119. <tr class="memitem:ae9f941199d575d2445ec19c68418aa51"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#ae9f941199d575d2445ec19c68418aa51">RemoveLoginServerAddress</a> (<a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> systemAddress)</td></tr>
    120. 

  120. <tr class="memdesc:ae9f941199d575d2445ec19c68418aa51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove a <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> from a list that will be checked when <a class="el" href="classRakNet_1_1RoomsPlugin.html#a576456ad92b65ac2a65ddfb2cc8263eb" title="Add a participant to the system.">LoginRoomsParticipant()</a> and <a class="el" href="classRakNet_1_1RoomsPlugin.html#ac08db9467e22f1227acc34cce7ffdb33" title="Removes a participant from the system.">LogoffRoomsParticipant()</a> is called.  <a href="#ae9f941199d575d2445ec19c68418aa51"></a><br/></td></tr>
    121. 

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

  122. <tr class="memitem:ad9e648c365d1800931a316a0c15b6b53"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9e648c365d1800931a316a0c15b6b53"></a>
    123. 

  123. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#ad9e648c365d1800931a316a0c15b6b53">ClearLoginServerAdddresses</a> (void)</td></tr>
    124. 

  124. <tr class="memdesc:ad9e648c365d1800931a316a0c15b6b53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove all addresses added with <a class="el" href="classRakNet_1_1RoomsPlugin.html#a2f7d51bd655dad92b8d72c67957a62b4" title="Add a SystemAddress to a list that will be checked when LoginRoomsParticipant() and LogoffRoomsPartic...">AddLoginServerAddress()</a> <br/></td></tr>
    125. 

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

  126. <tr class="memitem:adb6f41986a08d0c82cb284e83f68e272"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#adb6f41986a08d0c82cb284e83f68e272">SetProfanityFilter</a> (ProfanityFilter *pf)</td></tr>
    127. 

  127. <tr class="memdesc:adb6f41986a08d0c82cb284e83f68e272"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the profanity filter for the system to use (optional)  <a href="#adb6f41986a08d0c82cb284e83f68e272"></a><br/></td></tr>
    128. 

  128. <tr class="separator:adb6f41986a08d0c82cb284e83f68e272"><td class="memSeparator" colspan="2">&#160;</td></tr>
    129. 

  129. <tr class="memitem:a8c4a5eddb8c4fab89f9fa7b983c40d7e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c4a5eddb8c4fab89f9fa7b983c40d7e"></a>
    130. 

  130. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a8c4a5eddb8c4fab89f9fa7b983c40d7e">OnDetach</a> (void)</td></tr>
    131. 

  131. <tr class="memdesc:a8c4a5eddb8c4fab89f9fa7b983c40d7e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the interface is detached. <br/></td></tr>
    132. 

  132. <tr class="separator:a8c4a5eddb8c4fab89f9fa7b983c40d7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    133. 

  133. <tr class="memitem:a39b4dabe0213312c1e66be4deda4eeec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39b4dabe0213312c1e66be4deda4eeec"></a>
    134. 

  134. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a39b4dabe0213312c1e66be4deda4eeec">Update</a> (void)</td></tr>
    135. 

  135. <tr class="memdesc:a39b4dabe0213312c1e66be4deda4eeec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update is called every time a packet is checked for . <br/></td></tr>
    136. 

  136. <tr class="separator:a39b4dabe0213312c1e66be4deda4eeec"><td class="memSeparator" colspan="2">&#160;</td></tr>
    137. 

  137. <tr class="memitem:a1cefcb0c0027d0bcdb966987eec9ad77"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a1cefcb0c0027d0bcdb966987eec9ad77">OnReceive</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet)</td></tr>
    138. 

  138. <tr class="separator:a1cefcb0c0027d0bcdb966987eec9ad77"><td class="memSeparator" colspan="2">&#160;</td></tr>
    139. 

  139. <tr class="memitem:a613f3693d1709bfc8ec0195ff84eb429"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a613f3693d1709bfc8ec0195ff84eb429">OnClosedConnection</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> rakNetGUID, <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga376cc546fd6892c2ead48cd51796c8b8">PI2_LostConnectionReason</a> lostConnectionReason)</td></tr>
    140. 

  140. <tr class="separator:a613f3693d1709bfc8ec0195ff84eb429"><td class="memSeparator" colspan="2">&#160;</td></tr>
    141. 

  141. <tr class="inherit_header pub_methods_classRakNet_1_1PluginInterface2"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classRakNet_1_1PluginInterface2')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classRakNet_1_1PluginInterface2.html">RakNet::PluginInterface2</a></td></tr>
    142. 

  142. <tr class="memitem:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a550529f3753c4acf22c3b5c3e203552c"></a>
    143. 

  143. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a550529f3753c4acf22c3b5c3e203552c">OnAttach</a> (void)</td></tr>
    144. 

  144. <tr class="memdesc:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when the interface is attached. <br/></td></tr>
    145. 

  145. <tr class="separator:a550529f3753c4acf22c3b5c3e203552c inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    146. 

  146. <tr class="memitem:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14825e69f0560996327e4dd351842c06"></a>
    147. 

  147. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a14825e69f0560996327e4dd351842c06">OnRakPeerStartup</a> (void)</td></tr>
    148. 

  148. <tr class="memdesc:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> is initialized. <br/></td></tr>
    149. 

  149. <tr class="separator:a14825e69f0560996327e4dd351842c06 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    150. 

  150. <tr class="memitem:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37c873a1879871722e06acfc45923883"></a>
    151. 

  151. virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a37c873a1879871722e06acfc45923883">OnRakPeerShutdown</a> (void)</td></tr>
    152. 

  152. <tr class="memdesc:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when <a class="el" href="classRakNet_1_1RakPeer.html" title="Main interface for network communications.">RakPeer</a> is shutdown. <br/></td></tr>
    153. 

  153. <tr class="separator:a37c873a1879871722e06acfc45923883 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    154. 

  154. <tr class="memitem:abf13327cc10f772ba06dff8f2687f8ae inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#abf13327cc10f772ba06dff8f2687f8ae">OnNewConnection</a> (const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;systemAddress, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> rakNetGUID, bool isIncoming)</td></tr>
    155. 

  155. <tr class="separator:abf13327cc10f772ba06dff8f2687f8ae inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    156. 

  156. <tr class="memitem:a9504489498df14b6efa5ca9bd39aede4 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9504489498df14b6efa5ca9bd39aede4">OnFailedConnectionAttempt</a> (<a class="el" href="structRakNet_1_1Packet.html">Packet</a> *packet, <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga3e92f686bace869b78c10508c58e0825">PI2_FailedConnectionAttemptReason</a> failedConnectionAttemptReason)</td></tr>
    157. 

  157. <tr class="separator:a9504489498df14b6efa5ca9bd39aede4 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    158. 

  158. <tr class="memitem:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#accfca7d25262c48a87a30114383284aa">UsesReliabilityLayer</a> (void) const </td></tr>
    159. 

  159. <tr class="separator:accfca7d25262c48a87a30114383284aa inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    160. 

  160. <tr class="memitem:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a7a6f69c6fc3a121e3676298a63a9ef78">OnDirectSocketSend</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
    161. 

  161. <tr class="separator:a7a6f69c6fc3a121e3676298a63a9ef78 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    162. 

  162. <tr class="memitem:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a9aac1101ad58e8443516588e96e066ec">OnDirectSocketReceive</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
    163. 

  163. <tr class="separator:a9aac1101ad58e8443516588e96e066ec inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    164. 

  164. <tr class="memitem:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#abf51e60546bd74d21c91dc0d6f9f3a4b">OnReliabilityLayerNotification</a> (const char *errorMessage, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, bool isError)</td></tr>
    165. 

  165. <tr class="separator:abf51e60546bd74d21c91dc0d6f9f3a4b inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    166. 

  166. <tr class="memitem:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a399b8c93daa0236599961e754742e2f7">OnInternalPacket</a> (<a class="el" href="structRakNet_1_1InternalPacket.html">InternalPacket</a> *internalPacket, unsigned frameNumber, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, RakNet::TimeMS time, int isSend)</td></tr>
    167. 

  167. <tr class="separator:a399b8c93daa0236599961e754742e2f7 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    168. 

  168. <tr class="memitem:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#ae0b0cad31cfc209c48197c77d6b46345">OnAck</a> (unsigned int messageNumber, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress, RakNet::TimeMS time)</td></tr>
    169. 

  169. <tr class="separator:ae0b0cad31cfc209c48197c77d6b46345 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    170. 

  170. <tr class="memitem:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1PluginInterface2.html#a5c976aea56ed85055a17c19d91b90727">OnPushBackPacket</a> (const char *data, const BitSize_t bitsUsed, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> remoteSystemAddress)</td></tr>
    171. 

  171. <tr class="separator:a5c976aea56ed85055a17c19d91b90727 inherit pub_methods_classRakNet_1_1PluginInterface2"><td class="memSeparator" colspan="2">&#160;</td></tr>
    172. 

  172. </table><table class="memberdecls">
    173. 

  173. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
    174. 

  174. Static Public Member Functions</h2></td></tr>
    175. 

  175. <tr class="memitem:a8c580074c49b918b138bb9a91e775257"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c580074c49b918b138bb9a91e775257"></a>
    176. 

  176. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a8c580074c49b918b138bb9a91e775257">SerializeLogin</a> (<a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a> userName, <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> userAddress, <a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a> guid, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *bs)</td></tr>
    177. 

  177. <tr class="memdesc:a8c580074c49b918b138bb9a91e775257"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used for Lobby2. Serializes the same data that the plugin itself uses to login. <br/></td></tr>
    178. 

  178. <tr class="separator:a8c580074c49b918b138bb9a91e775257"><td class="memSeparator" colspan="2">&#160;</td></tr>
    179. 

  179. <tr class="memitem:a55480d9a5aa125e8c81faf4a97d256cb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55480d9a5aa125e8c81faf4a97d256cb"></a>
    180. 

  180. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a55480d9a5aa125e8c81faf4a97d256cb">SerializeLogoff</a> (<a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a> userName, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *bs)</td></tr>
    181. 

  181. <tr class="memdesc:a55480d9a5aa125e8c81faf4a97d256cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used for Lobby2. Serializes the same data that the plugin itself uses to logoff. <br/></td></tr>
    182. 

  182. <tr class="separator:a55480d9a5aa125e8c81faf4a97d256cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
    183. 

  183. <tr class="memitem:a215ae5a91dc25d4309d889284d39d9af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a215ae5a91dc25d4309d889284d39d9af"></a>
    184. 

  184. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a215ae5a91dc25d4309d889284d39d9af">SerializeChangeHandle</a> (<a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a> oldHandle, <a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a> newHandle, <a class="el" href="classRakNet_1_1BitStream.html">RakNet::BitStream</a> *bs)</td></tr>
    185. 

  185. <tr class="memdesc:a215ae5a91dc25d4309d889284d39d9af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used for Lobby2. Serializes the same data that the plugin itself uses to change handles. <br/></td></tr>
    186. 

  186. <tr class="separator:a215ae5a91dc25d4309d889284d39d9af"><td class="memSeparator" colspan="2">&#160;</td></tr>
    187. 

  187. </table><table class="memberdecls">
    188. 

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

  189. Public Attributes</h2></td></tr>
    190. 

  190. <tr class="memitem:a42fd97f32605eb0d1ebfbd9c19edb2c0"><td class="memItemLeft" align="right" valign="top">AllGamesRoomsContainer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRakNet_1_1RoomsPlugin.html#a42fd97f32605eb0d1ebfbd9c19edb2c0">roomsContainer</a></td></tr>
    191. 

  191. <tr class="memdesc:a42fd97f32605eb0d1ebfbd9c19edb2c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Only used on the server. Locally perform any desired functions, such as logging off players.  <a href="#a42fd97f32605eb0d1ebfbd9c19edb2c0"></a><br/></td></tr>
    192. 

  192. <tr class="separator:a42fd97f32605eb0d1ebfbd9c19edb2c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
    193. 

  193. </table>
    194. 

  194. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    195. 

  195. <div class="textblock"><p>Used to create rooms for players where they can matchmake. </p>
    196. 

  196. <p>A room is similar to the rooms you see in other lobby systems, where groups of players can join together in order to start a game match<br/>
    197. 

  197.  Each player can be in at most one room.<br/>
    198. 

  198.  Each player name must be unique.<br/>
    199. 

  199.  Each room has one moderator, which can perform operations on the room such as kicking out members.<br/>
    200. 

  200.  This plugin networks the AllGamesRoomsContainer class, which performs the actual functionality.<br/>
    201. 

  201.  <br/>
    202. 

  202.  To use as a client:<br/>
    203. 

  203.  </p>
    204. 

  204. <ol>
    205. 

  205. <li>
    206. 

  206. Connect to the server and attach the plugin as normal. </li>
    207. 

  207. <li>
    208. 

  208. Call SetServerAddress to tell the system where the server is. </li>
    209. 

  209. <li>
    210. 

  210. Call <a class="el" href="classRakNet_1_1RoomsPlugin.html#a92be4d16a2a000e1547750ac667c627f" title="Set the callback to get notification and ExecuteFunc() results.">RoomsPlugin::SetRoomsCallback()</a> with a pointer to a callback structure </li>
    211. 

  211. <li>
    212. 

  212. Fill in the input parameters of the desired structure(s) </li>
    213. 

  213. <li>
    214. 

  214. Call <a class="el" href="classRakNet_1_1RoomsPlugin.html#a88194af5ce6cbc83a1af4b4bae7c56b1" title="Execute a function, using the system address passed to SetServerAddress();.">RoomsPlugin::ExecuteFunc</a> with a pointer to the structure. </li>
    215. 

  215. <li>
    216. 

  216. Process the callback, which will contain the original input parameters, plus the new output parameters. All structures contain resultCode, which indicates if the operation was successful (REC_SUCCESS) or not (Anything else) </li>
    217. 

  217. </ol>
    218. 

  218. <p><br/>
    219. 

  219.  To use as a server: </p>
    220. 

  220. <ol>
    221. 

  221. <li>
    222. 

  222. Start <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a> as usual, accepting connections and attaching the plugin </li>
    223. 

  223. <li>
    224. 

  224. Call <a class="el" href="classRakNet_1_1RoomsPlugin.html#adb6f41986a08d0c82cb284e83f68e272" title="Sets the profanity filter for the system to use (optional)">RoomsPlugin::SetProfanityFilter()</a> with the ProfanityFilter class, if desired </li>
    225. 

  225. <li>
    226. 

  226. Call RoomsPlugin::AddTitle() for each title (game) you want to support </li>
    227. 

  227. <li>
    228. 

  228. If you want other systems to be able to call <a class="el" href="classRakNet_1_1RoomsPlugin.html#a576456ad92b65ac2a65ddfb2cc8263eb" title="Add a participant to the system.">RoomsPlugin::LoginRoomsParticipant()</a>, call <a class="el" href="classRakNet_1_1RoomsPlugin.html#a2f7d51bd655dad92b8d72c67957a62b4" title="Add a SystemAddress to a list that will be checked when LoginRoomsParticipant() and LogoffRoomsPartic...">RoomsPlugin::AddLoginServerAddress()</a> with the addresses of those systems </li>
    229. 

  229. <li>
    230. 

  230. As users go online, call <a class="el" href="classRakNet_1_1RoomsPlugin.html#a576456ad92b65ac2a65ddfb2cc8263eb" title="Add a participant to the system.">RoomsPlugin::LoginRoomsParticipant()</a>. Login and Logoff is up to you to implement (or rely on other systems, such as Lobby2) </li>
    231. 

  231. <li>
    232. 

  232. As users go offline, call <a class="el" href="classRakNet_1_1RoomsPlugin.html#ac08db9467e22f1227acc34cce7ffdb33" title="Removes a participant from the system.">RoomsPlugin::LogoffRoomsParticipant()</a>; </li>
    233. 

  233. </ol>
    234. 

  234. <dl class="section see"><dt>See Also</dt><dd>AllGamesRoomsContainer </dd>
    235. 

  235. <dd>
    236. 

  236. <a class="el" href="classRakNet_1_1TeamManager.html" title="Automates networking and list management for teams.">TeamManager</a> <a class="el" href="classRakNet_1_1TeamManager.html" title="Automates networking and list management for teams.">TeamManager</a> performs some of the same functions as <a class="el" href="classRakNet_1_1RoomsPlugin.html" title="Used to create rooms for players where they can matchmake.">RoomsPlugin</a> in a more flexible way </dd>
    237. 

  237. <dd>
    238. 

  238. </dd></dl>
    239. 

  239. </div><h2 class="groupheader">Member Function Documentation</h2>
    240. 

  240. <a class="anchor" id="a2f7d51bd655dad92b8d72c67957a62b4"></a>
    241. 

  241. <div class="memitem">
    242. 

  242. <div class="memproto">
    243. 

  243.       <table class="memname">
    244. 

  244.         <tr>
    245. 

  245.           <td class="memname">void RakNet::RoomsPlugin::AddLoginServerAddress </td>
    246. 

  246.           <td>(</td>
    247. 

  247.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    248. 

  248.           <td class="paramname"><em>systemAddress</em></td><td>)</td>
    249. 

  249.           <td></td>
    250. 

  250.         </tr>
    251. 

  251.       </table>
    252. 

  252. </div><div class="memdoc">
    253. 

  253. 

  254. <p>Add a <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> to a list that will be checked when <a class="el" href="classRakNet_1_1RoomsPlugin.html#a576456ad92b65ac2a65ddfb2cc8263eb" title="Add a participant to the system.">LoginRoomsParticipant()</a> and <a class="el" href="classRakNet_1_1RoomsPlugin.html#ac08db9467e22f1227acc34cce7ffdb33" title="Removes a participant from the system.">LogoffRoomsParticipant()</a> is called. </p>
    255. 

  255. <dl class="params"><dt>Parameters</dt><dd>
    256. 

  256.   <table class="params">
    257. 

  257.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The address to add </td></tr>
    258. 

  258.   </table>
    259. 

  259.   </dd>
    260. 

  260. </dl>
    261. 

  261. 

  262. </div>
    263. 

  263. </div>
    264. 

  264. <a class="anchor" id="af5b0ede7fe5bc2dd5e3cf113a69460c0"></a>
    265. 

  265. <div class="memitem">
    266. 

  266. <div class="memproto">
    267. 

  267.       <table class="memname">
    268. 

  268.         <tr>
    269. 

  269.           <td class="memname">void RakNet::RoomsPlugin::AddRoomsCallback </td>
    270. 

  270.           <td>(</td>
    271. 

  271.           <td class="paramtype">RoomsCallback *&#160;</td>
    272. 

  272.           <td class="paramname"><em>_roomsCallback</em></td><td>)</td>
    273. 

  273.           <td></td>
    274. 

  274.         </tr>
    275. 

  275.       </table>
    276. 

  276. </div><div class="memdoc">
    277. 

  277. 

  278. <p>Add a callback to get notification and <a class="el" href="classRakNet_1_1RoomsPlugin.html#a88194af5ce6cbc83a1af4b4bae7c56b1" title="Execute a function, using the system address passed to SetServerAddress();.">ExecuteFunc()</a> results. </p>
    279. 

  279. <dl class="params"><dt>Parameters</dt><dd>
    280. 

  280.   <table class="params">
    281. 

  281.     <tr><td class="paramdir">[in]</td><td class="paramname">_roomsCallback</td><td>Class instance to get callbacks on. Should remain a valid pointer for the duration of the plugin execution. </td></tr>
    282. 

  282.   </table>
    283. 

  283.   </dd>
    284. 

  284. </dl>
    285. 

  285. 

  286. </div>
    287. 

  287. </div>
    288. 

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

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

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

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

  292.         <tr>
    293. 

  293.           <td class="memname">void RakNet::RoomsPlugin::ChangeHandle </td>
    294. 

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

  295.           <td class="paramtype"><a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a>&#160;</td>
    296. 

  296.           <td class="paramname"><em>oldHandle</em>, </td>
    297. 

  297.         </tr>
    298. 

  298.         <tr>
    299. 

  299.           <td class="paramkey"></td>
    300. 

  300.           <td></td>
    301. 

  301.           <td class="paramtype"><a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a>&#160;</td>
    302. 

  302.           <td class="paramname"><em>newHandle</em>&#160;</td>
    303. 

  303.         </tr>
    304. 

  304.         <tr>
    305. 

  305.           <td></td>
    306. 

  306.           <td>)</td>
    307. 

  307.           <td></td><td></td>
    308. 

  308.         </tr>
    309. 

  309.       </table>
    310. 

  310. </div><div class="memdoc">
    311. 

  311. 

  312. <p>Change the handle a user. </p>
    313. 

  313. <dl class="params"><dt>Parameters</dt><dd>
    314. 

  314.   <table class="params">
    315. 

  315.     <tr><td class="paramdir">[in]</td><td class="paramname">oldHandle</td><td>The handle previously known by the system </td></tr>
    316. 

  316.     <tr><td class="paramdir">[in]</td><td class="paramname">newHandle</td><td>The new handle to use </td></tr>
    317. 

  317.   </table>
    318. 

  318.   </dd>
    319. 

  319. </dl>
    320. 

  320. 

  321. </div>
    322. 

  322. </div>
    323. 

  323. <a class="anchor" id="a88194af5ce6cbc83a1af4b4bae7c56b1"></a>
    324. 

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

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

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

  327.         <tr>
    328. 

  328.           <td class="memname">void RakNet::RoomsPlugin::ExecuteFunc </td>
    329. 

  329.           <td>(</td>
    330. 

  330.           <td class="paramtype"><a class="el" href="structRakNet_1_1RoomsPluginFunc.html">RoomsPluginFunc</a> *&#160;</td>
    331. 

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

  332.           <td></td>
    333. 

  333.         </tr>
    334. 

  334.       </table>
    335. 

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

  336. 

  337. <p>Execute a function, using the system address passed to <a class="el" href="classRakNet_1_1RoomsPlugin.html#a6bbf9f7511bfa2fad06154abee6da29d" title="Sets the remote server address that is running RoomsPlugin. Send calls will go to this function...">SetServerAddress()</a>;. </p>
    338. 

  338. <dl class="params"><dt>Parameters</dt><dd>
    339. 

  339.   <table class="params">
    340. 

  340.     <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Pointer to a base class of <a class="el" href="structRakNet_1_1RoomsPluginFunc.html" title="Base class for rooms functionality.">RoomsPluginFunc</a> to execute </td></tr>
    341. 

  341.   </table>
    342. 

  342.   </dd>
    343. 

  343. </dl>
    344. 

  344. 

  345. </div>
    346. 

  346. </div>
    347. 

  347. <a class="anchor" id="adb7c9ffbdd1e5e29bf473e7c3208a14a"></a>
    348. 

  348. <div class="memitem">
    349. 

  349. <div class="memproto">
    350. 

  350.       <table class="memname">
    351. 

  351.         <tr>
    352. 

  352.           <td class="memname">void RakNet::RoomsPlugin::ExecuteFunc </td>
    353. 

  353.           <td>(</td>
    354. 

  354.           <td class="paramtype"><a class="el" href="structRakNet_1_1RoomsPluginFunc.html">RoomsPluginFunc</a> *&#160;</td>
    355. 

  355.           <td class="paramname"><em>func</em>, </td>
    356. 

  356.         </tr>
    357. 

  357.         <tr>
    358. 

  358.           <td class="paramkey"></td>
    359. 

  359.           <td></td>
    360. 

  360.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    361. 

  361.           <td class="paramname"><em>remoteAddress</em>&#160;</td>
    362. 

  362.         </tr>
    363. 

  363.         <tr>
    364. 

  364.           <td></td>
    365. 

  365.           <td>)</td>
    366. 

  366.           <td></td><td></td>
    367. 

  367.         </tr>
    368. 

  368.       </table>
    369. 

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

  370. 

  371. <p>Execute a function, with a specific address. </p>
    372. 

  372. <dl class="params"><dt>Parameters</dt><dd>
    373. 

  373.   <table class="params">
    374. 

  374.     <tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>Pointer to a base class of <a class="el" href="structRakNet_1_1RoomsPluginFunc.html" title="Base class for rooms functionality.">RoomsPluginFunc</a> to execute </td></tr>
    375. 

  375.     <tr><td class="paramdir">[in]</td><td class="paramname">remoteAddress</td><td>Address to send the command to. The remote system should also be running <a class="el" href="classRakNet_1_1RoomsPlugin.html" title="Used to create rooms for players where they can matchmake.">RoomsPlugin</a> </td></tr>
    376. 

  376.   </table>
    377. 

  377.   </dd>
    378. 

  378. </dl>
    379. 

  379. 

  380. </div>
    381. 

  381. </div>
    382. 

  382. <a class="anchor" id="a576456ad92b65ac2a65ddfb2cc8263eb"></a>
    383. 

  383. <div class="memitem">
    384. 

  384. <div class="memproto">
    385. 

  385.       <table class="memname">
    386. 

  386.         <tr>
    387. 

  387.           <td class="memname">bool RakNet::RoomsPlugin::LoginRoomsParticipant </td>
    388. 

  388.           <td>(</td>
    389. 

  389.           <td class="paramtype"><a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a>&#160;</td>
    390. 

  390.           <td class="paramname"><em>userName</em>, </td>
    391. 

  391.         </tr>
    392. 

  392.         <tr>
    393. 

  393.           <td class="paramkey"></td>
    394. 

  394.           <td></td>
    395. 

  395.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    396. 

  396.           <td class="paramname"><em>roomsParticipantAddress</em>, </td>
    397. 

  397.         </tr>
    398. 

  398.         <tr>
    399. 

  399.           <td class="paramkey"></td>
    400. 

  400.           <td></td>
    401. 

  401.           <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
    402. 

  402.           <td class="paramname"><em>guid</em>, </td>
    403. 

  403.         </tr>
    404. 

  404.         <tr>
    405. 

  405.           <td class="paramkey"></td>
    406. 

  406.           <td></td>
    407. 

  407.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    408. 

  408.           <td class="paramname"><em>loginServerAddress</em>&#160;</td>
    409. 

  409.         </tr>
    410. 

  410.         <tr>
    411. 

  411.           <td></td>
    412. 

  412.           <td>)</td>
    413. 

  413.           <td></td><td></td>
    414. 

  414.         </tr>
    415. 

  415.       </table>
    416. 

  416. </div><div class="memdoc">
    417. 

  417. 

  418. <p>Add a participant to the system. </p>
    419. 

  419. <p>Only participants can perform operations </p>
    420. 

  420. <dl class="params"><dt>Parameters</dt><dd>
    421. 

  421.   <table class="params">
    422. 

  422.     <tr><td class="paramdir">[in]</td><td class="paramname">userName</td><td>A unique string identifying the user </td></tr>
    423. 

  423.     <tr><td class="paramdir">[in]</td><td class="paramname">roomsParticipantAddress</td><td>The address of the user </td></tr>
    424. 

  424.     <tr><td class="paramdir">[in]</td><td class="paramname">guid</td><td>The guid of the user </td></tr>
    425. 

  425.     <tr><td class="paramdir">[in]</td><td class="paramname">loginServerAddress</td><td>The server adding this user. Use <a class="el" href="namespaceRakNet.html#a80c95b4ed53f42911a6fa92b85e929cf" title="Index of an invalid SystemAddress.">RakNet::UNASSIGNED_SYSTEM_ADDRESS</a> for not applicable. Otherwise, the address must previously have been added using <a class="el" href="classRakNet_1_1RoomsPlugin.html#a2f7d51bd655dad92b8d72c67957a62b4" title="Add a SystemAddress to a list that will be checked when LoginRoomsParticipant() and LogoffRoomsPartic...">AddLoginServerAddress()</a> or the function will fail. </td></tr>
    426. 

  426.   </table>
    427. 

  427.   </dd>
    428. 

  428. </dl>
    429. 

  429. 

  430. </div>
    431. 

  431. </div>
    432. 

  432. <a class="anchor" id="ac08db9467e22f1227acc34cce7ffdb33"></a>
    433. 

  433. <div class="memitem">
    434. 

  434. <div class="memproto">
    435. 

  435.       <table class="memname">
    436. 

  436.         <tr>
    437. 

  437.           <td class="memname">bool RakNet::RoomsPlugin::LogoffRoomsParticipant </td>
    438. 

  438.           <td>(</td>
    439. 

  439.           <td class="paramtype"><a class="el" href="classRakNet_1_1RakString.html">RakNet::RakString</a>&#160;</td>
    440. 

  440.           <td class="paramname"><em>userName</em>, </td>
    441. 

  441.         </tr>
    442. 

  442.         <tr>
    443. 

  443.           <td class="paramkey"></td>
    444. 

  444.           <td></td>
    445. 

  445.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    446. 

  446.           <td class="paramname"><em>loginServerAddress</em>&#160;</td>
    447. 

  447.         </tr>
    448. 

  448.         <tr>
    449. 

  449.           <td></td>
    450. 

  450.           <td>)</td>
    451. 

  451.           <td></td><td></td>
    452. 

  452.         </tr>
    453. 

  453.       </table>
    454. 

  454. </div><div class="memdoc">
    455. 

  455. 

  456. <p>Removes a participant from the system. </p>
    457. 

  457. <dl class="params"><dt>Parameters</dt><dd>
    458. 

  458.   <table class="params">
    459. 

  459.     <tr><td class="paramdir">[in]</td><td class="paramname">userName</td><td>A unique string identifying the user </td></tr>
    460. 

  460.     <tr><td class="paramdir">[in]</td><td class="paramname">loginServerAddress</td><td>The server removing. Use <a class="el" href="namespaceRakNet.html#a80c95b4ed53f42911a6fa92b85e929cf" title="Index of an invalid SystemAddress.">RakNet::UNASSIGNED_SYSTEM_ADDRESS</a> for not applicable. Otherwise, the address must previously have been added using <a class="el" href="classRakNet_1_1RoomsPlugin.html#a2f7d51bd655dad92b8d72c67957a62b4" title="Add a SystemAddress to a list that will be checked when LoginRoomsParticipant() and LogoffRoomsPartic...">AddLoginServerAddress()</a> or the function will fail. </td></tr>
    461. 

  461.   </table>
    462. 

  462.   </dd>
    463. 

  463. </dl>
    464. 

  464. 

  465. </div>
    466. 

  466. </div>
    467. 

  467. <a class="anchor" id="a613f3693d1709bfc8ec0195ff84eb429"></a>
    468. 

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

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

  470. <table class="mlabels">
    471. 

  471.   <tr>
    472. 

  472.   <td class="mlabels-left">
    473. 

  473.       <table class="memname">
    474. 

  474.         <tr>
    475. 

  475.           <td class="memname">virtual void RakNet::RoomsPlugin::OnClosedConnection </td>
    476. 

  476.           <td>(</td>
    477. 

  477.           <td class="paramtype">const <a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a> &amp;&#160;</td>
    478. 

  478.           <td class="paramname"><em>systemAddress</em>, </td>
    479. 

  479.         </tr>
    480. 

  480.         <tr>
    481. 

  481.           <td class="paramkey"></td>
    482. 

  482.           <td></td>
    483. 

  483.           <td class="paramtype"><a class="el" href="structRakNet_1_1RakNetGUID.html">RakNetGUID</a>&#160;</td>
    484. 

  484.           <td class="paramname"><em>rakNetGUID</em>, </td>
    485. 

  485.         </tr>
    486. 

  486.         <tr>
    487. 

  487.           <td class="paramkey"></td>
    488. 

  488.           <td></td>
    489. 

  489.           <td class="paramtype"><a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga376cc546fd6892c2ead48cd51796c8b8">PI2_LostConnectionReason</a>&#160;</td>
    490. 

  490.           <td class="paramname"><em>lostConnectionReason</em>&#160;</td>
    491. 

  491.         </tr>
    492. 

  492.         <tr>
    493. 

  493.           <td></td>
    494. 

  494.           <td>)</td>
    495. 

  495.           <td></td><td></td>
    496. 

  496.         </tr>
    497. 

  497.       </table>
    498. 

  498.   </td>
    499. 

  499.   <td class="mlabels-right">
    500. 

  500. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    501. 

  501.   </tr>
    502. 

  502. </table>
    503. 

  503. </div><div class="memdoc">
    504. 

  504. <p>Called when a connection is dropped because the user called <a class="el" href="classRakNet_1_1RakPeer.html#a95e3806fce8552e322236abcf105cbf9" title="Close the connection to another host (if we initiated the connection it will disconnect, if they did it will kick them out).">RakPeer::CloseConnection()</a> for a particular system </p>
    505. 

  505. <dl class="params"><dt>Parameters</dt><dd>
    506. 

  506.   <table class="params">
    507. 

  507.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The system whose connection was closed </td></tr>
    508. 

  508.     <tr><td class="paramdir">[in]</td><td class="paramname">rakNetGuid</td><td>The guid of the specified system </td></tr>
    509. 

  509.     <tr><td class="paramdir">[in]</td><td class="paramname">lostConnectionReason</td><td>How the connection was closed: manually, connection lost, or notification of disconnection </td></tr>
    510. 

  510.   </table>
    511. 

  511.   </dd>
    512. 

  512. </dl>
    513. 

  513. 

  514. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#a80c7612ca1a5dcfeec0b52d8049a71ea">RakNet::PluginInterface2</a>.</p>
    515. 

  515. 

  516. </div>
    517. 

  517. </div>
    518. 

  518. <a class="anchor" id="a1cefcb0c0027d0bcdb966987eec9ad77"></a>
    519. 

  519. <div class="memitem">
    520. 

  520. <div class="memproto">
    521. 

  521. <table class="mlabels">
    522. 

  522.   <tr>
    523. 

  523.   <td class="mlabels-left">
    524. 

  524.       <table class="memname">
    525. 

  525.         <tr>
    526. 

  526.           <td class="memname">virtual <a class="el" href="group__PLUGIN__INTERFACE__GROUP.html#ga89998adaafb29e5d879113b992161085">PluginReceiveResult</a> RakNet::RoomsPlugin::OnReceive </td>
    527. 

  527.           <td>(</td>
    528. 

  528.           <td class="paramtype"><a class="el" href="structRakNet_1_1Packet.html">Packet</a> *&#160;</td>
    529. 

  529.           <td class="paramname"><em>packet</em></td><td>)</td>
    530. 

  530.           <td></td>
    531. 

  531.         </tr>
    532. 

  532.       </table>
    533. 

  533.   </td>
    534. 

  534.   <td class="mlabels-right">
    535. 

  535. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    536. 

  536.   </tr>
    537. 

  537. </table>
    538. 

  538. </div><div class="memdoc">
    539. 

  539. <p>OnReceive is called for every packet. </p>
    540. 

  540. <dl class="params"><dt>Parameters</dt><dd>
    541. 

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

  542.     <tr><td class="paramdir">[in]</td><td class="paramname">packet</td><td>the packet that is being returned to the user </td></tr>
    543. 

  543.   </table>
    544. 

  544.   </dd>
    545. 

  545. </dl>
    546. 

  546. <dl class="section return"><dt>Returns</dt><dd>True to allow the game and other plugins to get this message, false to absorb it </dd></dl>
    547. 

  547. 

  548. <p>Reimplemented from <a class="el" href="classRakNet_1_1PluginInterface2.html#aa86f33263c1648f11b8a006469272639">RakNet::PluginInterface2</a>.</p>
    549. 

  549. 

  550. </div>
    551. 

  551. </div>
    552. 

  552. <a class="anchor" id="ae9f941199d575d2445ec19c68418aa51"></a>
    553. 

  553. <div class="memitem">
    554. 

  554. <div class="memproto">
    555. 

  555.       <table class="memname">
    556. 

  556.         <tr>
    557. 

  557.           <td class="memname">void RakNet::RoomsPlugin::RemoveLoginServerAddress </td>
    558. 

  558.           <td>(</td>
    559. 

  559.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    560. 

  560.           <td class="paramname"><em>systemAddress</em></td><td>)</td>
    561. 

  561.           <td></td>
    562. 

  562.         </tr>
    563. 

  563.       </table>
    564. 

  564. </div><div class="memdoc">
    565. 

  565. 

  566. <p>Remove a <a class="el" href="structRakNet_1_1SystemAddress.html" title="Network address for a system.">SystemAddress</a> from a list that will be checked when <a class="el" href="classRakNet_1_1RoomsPlugin.html#a576456ad92b65ac2a65ddfb2cc8263eb" title="Add a participant to the system.">LoginRoomsParticipant()</a> and <a class="el" href="classRakNet_1_1RoomsPlugin.html#ac08db9467e22f1227acc34cce7ffdb33" title="Removes a participant from the system.">LogoffRoomsParticipant()</a> is called. </p>
    567. 

  567. <dl class="params"><dt>Parameters</dt><dd>
    568. 

  568.   <table class="params">
    569. 

  569.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The address to remove </td></tr>
    570. 

  570.   </table>
    571. 

  571.   </dd>
    572. 

  572. </dl>
    573. 

  573. 

  574. </div>
    575. 

  575. </div>
    576. 

  576. <a class="anchor" id="aa4f30b65c7dec91c6b35670e7bccc45a"></a>
    577. 

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

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

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

  580.         <tr>
    581. 

  581.           <td class="memname">void RakNet::RoomsPlugin::RemoveRoomsCallback </td>
    582. 

  582.           <td>(</td>
    583. 

  583.           <td class="paramtype">RoomsCallback *&#160;</td>
    584. 

  584.           <td class="paramname"><em>_roomsCallback</em></td><td>)</td>
    585. 

  585.           <td></td>
    586. 

  586.         </tr>
    587. 

  587.       </table>
    588. 

  588. </div><div class="memdoc">
    589. 

  589. 

  590. <p>Remove a callback to get notification and <a class="el" href="classRakNet_1_1RoomsPlugin.html#a88194af5ce6cbc83a1af4b4bae7c56b1" title="Execute a function, using the system address passed to SetServerAddress();.">ExecuteFunc()</a> results. </p>
    591. 

  591. <dl class="params"><dt>Parameters</dt><dd>
    592. 

  592.   <table class="params">
    593. 

  593.     <tr><td class="paramdir">[in]</td><td class="paramname">_roomsCallback</td><td>Class instance to no longer get callbacks on. </td></tr>
    594. 

  594.   </table>
    595. 

  595.   </dd>
    596. 

  596. </dl>
    597. 

  597. 

  598. </div>
    599. 

  599. </div>
    600. 

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

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

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

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

  604.         <tr>
    605. 

  605.           <td class="memname">void RakNet::RoomsPlugin::SetOrderingChannel </td>
    606. 

  606.           <td>(</td>
    607. 

  607.           <td class="paramtype">char&#160;</td>
    608. 

  608.           <td class="paramname"><em>oc</em></td><td>)</td>
    609. 

  609.           <td></td>
    610. 

  610.         </tr>
    611. 

  611.       </table>
    612. 

  612. </div><div class="memdoc">
    613. 

  613. 

  614. <p>Ordering channel to send messages on. </p>
    615. 

  615. <dl class="params"><dt>Parameters</dt><dd>
    616. 

  616.   <table class="params">
    617. 

  617.     <tr><td class="paramdir">[in]</td><td class="paramname">oc</td><td>The ordering channel </td></tr>
    618. 

  618.   </table>
    619. 

  619.   </dd>
    620. 

  620. </dl>
    621. 

  621. 

  622. </div>
    623. 

  623. </div>
    624. 

  624. <a class="anchor" id="adb6f41986a08d0c82cb284e83f68e272"></a>
    625. 

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

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

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

  628.         <tr>
    629. 

  629.           <td class="memname">void RakNet::RoomsPlugin::SetProfanityFilter </td>
    630. 

  630.           <td>(</td>
    631. 

  631.           <td class="paramtype">ProfanityFilter *&#160;</td>
    632. 

  632.           <td class="paramname"><em>pf</em></td><td>)</td>
    633. 

  633.           <td></td>
    634. 

  634.         </tr>
    635. 

  635.       </table>
    636. 

  636. </div><div class="memdoc">
    637. 

  637. 

  638. <p>Sets the profanity filter for the system to use (optional) </p>
    639. 

  639. <p>If set, room names and player handles will be checked for profanity. Room invitations and other messages are not checked. </p>
    640. 

  640. <dl class="params"><dt>Parameters</dt><dd>
    641. 

  641.   <table class="params">
    642. 

  642.     <tr><td class="paramdir">[in]</td><td class="paramname">pf</td><td>An instance of a profanity filter </td></tr>
    643. 

  643.   </table>
    644. 

  644.   </dd>
    645. 

  645. </dl>
    646. 

  646. 

  647. </div>
    648. 

  648. </div>
    649. 

  649. <a class="anchor" id="a92be4d16a2a000e1547750ac667c627f"></a>
    650. 

  650. <div class="memitem">
    651. 

  651. <div class="memproto">
    652. 

  652.       <table class="memname">
    653. 

  653.         <tr>
    654. 

  654.           <td class="memname">void RakNet::RoomsPlugin::SetRoomsCallback </td>
    655. 

  655.           <td>(</td>
    656. 

  656.           <td class="paramtype">RoomsCallback *&#160;</td>
    657. 

  657.           <td class="paramname"><em>_roomsCallback</em></td><td>)</td>
    658. 

  658.           <td></td>
    659. 

  659.         </tr>
    660. 

  660.       </table>
    661. 

  661. </div><div class="memdoc">
    662. 

  662. 

  663. <p>Set the callback to get notification and <a class="el" href="classRakNet_1_1RoomsPlugin.html#a88194af5ce6cbc83a1af4b4bae7c56b1" title="Execute a function, using the system address passed to SetServerAddress();.">ExecuteFunc()</a> results. </p>
    664. 

  664. <dl class="params"><dt>Parameters</dt><dd>
    665. 

  665.   <table class="params">
    666. 

  666.     <tr><td class="paramdir">[in]</td><td class="paramname">_roomsCallback</td><td>Class instance to get callbacks on. Should remain a valid pointer for the duration of the plugin execution. </td></tr>
    667. 

  667.   </table>
    668. 

  668.   </dd>
    669. 

  669. </dl>
    670. 

  670. 

  671. </div>
    672. 

  672. </div>
    673. 

  673. <a class="anchor" id="a21bd54606b77dfb03b9b8ad6654e958c"></a>
    674. 

  674. <div class="memitem">
    675. 

  675. <div class="memproto">
    676. 

  676.       <table class="memname">
    677. 

  677.         <tr>
    678. 

  678.           <td class="memname">void RakNet::RoomsPlugin::SetSendPriority </td>
    679. 

  679.           <td>(</td>
    680. 

  680.           <td class="paramtype"><a class="el" href="PacketPriority_8h.html#a659378374e516180f93640c79f59705c">PacketPriority</a>&#160;</td>
    681. 

  681.           <td class="paramname"><em>pp</em></td><td>)</td>
    682. 

  682.           <td></td>
    683. 

  683.         </tr>
    684. 

  684.       </table>
    685. 

  685. </div><div class="memdoc">
    686. 

  686. 

  687. <p>Send priority to send messages on. </p>
    688. 

  688. <dl class="params"><dt>Parameters</dt><dd>
    689. 

  689.   <table class="params">
    690. 

  690.     <tr><td class="paramdir">[in]</td><td class="paramname">pp</td><td>The packet priority </td></tr>
    691. 

  691.   </table>
    692. 

  692.   </dd>
    693. 

  693. </dl>
    694. 

  694. 

  695. </div>
    696. 

  696. </div>
    697. 

  697. <a class="anchor" id="a6bbf9f7511bfa2fad06154abee6da29d"></a>
    698. 

  698. <div class="memitem">
    699. 

  699. <div class="memproto">
    700. 

  700.       <table class="memname">
    701. 

  701.         <tr>
    702. 

  702.           <td class="memname">void RakNet::RoomsPlugin::SetServerAddress </td>
    703. 

  703.           <td>(</td>
    704. 

  704.           <td class="paramtype"><a class="el" href="structRakNet_1_1SystemAddress.html">SystemAddress</a>&#160;</td>
    705. 

  705.           <td class="paramname"><em>systemAddress</em></td><td>)</td>
    706. 

  706.           <td></td>
    707. 

  707.         </tr>
    708. 

  708.       </table>
    709. 

  709. </div><div class="memdoc">
    710. 

  710. 

  711. <p>Sets the remote server address that is running <a class="el" href="classRakNet_1_1RoomsPlugin.html" title="Used to create rooms for players where they can matchmake.">RoomsPlugin</a>. Send calls will go to this function. </p>
    712. 

  712. <dl class="params"><dt>Parameters</dt><dd>
    713. 

  713.   <table class="params">
    714. 

  714.     <tr><td class="paramdir">[in]</td><td class="paramname">systemAddress</td><td>The remote system, which should be connected while calling client functions </td></tr>
    715. 

  715.   </table>
    716. 

  716.   </dd>
    717. 

  717. </dl>
    718. 

  718. 

  719. </div>
    720. 

  720. </div>
    721. 

  721. <h2 class="groupheader">Member Data Documentation</h2>
    722. 

  722. <a class="anchor" id="a42fd97f32605eb0d1ebfbd9c19edb2c0"></a>
    723. 

  723. <div class="memitem">
    724. 

  724. <div class="memproto">
    725. 

  725.       <table class="memname">
    726. 

  726.         <tr>
    727. 

  727.           <td class="memname">AllGamesRoomsContainer RakNet::RoomsPlugin::roomsContainer</td>
    728. 

  728.         </tr>
    729. 

  729.       </table>
    730. 

  730. </div><div class="memdoc">
    731. 

  731. 

  732. <p>Only used on the server. Locally perform any desired functions, such as logging off players. </p>
    733. 

  733. <dl class="section note"><dt>Note</dt><dd>Use AllGamesRoomsContainer::AddTitle() to add titles </dd></dl>
    734. 

  734. 

  735. </div>
    736. 

  736. </div>
    737. 

  737. <hr/>The documentation for this class was generated from the following file:<ul>
    738. 

  738. <li>D:/temp/RakNet_PC/DependentExtensions/Lobby2/Rooms/<a class="el" href="RoomsPlugin_8h.html">RoomsPlugin.h</a></li>
    739. 

  739. </ul>
    740. 

  740. </div><!-- contents -->
    741. 

  741. <!-- start footer part -->
    742. 

  742. <hr class="footer"/><address class="footer"><small>
    743. 

  743. Generated on Mon Jun 2 2014 20:10:30 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
    744. 

  744. <img class="footer" src="doxygen.png" alt="doxygen"/>
    745. 

  745. </a> 1.8.2
    746. 

  746. </small></address>
    747. 

  747. </body>
    748. 

  748. </html>
    749.
粤ICP备19079148号