johan
/
twelve-heroes


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Module: typedefs</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Module: typedefs</h1>

    
<section>

<header>
    
        
</header>

<article>
    <div class="container-overview">
    
        
    </div>

    
        <h3 class="subsection-title">Type Definitions</h3>

        
<h4 class="name" id="~Ability">Ability</h4>


<div class="description">
    <p>Ability of an Hero</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>name of the ability</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>hook</code></td>
            

            <td class="type">
            
                
<span class="param-type">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 class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line52">line 52</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~AbilityHook">AbilityHook</h4>


<div class="description">
    <p>Ability Hook</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"AfterDeploy"</span>
|

<span class="param-type">"AfterDiscard"</span>
|

<span class="param-type">"AfterRecruit"</span>
|

<span class="param-type">"BeforeControl"</span>
|

<span class="param-type">"BeforeMaintenance"</span>
|

<span class="param-type">"BeforeMilitary"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line47">line 47</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~AdvRule">AdvRule</h4>


<div class="description">
    <p>Possible advanced rules</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"popularity"</span>
|

<span class="param-type">"discard"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line32">line 32</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~Color">Color</h4>


<div class="description">
    <p>player colors</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"blue"</span>
|

<span class="param-type">"red"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line27">line 27</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~DeckMode">DeckMode</h4>


<div class="description">
    <p>Values For Deck Mode.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"faction"</span>
|

<span class="param-type">"draft"</span>
|

<span class="param-type">"tournament"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line12">line 12</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~Faction">Faction</h4>


<div class="description">
    <p>Faction of a hero</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"orcs"</span>
|

<span class="param-type">"humans"</span>
|

<span class="param-type">"elves"</span>
|

<span class="param-type">"meca"</span>
|

<span class="param-type">"none"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line17">line 17</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~GameGlobalState">GameGlobalState</h4>


<div class="description">
    <p>One game global state</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>gameState</code></td>
            

            <td class="type">
            
                
<span class="param-type">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 class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line87">line 87</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~GameStateEnum">GameStateEnum</h4>


<div class="description">
    <p>Values for Game state.</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"0_INIT"</span>
|

<span class="param-type">"1_SELECT_DRAFT"</span>
|

<span class="param-type">"1_SELECT_FACTION"</span>
|

<span class="param-type">"1_SELECT_TOURNAMENT"</span>
|

<span class="param-type">"2_CHANGE_UP_TO_3_CARDS"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line7">line 7</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~HeroAction">HeroAction</h4>


<div class="description">
    <p>Possible action for a hero</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"recruit"</span>
|

<span class="param-type">"deploy"</span>
|

<span class="param-type">"move"</span>
|

<span class="param-type">"ability"</span>
|

<span class="param-type">"dismiss"</span>
|

<span class="param-type">"discard"</span>
|

<span class="param-type">"replace"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line37">line 37</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~HeroCard">HeroCard</h4>


<div class="description">
    <p>Hero card</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last"><p>unique ID of hero</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>name of hero</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>cost</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last"><p>cost of hero</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>power</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last"><p>power of hero</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>faction</code></td>
            

            <td class="type">
            
                
<span class="param-type">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 class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line61">line 61</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~HeroInGame">HeroInGame</h4>


<div class="description">
    <p>Hero in game</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>id</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last"><p>unique ID of hero</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>position</code></td>
            

            <td class="type">
            
                
<span class="param-type">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 class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line104">line 104</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~HeroPosition">HeroPosition</h4>


<div class="description">
    <p>Possible position for a hero</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"pile"</span>
|

<span class="param-type">"hand"</span>
|

<span class="param-type">"discard"</span>
|

<span class="param-type">"camp"</span>
|

<span class="param-type">"battle_left"</span>
|

<span class="param-type">"battle_center"</span>
|

<span class="param-type">"battle_right"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line42">line 42</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~PlayerAction">PlayerAction</h4>


<div class="description">
    <p>Possible action for a player</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"supply"</span>
|

<span class="param-type">"pass"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line113">line 113</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~PlayerGameState">PlayerGameState</h4>


<div class="description">
    <p>Game state for one player</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>username of this player</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>color</code></td>
            

            <td class="type">
            
                
<span class="param-type">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 class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line118">line 118</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~Popularity">Popularity</h4>


<div class="description">
    <p>popularity attribute of a hero</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">"with"</span>
|

<span class="param-type">"without"</span>
|

<span class="param-type">"any"</span>


        </li>
    </ul>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line22">line 22</a>
    </li></ul></dd>
    

</dl>


<h4 class="name" id="~StoreData">StoreData</h4>


<div class="description">
    <p>Store data</p>
</div>


    <h5>Type:</h5>
    <ul>
        <li>
            
<span class="param-type">object</span>


        </li>
    </ul>


    <h5 class="subsection-title">Properties:</h5>

    
<table class="props">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>game</code></td>
            

            <td class="type">
            
                
<span class="param-type">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 class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_def_typedefs.js.html">server/src/client-server-shared/def/typedefs.js</a>, <a href="server_src_client-server-shared_def_typedefs.js.html#line135">line 135</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

<nav>
    <h2><a href="index.html">12 Heroes</a></h2><h3>Modules</h3><ul><li><a href="module-GameStore%2520-%2520vuex%2520store%2520part%2520with%2520game%2520data.html">GameStore - vuex store part with game data</a></li><li><a href="module-typedefs.html">typedefs</a></li></ul><h3>Namespaces</h3><ul><li><a href="constants.html">constants</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Getters">Getters</a></li><li><a href="global.html#State">State</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.4</a> on Mon May 18 2020 21:55:23 GMT+0200 (Central European Summer Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>