<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global | 12 Heroes</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/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/tui-doc.css">
</head>
<body>
<nav class="lnb" id="lnb">
<div class="logo" style="">
<img src="img/toast-ui.png" width="100%" height="100%">
</div>
<div class="title">
<h1><a href="index.html" class="link">12 Heroes</a></h1>
</div>
<div class="search-container" id="search-container">
<input type="text" placeholder="Search">
<ul></ul>
</div>
<div class="lnb-api hidden"><h3>Namespaces</h3><ul><li><a href="Constants.html">Constants</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants_sub"></div></li><li><a href="Constants.HERO.html">Constants.HERO</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants.HERO_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="Constants.HERO.html#.HERO_ABILITY">HERO_ABILITY</a></li><li><a href="Constants.HERO.html#.HERO_DEPLOY">HERO_DEPLOY</a></li><li><a href="Constants.HERO.html#.HERO_DISCARD">HERO_DISCARD</a></li><li><a href="Constants.HERO.html#.HERO_DISMISS">HERO_DISMISS</a></li><li><a href="Constants.HERO.html#.HERO_MOVE">HERO_MOVE</a></li><li><a href="Constants.HERO.html#.HERO_RECRUIT">HERO_RECRUIT</a></li><li><a href="Constants.HERO.html#.HERO_REPLACE">HERO_REPLACE</a></li></ul></div></li><li><a href="Constants.PLAYER.html">Constants.PLAYER</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants.PLAYER_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="Constants.PLAYER.html#.PLAYER_PASS">PLAYER_PASS</a></li><li><a href="Constants.PLAYER.html#.PLAYER_SUPPLY">PLAYER_SUPPLY</a></li></ul></div></li><li><a href="Constants.POS.html">Constants.POS</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants.POS_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="Constants.POS.html#.POS_BATTLE_CENTER">POS_BATTLE_CENTER</a></li><li><a href="Constants.POS.html#.POS_BATTLE_LEFT">POS_BATTLE_LEFT</a></li><li><a href="Constants.POS.html#.POS_BATTLE_RIGHT">POS_BATTLE_RIGHT</a></li><li><a href="Constants.POS.html#.POS_CAMP">POS_CAMP</a></li><li><a href="Constants.POS.html#.POS_DISCARD">POS_DISCARD</a></li><li><a href="Constants.POS.html#.POS_HAND">POS_HAND</a></li><li><a href="Constants.POS.html#.POS_PILE">POS_PILE</a></li></ul></div></li><li><a href="Constants.REQ.html">Constants.REQ</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants.REQ_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="Constants.REQ.html#.REQ_ERROR">REQ_ERROR</a></li><li><a href="Constants.REQ.html#.REQ_IDLE">REQ_IDLE</a></li><li><a href="Constants.REQ.html#.REQ_REQUESTED">REQ_REQUESTED</a></li><li><a href="Constants.REQ.html#.REQ_SUCCESS">REQ_SUCCESS</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Global</h3><ul><li><a href="global.html#getDraftSets">getDraftSets</a></li><li><a href="global.html#getHeroesIdsByFaction">getHeroesIdsByFaction</a></li><li><a href="global.html#shuffleHeroes">shuffleHeroes</a></li><li><a href="global.html#TH_Ability">TH_Ability</a></li><li><a href="global.html#TH_AbilityHook">TH_AbilityHook</a></li><li><a href="global.html#TH_AdvRule">TH_AdvRule</a></li><li><a href="global.html#TH_BattleTile">TH_BattleTile</a></li><li><a href="global.html#TH_Color">TH_Color</a></li><li><a href="global.html#TH_CommStatus">TH_CommStatus</a></li><li><a href="global.html#TH_DeckMode">TH_DeckMode</a></li><li><a href="global.html#TH_Faction">TH_Faction</a></li><li><a href="global.html#TH_GameDataStore">TH_GameDataStore</a></li><li><a href="global.html#TH_GameGlobalState">TH_GameGlobalState</a></li><li><a href="global.html#TH_GameStateEnum">TH_GameStateEnum</a></li><li><a href="global.html#TH_HeroAction">TH_HeroAction</a></li><li><a href="global.html#TH_HeroCard">TH_HeroCard</a></li><li><a href="global.html#TH_HeroInGame">TH_HeroInGame</a></li><li><a href="global.html#TH_HeroPosition">TH_HeroPosition</a></li><li><a href="global.html#TH_MessageChatFrom">TH_MessageChatFrom</a></li><li><a href="global.html#TH_MessageDraftStep">TH_MessageDraftStep</a></li><li><a href="global.html#TH_MessageFaction">TH_MessageFaction</a></li><li><a href="global.html#TH_MessageTournamentDeckStep">TH_MessageTournamentDeckStep</a></li><li><a href="global.html#TH_PlayerAction">TH_PlayerAction</a></li><li><a href="global.html#TH_PlayerGameState">TH_PlayerGameState</a></li><li><a href="global.html#TH_Popularity">TH_Popularity</a></li><li><a href="global.html#TH_ReqStatus">TH_ReqStatus</a></li></ul></div>
</nav>
<div id="resizer"></div>
<div class="main" id="main">
<section>
<header>
<h2>Global</h2>
</header>
<article>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="getDraftSets">
<span class="type-signature"><span class="icon green">constant</span> </span>getDraftSets<span class="type-signature"></span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_heroesHelper.js.html">server/src/client-server-shared/heroesHelper.js</a></code>,
<code><a href="server_src_client-server-shared_heroesHelper.js.html#line78">line 78</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Get draft sets to play draft mode</p>
</div>
<!--
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="getHeroesIdsByFaction">
<span class="type-signature"><span class="icon green">constant</span> </span>getHeroesIdsByFaction<span class="type-signature"></span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_heroesHelper.js.html">server/src/client-server-shared/heroesHelper.js</a></code>,
<code><a href="server_src_client-server-shared_heroesHelper.js.html#line50">line 50</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Get 12 heroes id by faction in random order.</p>
</div>
<!--
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="shuffleHeroes">
<span class="type-signature"><span class="icon green">constant</span> </span>shuffleHeroes<span class="type-signature"></span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_heroesHelper.js.html">server/src/client-server-shared/heroesHelper.js</a></code>,
<code><a href="server_src_client-server-shared_heroesHelper.js.html#line107">line 107</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Shuffle Heroes</p>
</div>
<!--
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_Ability">
<span class="type-signature"></span>TH_Ability<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line49">line 49</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Ability of an Hero</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>name of the ability</p></td>
</tr>
<tr>
<td class="name"><code>hook</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_AbilityHook">TH_AbilityHook</a></span>
</td>
<td class="description last"><p>when ability has an effect</p></td>
</tr>
<tr>
<td class="name"><code>isOptionnal</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If true, player will have choice wether to activate ability or not</p></td>
</tr>
<tr>
<td class="name"><code>desc</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Description of the ability effect</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_AbilityHook">
<span class="type-signature"></span>TH_AbilityHook<span class="type-signature"> :'AfterDeploy'|'AfterDiscard'|'AfterRecruit'|'BeforeControl'|'BeforeMaintenance'|'BeforeMilitary'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line44">line 44</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Ability Hook</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'AfterDeploy'</span>
|
<span class="param-type">'AfterDiscard'</span>
|
<span class="param-type">'AfterRecruit'</span>
|
<span class="param-type">'BeforeControl'</span>
|
<span class="param-type">'BeforeMaintenance'</span>
|
<span class="param-type">'BeforeMilitary'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_AdvRule">
<span class="type-signature"></span>TH_AdvRule<span class="type-signature"> :'popularity'|'discard'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line29">line 29</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Possible advanced rules</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'popularity'</span>
|
<span class="param-type">'discard'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_BattleTile">
<span class="type-signature"></span>TH_BattleTile<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line72">line 72</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Battle Tile object</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>unique ID of tile</p></td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>name of tile</p></td>
</tr>
<tr>
<td class="name"><code>victoryPoints</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Number of victory points</p></td>
</tr>
<tr>
<td class="name"><code>victories/blue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Number of red player victories</p></td>
</tr>
<tr>
<td class="name"><code>victories/red</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Number of blue player victories</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_Color">
<span class="type-signature"></span>TH_Color<span class="type-signature"> :'blue'|'red'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line24">line 24</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>player colors</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'blue'</span>
|
<span class="param-type">'red'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_CommStatus">
<span class="type-signature"></span>TH_CommStatus<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
<code><a href="server_src_client-server-shared_type_comm.js.html#line9">line 9</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Comm status</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>status</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_ReqStatus">TH_ReqStatus</a></span>
</td>
<td class="description last"><p>Status of the request</p></td>
</tr>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>Text describing current status</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_DeckMode">
<span class="type-signature"></span>TH_DeckMode<span class="type-signature"> :'faction'|'draft'|'tournament'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line9">line 9</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Values For Deck Mode.</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'faction'</span>
|
<span class="param-type">'draft'</span>
|
<span class="param-type">'tournament'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_Faction">
<span class="type-signature"></span>TH_Faction<span class="type-signature"> :'orcs'|'humans'|'elves'|'meca'|'none'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line14">line 14</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Faction of a hero</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'orcs'</span>
|
<span class="param-type">'humans'</span>
|
<span class="param-type">'elves'</span>
|
<span class="param-type">'meca'</span>
|
<span class="param-type">'none'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_GameDataStore">
<span class="type-signature"></span>TH_GameDataStore<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line131">line 131</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Game Data Store</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>game</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_GameGlobalState">TH_GameGlobalState</a></span>
</td>
<td class="description last"><p>The game global state in store</p></td>
</tr>
<tr>
<td class="name"><code>bluePlayer</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_PlayerGameState">TH_PlayerGameState</a></span>
</td>
<td class="description last"><p>The game state for blue player</p></td>
</tr>
<tr>
<td class="name"><code>redPlayer</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_PlayerGameState">TH_PlayerGameState</a></span>
</td>
<td class="description last"><p>The game state for red player</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_GameGlobalState">
<span class="type-signature"></span>TH_GameGlobalState<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line83">line 83</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>One game global state</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>gameState</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_GameStateEnum">TH_GameStateEnum</a></span>
</td>
<td class="description last"><p>Current status of the game</p></td>
</tr>
<tr>
<td class="name"><code>allHeroes</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#TH_HeroCard">TH_HeroCard</a>></span>
</td>
<td class="description last"><p>Array containing all heroes</p></td>
</tr>
<tr>
<td class="name"><code>deckMode</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_DeckMode">TH_DeckMode</a></span>
</td>
<td class="description last"><p>Deck mode of the game</p></td>
</tr>
<tr>
<td class="name"><code>advRules</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#TH_AdvRule">TH_AdvRule</a>></span>
</td>
<td class="description last"><p>Array describing the active advandced rules, if any</p></td>
</tr>
<tr>
<td class="name"><code>waitingFor/blue</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If true, we are waiting for blue to play</p></td>
</tr>
<tr>
<td class="name"><code>waitingFor/red</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>If true, we are waiting for red to play</p></td>
</tr>
<tr>
<td class="name"><code>currentPlayer</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>
|
<span class="param-type">'both'</span>
</td>
<td class="description last"><p>Who is current player, can be 'both'</p></td>
</tr>
<tr>
<td class="name"><code>battleTiles/left/ofBlue</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#TH_BattleTile">TH_BattleTile</a>></span>
</td>
<td class="description last"><p>Battle tiles on left side of blue player</p></td>
</tr>
<tr>
<td class="name"><code>battleTiles/center/ofBlue</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#TH_BattleTile">TH_BattleTile</a>></span>
</td>
<td class="description last"><p>Battle tiles on center of blue player</p></td>
</tr>
<tr>
<td class="name"><code>battleTiles/right/ofBlue</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#TH_BattleTile">TH_BattleTile</a>></span>
</td>
<td class="description last"><p>Battle tiles on right side of blue player</p></td>
</tr>
<tr>
<td class="name"><code>totalFood</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Total food available for players to take</p></td>
</tr>
<tr>
<td class="name"><code>allHeroesJson</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>All heroes in JSON format (read from a JSON file)</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_GameStateEnum">
<span class="type-signature"></span>TH_GameStateEnum<span class="type-signature"> :'0_INIT'|'1_SELECT_DRAFT'|'1_SELECT_FACTION'|'1_SELECT_TOURNAMENT'|'2_CHANGE_UP_TO_3_CARDS'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line4">line 4</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Values for Game state.</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'0_INIT'</span>
|
<span class="param-type">'1_SELECT_DRAFT'</span>
|
<span class="param-type">'1_SELECT_FACTION'</span>
|
<span class="param-type">'1_SELECT_TOURNAMENT'</span>
|
<span class="param-type">'2_CHANGE_UP_TO_3_CARDS'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_HeroAction">
<span class="type-signature"></span>TH_HeroAction<span class="type-signature"> :'recruit'|'deploy'|'move'|'ability'|'dismiss'|'discard'|'replace'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line34">line 34</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Possible action for a hero</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'recruit'</span>
|
<span class="param-type">'deploy'</span>
|
<span class="param-type">'move'</span>
|
<span class="param-type">'ability'</span>
|
<span class="param-type">'dismiss'</span>
|
<span class="param-type">'discard'</span>
|
<span class="param-type">'replace'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_HeroCard">
<span class="type-signature"></span>TH_HeroCard<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line58">line 58</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Hero card</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>unique ID of hero</p></td>
</tr>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>name of hero</p></td>
</tr>
<tr>
<td class="name"><code>cost</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>cost of hero</p></td>
</tr>
<tr>
<td class="name"><code>power</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>power of hero</p></td>
</tr>
<tr>
<td class="name"><code>faction</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Faction">TH_Faction</a></span>
</td>
<td class="description last"><p>faction of hero</p></td>
</tr>
<tr>
<td class="name"><code>popularity</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Popularity">TH_Popularity</a></span>
</td>
<td class="description last"><p>popularity attribute of hero</p></td>
</tr>
<tr>
<td class="name"><code>isDraftable</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"><p>Is hero available in Draft mode</p></td>
</tr>
<tr>
<td class="name"><code>ability</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Ability">TH_Ability</a></span>
</td>
<td class="description last"><p>Ability of a hero</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_HeroInGame">
<span class="type-signature"></span>TH_HeroInGame<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line100">line 100</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Hero in game</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>unique ID of hero</p></td>
</tr>
<tr>
<td class="name"><code>position</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_HeroPosition">TH_HeroPosition</a></span>
</td>
<td class="description last"><p>position of hero in game</p></td>
</tr>
<tr>
<td class="name"><code>possibleActions</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#TH_HeroAction">TH_HeroAction</a>></span>
</td>
<td class="description last"><p>Actions possible on hero</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_HeroPosition">
<span class="type-signature"></span>TH_HeroPosition<span class="type-signature"> :'pile'|'hand'|'discard'|'camp'|'battle_left'|'battle_center'|'battle_right'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line39">line 39</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Possible position for a hero</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'pile'</span>
|
<span class="param-type">'hand'</span>
|
<span class="param-type">'discard'</span>
|
<span class="param-type">'camp'</span>
|
<span class="param-type">'battle_left'</span>
|
<span class="param-type">'battle_center'</span>
|
<span class="param-type">'battle_right'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_MessageChatFrom">
<span class="type-signature"></span>TH_MessageChatFrom<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
<code><a href="server_src_client-server-shared_type_comm.js.html#line40">line 40</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Message for chat from one player to others</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>from</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>From is the message from</p></td>
</tr>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>The content of chat message</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_MessageDraftStep">
<span class="type-signature"></span>TH_MessageDraftStep<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
<code><a href="server_src_client-server-shared_type_comm.js.html#line24">line 24</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Message from player for draft mode steps.
Each turn of draft mode, players choses 2 new Ids which will be added to his twelveHeroes.</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>
</td>
<td class="description last"><p>color of player</p></td>
</tr>
<tr>
<td class="name"><code>chosenIds</code></td>
<td class="type">
<span class="param-type">Array.<number></span>
</td>
<td class="description last"><p>The chosen Ids</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_MessageFaction">
<span class="type-signature"></span>TH_MessageFaction<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
<code><a href="server_src_client-server-shared_type_comm.js.html#line17">line 17</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Message from player with faction selected</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>
</td>
<td class="description last"><p>color of player</p></td>
</tr>
<tr>
<td class="name"><code>faction</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Faction">TH_Faction</a></span>
</td>
<td class="description last"><p>The chosen faction</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_MessageTournamentDeckStep">
<span class="type-signature"></span>TH_MessageTournamentDeckStep<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
<code><a href="server_src_client-server-shared_type_comm.js.html#line32">line 32</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Message from player for tournament mode.
Player chose 12 heroes.</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>
</td>
<td class="description last"><p>color of player</p></td>
</tr>
<tr>
<td class="name"><code>twelveHeroesIds</code></td>
<td class="type">
<span class="param-type">Array.<number></span>
</td>
<td class="description last"><p>The chosen 12 heroes IDs</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_PlayerAction">
<span class="type-signature"></span>TH_PlayerAction<span class="type-signature"> :'supply'|'pass'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line109">line 109</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Possible action for a player</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'supply'</span>
|
<span class="param-type">'pass'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_PlayerGameState">
<span class="type-signature"></span>TH_PlayerGameState<span class="type-signature"> :object</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line114">line 114</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Game state for one player</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
-->
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"><p>username of this player</p></td>
</tr>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>
</td>
<td class="description last"><p>color of the player</p></td>
</tr>
<tr>
<td class="name"><code>faction</code></td>
<td class="type">
<span class="param-type"><a href="global.html#TH_Faction">TH_Faction</a></span>
|
<span class="param-type">''</span>
</td>
<td class="description last"><p>Chosen faction (empty if not playing faction mode)</p></td>
</tr>
<tr>
<td class="name"><code>draftHeroesIds</code></td>
<td class="type">
<span class="param-type">Array.<number></span>
</td>
<td class="description last"><p>Will contain the IDs of the heroes selectable for draft mode</p></td>
</tr>
<tr>
<td class="name"><code>twelveHeroes</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#TH_HeroInGame">TH_HeroInGame</a>></span>
</td>
<td class="description last"><p>The 12 Heroes used by player</p></td>
</tr>
<tr>
<td class="name"><code>foodInCamp</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Number of food in camp</p></td>
</tr>
<tr>
<td class="name"><code>foodInBattle/left</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Food on left battle field</p></td>
</tr>
<tr>
<td class="name"><code>foodInBattle/center</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Food on center battle field</p></td>
</tr>
<tr>
<td class="name"><code>foodInBattle/right</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"><p>Food on right battle field</p></td>
</tr>
<tr>
<td class="name"><code>actionsPerformed</code></td>
<td class="type">
<span class="param-type">Array.<object></span>
</td>
<td class="description last"><p>During military phase it will contain actions made by player to be replayed by other</p></td>
</tr>
<tr>
<td class="name"><code></code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#TH_PlayerAction">TH_PlayerAction</a>></span>
</td>
<td class="description last"><p>Actions avalaible for the player</p></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_Popularity">
<span class="type-signature"></span>TH_Popularity<span class="type-signature"> :'with'|'without'|'any'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
<code><a href="server_src_client-server-shared_type_game.js.html#line19">line 19</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>popularity attribute of a hero</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'with'</span>
|
<span class="param-type">'without'</span>
|
<span class="param-type">'any'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="TH_ReqStatus">
<span class="type-signature"></span>TH_ReqStatus<span class="type-signature"> :'idle'|'requested'|'success'|'error'</span>
<br>
<br>
<div class="container-source members">
<code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
<code><a href="server_src_client-server-shared_type_comm.js.html#line4">line 4</a></code>
</div>
</h4>
</dt>
<dd>
<div class="description">
<p>Statuses of a server Request</p>
</div>
<!--
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">'idle'</span>
|
<span class="param-type">'requested'</span>
|
<span class="param-type">'success'</span>
|
<span class="param-type">'error'</span>
</li>
</ul>
-->
<dl class="details">
</dl>
</dd>
<hr>
</dl>
</article>
</section>
</div>
<footer>
<img class="logo" src="img/toast-ui.png" style="">
<div class="footer-text">NHN Entertainment. Frontend Development Lab</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tui-doc.js"></script>
<script src="scripts/linenumber.js"></script>
<script>
var id = '_sub'.replace(/"/g, '_');
var selectedApi = document.getElementById(id); // do not use jquery selector
var $selectedApi = $(selectedApi);
$selectedApi.removeClass('hidden');
$selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
showLnbApi();
</script>
</body>
</html>