<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Player</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: Player</h1> <section> <header> <h2>Player</h2> </header> <article> <div class="container-overview"> <h4 class="name" id="Player"><span class="type-signature"></span>new Player<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Player </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line575">line 575</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="currentGame"><span class="type-signature"></span>currentGame<span class="type-signature"> :<a href="Game.html">Game</a></span></h4> <div class="description"> Reference to current game </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="Game.html">Game</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line598">line 598</a> </li></ul></dd> </dl> <h4 class="name" id="currentMatch"><span class="type-signature"></span>currentMatch<span class="type-signature"> :<a href="Match.html">Match</a></span></h4> <div class="description"> Reference to current match </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="Match.html">Match</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line592">line 592</a> </li></ul></dd> </dl> <h4 class="name" id="currentPieceType"><span class="type-signature"></span>currentPieceType<span class="type-signature"> :<a href="global.html#PieceType">PieceType</a></span></h4> <div class="description"> Player's piece type for current game </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="global.html#PieceType">PieceType</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line610">line 610</a> </li></ul></dd> </dl> <h4 class="name" id="currentRule"><span class="type-signature"></span>currentRule<span class="type-signature"> :<a href="Rule.html">Rule</a></span></h4> <div class="description"> Reference to rule for current game </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="Rule.html">Rule</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line604">line 604</a> </li></ul></dd> </dl> <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :number</span></h4> <div class="description"> Unique ID </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line580">line 580</a> </li></ul></dd> </dl> <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4> <div class="description"> Username </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line586">line 586</a> </li></ul></dd> </dl> <h4 class="name" id="socketID"><span class="type-signature"></span>socketID<span class="type-signature"> :string</span></h4> <div class="description"> ID of player's socket </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line623">line 623</a> </li></ul></dd> </dl> <h4 class="name" id="stats"><span class="type-signature"></span>stats<span class="type-signature"> :<a href="PlayerStats.html">PlayerStats</a></span></h4> <div class="description"> Player's statistics </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="PlayerStats.html">PlayerStats</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line616">line 616</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".createNew"><span class="type-signature">(static) </span>createNew<span class="signature">()</span><span class="type-signature"> → {<a href="Player.html">Player</a>}</span></h4> <div class="description"> Create new player object with unique ID. Player object is not saved to database. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="model.js.html">model.js</a>, <a href="model.js.html#line631">line 631</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - New player object </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="Player.html">Player</a></span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Dice.html">Dice</a></li><li><a href="Game.html">Game</a></li><li><a href="Match.html">Match</a></li><li><a href="MoveAction.html">MoveAction</a></li><li><a href="Piece.html">Piece</a></li><li><a href="Player.html">Player</a></li><li><a href="PlayerStats.html">PlayerStats</a></li><li><a href="Random.html">Random</a></li><li><a href="Rule.html">Rule</a></li><li><a href="RuleBgCasual.html">RuleBgCasual</a></li><li><a href="RuleBgGulbara.html">RuleBgGulbara</a></li><li><a href="RuleBgTapa.html">RuleBgTapa</a></li><li><a href="State.html">State</a></li><li><a href="Utils.html">Utils</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Message">Message</a></li><li><a href="global.html#MoveActionType">MoveActionType</a></li><li><a href="global.html#PieceType">PieceType</a></li><li><a href="global.html#Protocol">Protocol</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Sun Dec 18 2016 20:10:05 GMT+0200 (EET) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>