johan
/
twelve-heroes


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751
							<!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="Typedefs.html">Typedefs</a>
                
            </span>
            
            <ul class="members itemMembers">
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            <span class="subtitle">Typedefs</span>
            
                <li class="parent" data-name="Typedefs.GameGlobalState"><a href="Typedefs.html#.GameGlobalState">GameGlobalState</a></li>
            
                <li class="parent" data-name="Typedefs.GameStateEnum"><a href="Typedefs.html#.GameStateEnum">GameStateEnum</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="unused"><a href="global.html#unused">unused</a></li>
            
            </ul>
            
            <ul class="typedefs itemMembers">
            
            <span class="subtitle">Typedefs</span>
            
                <li class="parent" data-name="Ability"><a href="global.html#Ability">Ability</a></li>
            
                <li class="parent" data-name="AbilityHook"><a href="global.html#AbilityHook">AbilityHook</a></li>
            
                <li class="parent" data-name="AdvRule"><a href="global.html#AdvRule">AdvRule</a></li>
            
                <li class="parent" data-name="BattleTile"><a href="global.html#BattleTile">BattleTile</a></li>
            
                <li class="parent" data-name="Color"><a href="global.html#Color">Color</a></li>
            
                <li class="parent" data-name="DeckMode"><a href="global.html#DeckMode">DeckMode</a></li>
            
                <li class="parent" data-name="Faction"><a href="global.html#Faction">Faction</a></li>
            
                <li class="parent" data-name="HeroAction"><a href="global.html#HeroAction">HeroAction</a></li>
            
                <li class="parent" data-name="HeroCard"><a href="global.html#HeroCard">HeroCard</a></li>
            
                <li class="parent" data-name="HeroInGame"><a href="global.html#HeroInGame">HeroInGame</a></li>
            
                <li class="parent" data-name="HeroPosition"><a href="global.html#HeroPosition">HeroPosition</a></li>
            
                <li class="parent" data-name="PlayerAction"><a href="global.html#PlayerAction">PlayerAction</a></li>
            
                <li class="parent" data-name="PlayerGameState"><a href="global.html#PlayerGameState">PlayerGameState</a></li>
            
                <li class="parent" data-name="Popularity"><a href="global.html#Popularity">Popularity</a></li>
            
                <li class="parent" data-name="StoreData"><a href="global.html#StoreData">StoreData</a></li>
            
                <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="Typedefs.html">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=".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;<a href="global.html#HeroCard">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#DeckMode">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.&lt;<a href="global.html#AdvRule">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#Color">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.&lt;<a href="global.html#BattleTile">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.&lt;<a href="global.html#BattleTile">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.&lt;<a href="global.html#BattleTile">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></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>

            </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:59:09 GMT+0200 (Central European Summer Time)
            </div>
        </footer>
    </div>
</div>
<script>prettyPrint();</script>
<script src="scripts/main.js"></script>


</body>
</html>