rcon.html (11497B)
1 <!DOCTYPE html> 2 <html lang="en"> 3 <head> 4 <meta charset="utf-8"> 5 <title>rcon - nBot</title> 6 <link rel="stylesheet" href=""> 7 <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> 8 <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> 9 <link rel="stylesheet" href="../assets/css/custom.css"> 10 <link rel="stylesheet" href="../assets/vendor/bootstrap/css/bootstrap.css"> 11 <link rel="shortcut icon" type="image/png" href="../assets/favicon.png"> 12 </head> 13 <body class="yui3-skin-sam"> 14 <div class="navbar navbar-fixed-top"> 15 <div class="navbar-inner"> 16 <h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20px; margin-left: 0;"> 17 <img alt="nBot" src="../assets/css/logo.png" style="max-height: 65%;" title="nBot"> 18 nBot 19 </h1> 20 <div class="nav"> 21 <li class="divider-vertical"></li> 22 <li> 23 <p class="navbar-text"> 24 API Docs for Version: <b>0.0.1</b> 25 </p> 26 </li> 27 </div> 28 <form class="navbar-form pull-right" style="line-height: 40px; height: 40px;"> 29 <input style="margin-top: 0;" type="text" class="search-query" placeholder="Search for classes/modules..." data-obj='["classes/addServer", "classes/nBot", "classes/rcon", "classes/server", "modules/addServer", "modules/nBot", "modules/rcon", "modules/server"]'> 30 </form> 31 </div> 32 </div> 33 <div class="container"> 34 <div class="row"> 35 <div class="span3"> 36 <div> 37 <h3>APIs</h3> 38 <div id="sidebar"> 39 <ul id="main-nav" class="nav nav-tabs" style="margin-bottom:0;"> 40 <li class="active"><a href="#classes" data-toggle="tab">Classes</a></li> 41 <li><a href="#modules" data-toggle="tab">Modules</a></li> 42 </ul> 43 44 <div id="api-tabview-filter"> 45 <input type="search" placeholder="Type to filter APIs"> 46 </div> 47 48 <div class="tab-content" style="border: 1px solid #DDD; border-top:0;"> 49 <div class="tab-pane active" id="classes"> 50 <ul id="api-classes" class="nav nav-list"> 51 <li><a href="../classes/addServer.html">addServer</a></li> 52 <li><a href="../classes/nBot.html">nBot</a></li> 53 <li><a href="../classes/rcon.html">rcon</a></li> 54 <li><a href="../classes/server.html">server</a></li> 55 </ul> 56 </div> 57 58 <div class="tab-pane" id="modules"> 59 <ul id="api-modules" class="nav nav-list"> 60 <li><a href="../modules/addServer.html">addServer</a></li> 61 <li><a href="../modules/nBot.html">nBot</a></li> 62 <li><a href="../modules/rcon.html">rcon</a></li> 63 <li><a href="../modules/server.html">server</a></li> 64 </ul> 65 </div> 66 </div> 67 </div> 68 </div> 69 </div> 70 <div class="span9"> 71 <form id="options-form" class="form-inline pull-right"> 72 Show: 73 <label for="api-show-inherited" class="checkbox"> 74 <input type="checkbox" id="api-show-inherited" checked> 75 Inherited 76 </label> 77 78 <label for="api-show-protected" class="checkbox"> 79 <input type="checkbox" id="api-show-protected"> 80 Protected 81 </label> 82 83 <label for="api-show-private" class="checkbox"> 84 <input type="checkbox" id="api-show-private"> 85 Private 86 </label> 87 <label for="api-show-deprecated" class="checkbox"> 88 <input type="checkbox" id="api-show-deprecated"> 89 Deprecated 90 </label> 91 92 </form> 93 94 <div class="apidocs"> 95 <div id="docs-main"> 96 <div class="content"> 97 <div class="page-header"> 98 <h1>rcon <small>Class</small></h1> 99 </div> 100 101 <div class="well well-small"> 102 103 104 <div class="foundat"> 105 Defined in: <a href="../files/backend_rcon.js.html#l12"><code>backend\rcon.js:12</code></a> 106 </div> 107 108 Module: <a href="../modules/rcon.html">rcon</a><br> 109 Parent Module: <a href="../modules/nBot.html">nBot</a> 110 111 </div> 112 113 114 <div class="well well-small"> 115 116 </div> 117 118 119 <div> 120 <ul class="nav nav-tabs"> 121 <li class="active"><a data-toggle="tab" href="#index">Index</a></li> 122 123 <li><a data-toggle="tab" href="#methods">Methods</a></li> 124 </ul> 125 126 <div class="tab-content"> 127 <div id="index" class="tab-pane active"> 128 <h2 class="off-left">Item Index</h2> 129 130 <div class="index-section methods"> 131 <h3>Methods</h3> 132 133 <ul class="index-list methods"> 134 <li class="index-item method"> 135 <a href="#" data-tabid="#methods" data-anchor="#method_live_on" data-tablink="live_on">live_on</a> 136 137 </li> 138 <li class="index-item method"> 139 <a href="#" data-tabid="#methods" data-anchor="#method_restart_game" data-tablink="restart_game">restart_game</a> 140 141 </li> 142 <li class="index-item method deprecated"> 143 <a href="#" data-tabid="#methods" data-anchor="#method_start" data-tablink="start">start</a> 144 145 <span class="flag deprecated">deprecated</span> 146 </li> 147 <li class="index-item method"> 148 <a href="#" data-tabid="#methods" data-anchor="#method_status" data-tablink="status">status</a> 149 150 </li> 151 </ul> 152 </div> 153 154 155 156 </div> 157 158 <div id="methods" class="tab-pane"> 159 <h2 class="off-left">Methods</h2> 160 161 <div id="method_live_on" class="method item"> 162 <h3 class="name"><code>live_on</code></h3> 163 164 <span class="paren">()</span> 165 166 167 168 169 170 171 172 173 <div class="meta"> 174 <p> 175 Defined in 176 <a href="../files/backend_rcon.js.html#l66"><code>backend\rcon.js:66</code></a> 177 </p> 178 179 180 181 </div> 182 183 <div class="description"> 184 185 </div> 186 187 188 189 </div> 190 <div id="method_restart_game" class="method item"> 191 <h3 class="name"><code>restart_game</code></h3> 192 193 <span class="paren">()</span> 194 195 196 197 198 199 200 201 202 <div class="meta"> 203 <p> 204 Defined in 205 <a href="../files/backend_rcon.js.html#l37"><code>backend\rcon.js:37</code></a> 206 </p> 207 208 209 210 </div> 211 212 <div class="description"> 213 214 </div> 215 216 217 218 </div> 219 <div id="method_start" class="method item deprecated"> 220 <h3 class="name"><code>start</code></h3> 221 222 <span class="paren">()</span> 223 224 225 <span class="flag deprecated" title="Could later make problems at start">deprecated</span> 226 227 228 229 230 231 232 <div class="meta"> 233 <p> 234 Defined in 235 <a href="../files/backend_rcon.js.html#l17"><code>backend\rcon.js:17</code></a> 236 </p> 237 238 239 <p>Deprecated: Could later make problems at start</p> 240 241 </div> 242 243 <div class="description"> 244 245 </div> 246 247 248 249 </div> 250 <div id="method_status" class="method item"> 251 <h3 class="name"><code>status</code></h3> 252 253 <span class="paren">()</span> 254 255 <span class="returns-inline"> 256 <span class="type">String</span> 257 </span> 258 259 260 261 262 263 264 265 <div class="meta"> 266 <p> 267 Defined in 268 <a href="../files/backend_rcon.js.html#l52"><code>backend\rcon.js:52</code></a> 269 </p> 270 271 272 273 </div> 274 275 <div class="description"> 276 277 </div> 278 279 280 <div class="returns"> 281 <h4>Returns:</h4> 282 283 <div class="returns-description"> 284 <span class="type">String</span>: 285 <p>Status from the Server.</p> 286 287 </div> 288 </div> 289 290 </div> 291 </div> 292 293 294 295 </div> 296 </div> 297 </div> 298 </div> 299 </div> 300 </div> 301 </div> 302 </div> 303 <script src="../assets/vendor/jquery/jquery-1.8.2.min.js"></script> 304 <script src="../assets/vendor/bootstrap/js/bootstrap.js"></script> 305 <script src="../assets/vendor/prettify/prettify-min.js"></script> 306 <script src="../assets/js/yuidoc-bootstrap.js"></script> 307 <script>prettyPrint();</script> 308 </body> 309 </html>