johan
/
twelve-heroes


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Module: Types - All project constants and types</title>

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

<body>

<div id="main">

    <h1 class="page-title">Module: Types - All project constants and types</h1>

    
<section>

<header>
    
        
</header>

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

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

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


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


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


        </li>
    </ul>


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

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

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

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

            <td class="type">
            
                
<span class="param-type"><a href="module-Types.html#.AbilityHook">module:Types.AbilityHook</a></span>


            </td>

            
            <td class="description last"><p>when ability has an effect</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>If true, player will have choice wether to activate ability or not</p></td>
        </tr>

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

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


            </td>

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

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line45">line 45</a>
    </li></ul></dd>
    

</dl>


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


<div class="description">
    <p>Battle Tile object</p>
</div>


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


        </li>
    </ul>


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

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

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

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

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


            </td>

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

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

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


            </td>

            
            <td class="description last"><p>Number of victory points</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>Number of red player victories</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>Number of blue player victories</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line68">line 68</a>
    </li></ul></dd>
    

</dl>


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


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


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


        </li>
    </ul>


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

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

        <th>Type</th>

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

    <tbody>
    

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

            <td class="type">
            
                
<span class="param-type"><a href="module-Types.html#.GameStateEnum">module:Types.GameStateEnum</a></span>


            </td>

            
            <td class="description last"><p>Current status of the game</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type">Array.&lt;module:Types.HeroCard></span>


            </td>

            
            <td class="description last"><p>Array containing all heroes</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type"><a href="module-Types.html#.DeckMode">module:Types.DeckMode</a></span>


            </td>

            
            <td class="description last"><p>Deck mode of the game</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="module-Types.html#.AdvRule">module:Types.AdvRule</a>></span>


            </td>

            
            <td class="description last"><p>Array describing the active advandced rules, if any</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>If true, we are waiting for blue to play</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>If true, we are waiting for red to play</p></td>
        </tr>

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

            <td class="type">
            
                
<span class="param-type">Color</span>
|

<span class="param-type">'both'</span>


            </td>

            
            <td class="description last"><p>Who is current player, can be 'both'</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>battleTiles/left/ofBlue</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;module:Types.BattleTile></span>


            </td>

            
            <td class="description last"><p>Battle tiles on left side of blue player</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>battleTiles/center/ofBlue</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;module:Types.BattleTile></span>


            </td>

            
            <td class="description last"><p>Battle tiles on center of blue player</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>battleTiles/right/ofBlue</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array.&lt;module:Types.BattleTile></span>


            </td>

            
            <td class="description last"><p>Battle tiles on right side of blue player</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>Total food available for players to take</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>All heroes in JSON format (read from a JSON file)</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line79">line 79</a>
    </li></ul></dd>
    

</dl>


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


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


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


        </li>
    </ul>


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

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

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

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

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


            </td>

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

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

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


            </td>

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

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

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


            </td>

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

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

            <td class="type">
            
                
<span class="param-type"><a href="module-Types.html#.Faction">module:Types.Faction</a></span>


            </td>

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

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

            <td class="type">
            
                
<span class="param-type"><a href="module-Types.html#.Popularity">module:Types.Popularity</a></span>


            </td>

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

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

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


            </td>

            
            <td class="description last"><p>Is hero available in Draft mode</p></td>
        </tr>

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

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


            </td>

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

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line54">line 54</a>
    </li></ul></dd>
    

</dl>


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


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


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


        </li>
    </ul>


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

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

        <th>Type</th>

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

    <tbody>
    

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

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


            </td>

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

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

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


            </td>

            
            <td class="description last"><p>position of hero in game</p></td>
        </tr>

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

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


            </td>

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

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="server_src_client-server-shared_types.js.html">server/src/client-server-shared/types.js</a>, <a href="server_src_client-server-shared_types.js.html#line96">line 96</a>
    </li></ul></dd>
    

</dl>


</article>

</section>


</div>

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

<br class="clear">

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

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