<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>Namespace: Typedefs</title>
    
    
    
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="scripts/prettify/prettify.js"></script>
    <script src="scripts/prettify/lang-css.js"></script>
    <script src="scripts/jquery.min.js"></script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link href="https://fonts.googleapis.com/css?family=Libre+Franklin:400,700" rel="stylesheet">
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
    <link type="text/css" rel="stylesheet" href="styles/main.css">

    
    <script>
    var config = {"monospaceLinks":false,"cleverLinks":false,"applicationName":"12 Heroes","default":{}};
    </script>
    

    
</head>
<body>
<div id="wrap" class="clearfix">
    
<div class="navigation">
    <h3 class="applicationName"><a href="index.html">12 Heroes</a></h3>
    <button id="menuToggle" class="btn btn-link btn-lg menu-toggle">
        <span class="glyphicon glyphicon-menu-hamburger"></span>
    </button>
    <div class="search">
        <input id="search" type="text" class="form-control input-md" placeholder="Search...">
    </div>
    <ul class="list">
    
    
        <li class="item" data-name="module:GameStore - vuex store part with game data">
            <span class="title namespace ">
                
                <span class="namespaceTag">
                    <span class="glyphicon glyphicon-folder-open"></span>
                </span>
                
                
                    <a href="module-GameStore%2520-%2520vuex%2520store%2520part%2520with%2520game%2520data.html">GameStore - vuex store part with game data</a>
                
            </span>
            
            <ul class="members itemMembers">
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            </ul>
            
            <ul class="methods itemMembers">
            
            </ul>
            
            <ul class="events itemMembers">
            
            </ul>
            
        </li>
    
        <li class="item" data-name="Constants">
            <span class="title namespace ">
                
                <span class="namespaceTag">
                    <span class="glyphicon glyphicon-folder-open"></span>
                </span>
                
                
                    <a href="Constants.html">Constants</a>
                
            </span>
            
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li class="parent " data-name="Constants.POS_BATTLE_CENTER"><a href="Constants.html#.POS_BATTLE_CENTER">POS_BATTLE_CENTER</a></li>
            
                <li class="parent " data-name="Constants.POS_BATTLE_LEFT"><a href="Constants.html#.POS_BATTLE_LEFT">POS_BATTLE_LEFT</a></li>
            
                <li class="parent " data-name="Constants.POS_BATTLE_RIGHT"><a href="Constants.html#.POS_BATTLE_RIGHT">POS_BATTLE_RIGHT</a></li>
            
                <li class="parent " data-name="Constants.POS_CAMP"><a href="Constants.html#.POS_CAMP">POS_CAMP</a></li>
            
                <li class="parent " data-name="Constants.POS_DISCARD"><a href="Constants.html#.POS_DISCARD">POS_DISCARD</a></li>
            
                <li class="parent " data-name="Constants.POS_HAND"><a href="Constants.html#.POS_HAND">POS_HAND</a></li>
            
                <li class="parent " data-name="Constants.POS_PILE"><a href="Constants.html#.POS_PILE">POS_PILE</a></li>
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            </ul>
            
            <ul class="methods itemMembers">
            
            </ul>
            
            <ul class="events itemMembers">
            
            </ul>
            
        </li>
    
        <li class="item" data-name="Typedefs">
            <span class="title namespace ">
                
                <span class="namespaceTag">
                    <span class="glyphicon glyphicon-folder-open"></span>
                </span>
                
                
                    <a href="global.html#Typedefs">Typedefs</a>
                
            </span>
            
            <ul class="members itemMembers">
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            <span class="subtitle">Typedefs</span>
            
                <li class="parent" data-name="Typedefs.Ability"><a href="global.html#Typedefs#.Ability">Ability</a></li>
            
                <li class="parent" data-name="Typedefs.AbilityHook"><a href="global.html#Typedefs#.AbilityHook">AbilityHook</a></li>
            
                <li class="parent" data-name="Typedefs.AdvRule"><a href="global.html#Typedefs#.AdvRule">AdvRule</a></li>
            
                <li class="parent" data-name="Typedefs.BattleTile"><a href="global.html#Typedefs#.BattleTile">BattleTile</a></li>
            
                <li class="parent" data-name="Typedefs.Color"><a href="global.html#Typedefs#.Color">Color</a></li>
            
                <li class="parent" data-name="Typedefs.DeckMode"><a href="global.html#Typedefs#.DeckMode">DeckMode</a></li>
            
                <li class="parent" data-name="Typedefs.Faction"><a href="global.html#Typedefs#.Faction">Faction</a></li>
            
                <li class="parent" data-name="Typedefs.GameGlobalState"><a href="global.html#Typedefs#.GameGlobalState">GameGlobalState</a></li>
            
                <li class="parent" data-name="Typedefs.GameStateEnum"><a href="global.html#Typedefs#.GameStateEnum">GameStateEnum</a></li>
            
                <li class="parent" data-name="Typedefs.HeroAction"><a href="global.html#Typedefs#.HeroAction">HeroAction</a></li>
            
                <li class="parent" data-name="Typedefs.HeroCard"><a href="global.html#Typedefs#.HeroCard">HeroCard</a></li>
            
                <li class="parent" data-name="Typedefs.HeroInGame"><a href="global.html#Typedefs#.HeroInGame">HeroInGame</a></li>
            
                <li class="parent" data-name="Typedefs.HeroPosition"><a href="global.html#Typedefs#.HeroPosition">HeroPosition</a></li>
            
                <li class="parent" data-name="Typedefs.PlayerAction"><a href="global.html#Typedefs#.PlayerAction">PlayerAction</a></li>
            
                <li class="parent" data-name="Typedefs.PlayerGameState"><a href="global.html#Typedefs#.PlayerGameState">PlayerGameState</a></li>
            
                <li class="parent" data-name="Typedefs.Popularity"><a href="global.html#Typedefs#.Popularity">Popularity</a></li>
            
                <li class="parent" data-name="Typedefs.StoreData"><a href="global.html#Typedefs#.StoreData">StoreData</a></li>
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            </ul>
            
            <ul class="methods itemMembers">
            
            </ul>
            
            <ul class="events itemMembers">
            
            </ul>
            
        </li>
    
        <li class="item" data-name="global">
            <span class="title namespace ">
                
                <span class="namespaceTag">
                    <span class="glyphicon glyphicon-globe"></span>
                </span>
                
                
                    <a href="global.html">Global</a>
                
            </span>
            
            <ul class="members itemMembers">
            
            <span class="subtitle">Members</span>
            
                <li class="parent " data-name="Typedefs"><a href="global.html#Typedefs">Typedefs</a></li>
            
                <li class="parent " data-name="unused"><a href="global.html#unused">unused</a></li>
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            <span class="subtitle">Typedefs</span>
            
                <li class="parent" data-name="StoreData"><a href="global.html#StoreData">StoreData</a></li>
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            </ul>
            
            <ul class="methods itemMembers">
            
            </ul>
            
            <ul class="events itemMembers">
            
            </ul>
            
        </li>
    
    </ul>
</div>

    <div class="main">
        <h1 class="page-title" data-filename="global.html#Typedefs">Namespace: Typedefs</h1>
        



<section>
    
<header>
    <div class="header content-size">
        <h2>Typedefs
        </h2>
        
    </div>
</header>  

<article class="content-size">
    
        <div class="container-overview">
        

        
            

            
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>


            
        
        </div>
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
        <h3 class="subsection-title">Type Definitions</h3>
        
        <dl class="list-definitions">
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".Ability">
            <a class="share-icon" href="#.Ability"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.Ability</span>
            <span class="type-signature type">object</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Ability of an Hero</p>
    </div>
    
    
    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<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">AbilityHook</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>
        
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".AbilityHook">
            <a class="share-icon" href="#.AbilityHook"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.AbilityHook</span>
            <span class="type-signature type">"AfterDeploy" | "AfterDiscard" | "AfterRecruit" | "BeforeControl" | "BeforeMaintenance" | "BeforeMilitary"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Ability Hook</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".AdvRule">
            <a class="share-icon" href="#.AdvRule"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.AdvRule</span>
            <span class="type-signature type">"popularity" | "discard"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Possible advanced rules</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".BattleTile">
            <a class="share-icon" href="#.BattleTile"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.BattleTile</span>
            <span class="type-signature type">object</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Battle Tile object</p>
    </div>
    
    
    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<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>
        
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".Color">
            <a class="share-icon" href="#.Color"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.Color</span>
            <span class="type-signature type">"blue" | "red"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>player colors</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".DeckMode">
            <a class="share-icon" href="#.DeckMode"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.DeckMode</span>
            <span class="type-signature type">"faction" | "draft" | "tournament"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Values For Deck Mode.</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".Faction">
            <a class="share-icon" href="#.Faction"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.Faction</span>
            <span class="type-signature type">"orcs" | "humans" | "elves" | "meca" | "none"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Faction of a hero</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".GameGlobalState">
            <a class="share-icon" href="#.GameGlobalState"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.GameGlobalState</span>
            <span class="type-signature type">object</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>One game global state</p>
    </div>
    
    
    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<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">GameStateEnum</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.&lt;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">DeckMode</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.&lt;AdvRule></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.&lt;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.&lt;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.&lt;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>
        
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".GameStateEnum">
            <a class="share-icon" href="#.GameStateEnum"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.GameStateEnum</span>
            <span class="type-signature type">"0_INIT" | "1_SELECT_DRAFT" | "1_SELECT_FACTION" | "1_SELECT_TOURNAMENT" | "2_CHANGE_UP_TO_3_CARDS"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Values for Game state.</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".HeroAction">
            <a class="share-icon" href="#.HeroAction"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.HeroAction</span>
            <span class="type-signature type">"recruit" | "deploy" | "move" | "ability" | "dismiss" | "discard" | "replace"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Possible action for a hero</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".HeroCard">
            <a class="share-icon" href="#.HeroCard"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.HeroCard</span>
            <span class="type-signature type">object</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Hero card</p>
    </div>
    
    
    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<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">Faction</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">Popularity</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>
        
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".HeroInGame">
            <a class="share-icon" href="#.HeroInGame"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.HeroInGame</span>
            <span class="type-signature type">object</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Hero in game</p>
    </div>
    
    
    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<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">HeroPosition</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.&lt;HeroAction></span>


            
            </td>
            
            
            
            
            
            <td class="description last"><p>Actions possible on hero</p></td>
        </tr>
	
	
	</tbody>
</table></dl>
        
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".HeroPosition">
            <a class="share-icon" href="#.HeroPosition"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.HeroPosition</span>
            <span class="type-signature type">"pile" | "hand" | "discard" | "camp" | "battle_left" | "battle_center" | "battle_right"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Possible position for a hero</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".PlayerAction">
            <a class="share-icon" href="#.PlayerAction"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.PlayerAction</span>
            <span class="type-signature type">"supply" | "pass"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Possible action for a player</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".PlayerGameState">
            <a class="share-icon" href="#.PlayerGameState"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.PlayerGameState</span>
            <span class="type-signature type">object</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Game state for one player</p>
    </div>
    
    
    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<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">Color</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">Faction</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.&lt;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.&lt;HeroInGame></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.&lt;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.&lt;PlayerAction></span>


            
            </td>
            
            
            
            
            
            <td class="description last"><p>Actions avalaible for the player</p></td>
        </tr>
	
	
	</tbody>
</table></dl>
        
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".Popularity">
            <a class="share-icon" href="#.Popularity"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.Popularity</span>
            <span class="type-signature type">"with" | "without" | "any"</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>popularity attribute of a hero</p>
    </div>
    
    
    
<dl class="details">
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            
                
<dt>
    <div class="nameContainer">
        <h4 class="name" id=".StoreData">
            <a class="share-icon" href="#.StoreData"><span class="glyphicon glyphicon-link"></span></a>
            <span class="">Typedefs.StoreData</span>
            <span class="type-signature type">object</span>
            
            
            
            
        </h4>
    </div>
    
    
</dt>
<dd>
    
    <div class="description">
        <p>Store data</p>
    </div>
    
    
    
<dl class="details">
    
        
        <h5 class="subsection-title">Properties:</h5>
        
        <dl>

<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">GameGlobalState</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">PlayerGameState</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">PlayerGameState</span>


            
            </td>
            
            
            
            
            
            <td class="description last"><p>The game state for red player</p></td>
        </tr>
	
	
	</tbody>
</table></dl>
        
    
        
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
</dl>

    
    
</dd>

            </dl>
    
    
    

    
</article>

</section>  





        

        <footer class="content-size">
            <div class="footer">
                Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Tue May 19 2020 12:45:40 GMT+0200 (Central European Summer Time)
            </div>
        </footer>
    </div>
</div>
<script>prettyPrint();</script>
<script src="scripts/main.js"></script>


</body>
</html>