johan
/
twelve-heroes


			
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471
							<!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>