<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: Types - All project constants and types</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">Module: Types - All project constants and types</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
</div>
<h3 class="subsection-title">Type Definitions</h3>
<h4 class="name" id="~Ability">Ability</h4>
<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="module-Types.html#.AbilityHook">module:Types.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">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~BattleTile">BattleTile</h4>
<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">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~GameGlobalState">GameGlobalState</h4>
<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="module-Types.html#.GameStateEnum">module:Types.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.<module:Types.HeroCard></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="module-Types.html#.DeckMode">module:Types.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="module-Types.html#.AdvRule">module:Types.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">Color</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.<module:Types.BattleTile></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.<module:Types.BattleTile></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.<module:Types.BattleTile></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></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">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line79">line 79</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~HeroCard">HeroCard</h4>
<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="module-Types.html#.Faction">module:Types.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="module-Types.html#.Popularity">module:Types.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">Ability</span>
</td>
<td class="description last"><p>Ability of a hero</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line54">line 54</a>
</li></ul></dd>
</dl>
<h4 class="name" id="~HeroInGame">HeroInGame</h4>
<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">number</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">number</span>
</td>
<td class="description last"><p>Actions possible on hero</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line96">line 96</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">12 Heroes</a></h2><h3>Modules</h3><ul><li><a href="module-GameStore%2520-%2520vuex%2520store%2520part%2520with%2520game%2520data.html">GameStore - vuex store part with game data</a></li><li><a href="module-Types%2520-%2520All%2520project%2520constants%2520and%2520types.html">Types - All project constants and types</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Getters">Getters</a></li><li><a href="global.html#State">State</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Mon May 18 2020 18:01:18 GMT+0200 (Central European Summer Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>