johan
/
twelve-heroes


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Global | 12 Heroes</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/bootstrap.min.css">
    <link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/tui-doc.css">

    
</head>
<body>
<nav class="lnb" id="lnb">
    <div class="logo" style="">
        
            <img src="img/toast-ui.png" width="100%" height="100%">
        
    </div>
    <div class="title">
        <h1><a href="index.html" class="link">12 Heroes</a></h1>
        
    </div>
    <div class="search-container" id="search-container">
        <input type="text" placeholder="Search">
        <ul></ul>
    </div>
    
    <div class="lnb-api hidden"><h3>Namespaces</h3><ul><li><a href="Constants.html">Constants</a><button type="button" class="hidden toggle-subnav btn btn-link">  <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants_sub"></div></li><li><a href="Constants.HERO.html">Constants.HERO</a><button type="button" class="hidden toggle-subnav btn btn-link">  <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants.HERO_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="Constants.HERO.html#.HERO_ABILITY">HERO_ABILITY</a></li><li><a href="Constants.HERO.html#.HERO_DEPLOY">HERO_DEPLOY</a></li><li><a href="Constants.HERO.html#.HERO_DISCARD">HERO_DISCARD</a></li><li><a href="Constants.HERO.html#.HERO_DISMISS">HERO_DISMISS</a></li><li><a href="Constants.HERO.html#.HERO_MOVE">HERO_MOVE</a></li><li><a href="Constants.HERO.html#.HERO_RECRUIT">HERO_RECRUIT</a></li><li><a href="Constants.HERO.html#.HERO_REPLACE">HERO_REPLACE</a></li></ul></div></li><li><a href="Constants.PLAYER.html">Constants.PLAYER</a><button type="button" class="hidden toggle-subnav btn btn-link">  <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants.PLAYER_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="Constants.PLAYER.html#.PLAYER_PASS">PLAYER_PASS</a></li><li><a href="Constants.PLAYER.html#.PLAYER_SUPPLY">PLAYER_SUPPLY</a></li></ul></div></li><li><a href="Constants.POS.html">Constants.POS</a><button type="button" class="hidden toggle-subnav btn btn-link">  <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants.POS_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="Constants.POS.html#.POS_BATTLE_CENTER">POS_BATTLE_CENTER</a></li><li><a href="Constants.POS.html#.POS_BATTLE_LEFT">POS_BATTLE_LEFT</a></li><li><a href="Constants.POS.html#.POS_BATTLE_RIGHT">POS_BATTLE_RIGHT</a></li><li><a href="Constants.POS.html#.POS_CAMP">POS_CAMP</a></li><li><a href="Constants.POS.html#.POS_DISCARD">POS_DISCARD</a></li><li><a href="Constants.POS.html#.POS_HAND">POS_HAND</a></li><li><a href="Constants.POS.html#.POS_PILE">POS_PILE</a></li></ul></div></li><li><a href="Constants.REQ.html">Constants.REQ</a><button type="button" class="hidden toggle-subnav btn btn-link">  <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Constants.REQ_sub"><div class="member-type">Members</div><ul class="inner"><li><a href="Constants.REQ.html#.REQ_ERROR">REQ_ERROR</a></li><li><a href="Constants.REQ.html#.REQ_IDLE">REQ_IDLE</a></li><li><a href="Constants.REQ.html#.REQ_REQUESTED">REQ_REQUESTED</a></li><li><a href="Constants.REQ.html#.REQ_SUCCESS">REQ_SUCCESS</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Global</h3><ul><li><a href="global.html#getDraftSets">getDraftSets</a></li><li><a href="global.html#getHeroesIdsByFaction">getHeroesIdsByFaction</a></li><li><a href="global.html#shuffleHeroes">shuffleHeroes</a></li><li><a href="global.html#TH_Ability">TH_Ability</a></li><li><a href="global.html#TH_AbilityHook">TH_AbilityHook</a></li><li><a href="global.html#TH_AdvRule">TH_AdvRule</a></li><li><a href="global.html#TH_BattleTile">TH_BattleTile</a></li><li><a href="global.html#TH_Color">TH_Color</a></li><li><a href="global.html#TH_CommStatus">TH_CommStatus</a></li><li><a href="global.html#TH_DeckMode">TH_DeckMode</a></li><li><a href="global.html#TH_Faction">TH_Faction</a></li><li><a href="global.html#TH_GameDataStore">TH_GameDataStore</a></li><li><a href="global.html#TH_GameGlobalState">TH_GameGlobalState</a></li><li><a href="global.html#TH_GameStateEnum">TH_GameStateEnum</a></li><li><a href="global.html#TH_HeroAction">TH_HeroAction</a></li><li><a href="global.html#TH_HeroCard">TH_HeroCard</a></li><li><a href="global.html#TH_HeroInGame">TH_HeroInGame</a></li><li><a href="global.html#TH_HeroPosition">TH_HeroPosition</a></li><li><a href="global.html#TH_MessageChatFrom">TH_MessageChatFrom</a></li><li><a href="global.html#TH_MessageDraftStep">TH_MessageDraftStep</a></li><li><a href="global.html#TH_MessageFaction">TH_MessageFaction</a></li><li><a href="global.html#TH_MessageTournamentDeckStep">TH_MessageTournamentDeckStep</a></li><li><a href="global.html#TH_PlayerAction">TH_PlayerAction</a></li><li><a href="global.html#TH_PlayerGameState">TH_PlayerGameState</a></li><li><a href="global.html#TH_Popularity">TH_Popularity</a></li><li><a href="global.html#TH_ReqStatus">TH_ReqStatus</a></li></ul></div>
</nav>
<div id="resizer"></div>

<div class="main" id="main">
    

<section>

<header>
    
        <h2>Global</h2>
    
</header>

<article>
    

        <h3 class="subsection-title">Members</h3>

        <dl>
            

<dt>
<h4 class="name" id="getDraftSets">
    <span class="type-signature"><span class="icon green">constant</span> </span>getDraftSets<span class="type-signature"></span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_heroesHelper.js.html">server/src/client-server-shared/heroesHelper.js</a></code>,
        <code><a href="server_src_client-server-shared_heroesHelper.js.html#line78">line 78</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Get draft sets to play draft mode</p>
    </div>
    

    <!--
    
    -->

    
<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="getHeroesIdsByFaction">
    <span class="type-signature"><span class="icon green">constant</span> </span>getHeroesIdsByFaction<span class="type-signature"></span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_heroesHelper.js.html">server/src/client-server-shared/heroesHelper.js</a></code>,
        <code><a href="server_src_client-server-shared_heroesHelper.js.html#line50">line 50</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Get 12 heroes id by faction in random order.</p>
    </div>
    

    <!--
    
    -->

    
<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="shuffleHeroes">
    <span class="type-signature"><span class="icon green">constant</span> </span>shuffleHeroes<span class="type-signature"></span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_heroesHelper.js.html">server/src/client-server-shared/heroesHelper.js</a></code>,
        <code><a href="server_src_client-server-shared_heroesHelper.js.html#line107">line 107</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Shuffle Heroes</p>
    </div>
    

    <!--
    
    -->

    
<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_Ability">
    <span class="type-signature"></span>TH_Ability<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line49">line 49</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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="global.html#TH_AbilityHook">TH_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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_AbilityHook">
    <span class="type-signature"></span>TH_AbilityHook<span class="type-signature"> :'AfterDeploy'|'AfterDiscard'|'AfterRecruit'|'BeforeControl'|'BeforeMaintenance'|'BeforeMilitary'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line44">line 44</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_AdvRule">
    <span class="type-signature"></span>TH_AdvRule<span class="type-signature"> :'popularity'|'discard'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line29">line 29</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_BattleTile">
    <span class="type-signature"></span>TH_BattleTile<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line72">line 72</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_Color">
    <span class="type-signature"></span>TH_Color<span class="type-signature"> :'blue'|'red'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line24">line 24</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_CommStatus">
    <span class="type-signature"></span>TH_CommStatus<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
        <code><a href="server_src_client-server-shared_type_comm.js.html#line9">line 9</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Comm status</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>status</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TH_ReqStatus">TH_ReqStatus</a></span>


            </td>

            
            <td class="description last"><p>Status of the request</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>Text describing current status</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_DeckMode">
    <span class="type-signature"></span>TH_DeckMode<span class="type-signature"> :'faction'|'draft'|'tournament'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line9">line 9</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_Faction">
    <span class="type-signature"></span>TH_Faction<span class="type-signature"> :'orcs'|'humans'|'elves'|'meca'|'none'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line14">line 14</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_GameDataStore">
    <span class="type-signature"></span>TH_GameDataStore<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line131">line 131</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Game Data Store</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"><a href="global.html#TH_GameGlobalState">TH_GameGlobalState</a></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"><a href="global.html#TH_PlayerGameState">TH_PlayerGameState</a></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"><a href="global.html#TH_PlayerGameState">TH_PlayerGameState</a></span>


            </td>

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

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_GameGlobalState">
    <span class="type-signature"></span>TH_GameGlobalState<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line83">line 83</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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="global.html#TH_GameStateEnum">TH_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;<a href="global.html#TH_HeroCard">TH_HeroCard</a>></span>


            </td>

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

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

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TH_DeckMode">TH_DeckMode</a></span>


            </td>

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

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

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="global.html#TH_AdvRule">TH_AdvRule</a>></span>


            </td>

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

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

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


            </td>

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

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

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


            </td>

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

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

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>
|

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


            </td>

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

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

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="global.html#TH_BattleTile">TH_BattleTile</a>></span>


            </td>

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

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

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="global.html#TH_BattleTile">TH_BattleTile</a>></span>


            </td>

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

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

            <td class="type">
            
                
<span class="param-type">Array.&lt;<a href="global.html#TH_BattleTile">TH_BattleTile</a>></span>


            </td>

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

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

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


            </td>

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

    
        <tr>
            
                <td class="name"><code>allHeroesJson</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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_GameStateEnum">
    <span class="type-signature"></span>TH_GameStateEnum<span class="type-signature"> :'0_INIT'|'1_SELECT_DRAFT'|'1_SELECT_FACTION'|'1_SELECT_TOURNAMENT'|'2_CHANGE_UP_TO_3_CARDS'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line4">line 4</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_HeroAction">
    <span class="type-signature"></span>TH_HeroAction<span class="type-signature"> :'recruit'|'deploy'|'move'|'ability'|'dismiss'|'discard'|'replace'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line34">line 34</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_HeroCard">
    <span class="type-signature"></span>TH_HeroCard<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line58">line 58</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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="global.html#TH_Faction">TH_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="global.html#TH_Popularity">TH_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"><a href="global.html#TH_Ability">TH_Ability</a></span>


            </td>

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

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_HeroInGame">
    <span class="type-signature"></span>TH_HeroInGame<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line100">line 100</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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"><a href="global.html#TH_HeroPosition">TH_HeroPosition</a></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;<a href="global.html#TH_HeroAction">TH_HeroAction</a>></span>


            </td>

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

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_HeroPosition">
    <span class="type-signature"></span>TH_HeroPosition<span class="type-signature"> :'pile'|'hand'|'discard'|'camp'|'battle_left'|'battle_center'|'battle_right'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line39">line 39</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_MessageChatFrom">
    <span class="type-signature"></span>TH_MessageChatFrom<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
        <code><a href="server_src_client-server-shared_type_comm.js.html#line40">line 40</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Message for chat from one player to others</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>from</code></td>
            

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


            </td>

            
            <td class="description last"><p>From is the message from</p></td>
        </tr>

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

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


            </td>

            
            <td class="description last"><p>The content of chat message</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_MessageDraftStep">
    <span class="type-signature"></span>TH_MessageDraftStep<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
        <code><a href="server_src_client-server-shared_type_comm.js.html#line24">line 24</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Message from player for draft mode steps.
Each turn of draft mode, players choses 2 new Ids which will be added to his twelveHeroes.</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>color</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>


            </td>

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

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

            <td class="type">
            
                
<span class="param-type">Array.&lt;number></span>


            </td>

            
            <td class="description last"><p>The chosen Ids</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_MessageFaction">
    <span class="type-signature"></span>TH_MessageFaction<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
        <code><a href="server_src_client-server-shared_type_comm.js.html#line17">line 17</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Message from player with faction selected</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>color</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>


            </td>

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

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

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TH_Faction">TH_Faction</a></span>


            </td>

            
            <td class="description last"><p>The chosen faction</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_MessageTournamentDeckStep">
    <span class="type-signature"></span>TH_MessageTournamentDeckStep<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
        <code><a href="server_src_client-server-shared_type_comm.js.html#line32">line 32</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Message from player for tournament mode.
Player chose 12 heroes.</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>color</code></td>
            

            <td class="type">
            
                
<span class="param-type"><a href="global.html#TH_Color">TH_Color</a></span>


            </td>

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

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

            <td class="type">
            
                
<span class="param-type">Array.&lt;number></span>


            </td>

            
            <td class="description last"><p>The chosen 12 heroes IDs</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_PlayerAction">
    <span class="type-signature"></span>TH_PlayerAction<span class="type-signature"> :'supply'|'pass'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line109">line 109</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_PlayerGameState">
    <span class="type-signature"></span>TH_PlayerGameState<span class="type-signature"> :object</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line114">line 114</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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"><a href="global.html#TH_Color">TH_Color</a></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"><a href="global.html#TH_Faction">TH_Faction</a></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;<a href="global.html#TH_HeroInGame">TH_HeroInGame</a>></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;<a href="global.html#TH_PlayerAction">TH_PlayerAction</a>></span>


            </td>

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

    
    </tbody>
</table>


<dl class="details">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_Popularity">
    <span class="type-signature"></span>TH_Popularity<span class="type-signature"> :'with'|'without'|'any'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_game.js.html">server/src/client-server-shared/type/game.js</a></code>,
        <code><a href="server_src_client-server-shared_type_game.js.html#line19">line 19</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <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">

    
</dl>


</dd>
<hr>
        
            
<dt>
<h4 class="name" id="TH_ReqStatus">
    <span class="type-signature"></span>TH_ReqStatus<span class="type-signature"> :'idle'|'requested'|'success'|'error'</span>
    
    <br>
    <br>
    <div class="container-source members">
        <code><a href="server_src_client-server-shared_type_comm.js.html">server/src/client-server-shared/type/comm.js</a></code>,
        <code><a href="server_src_client-server-shared_type_comm.js.html#line4">line 4</a></code>
    </div>
    
</h4>


</dt>
<dd>
    
    <div class="description">
        <p>Statuses of a server Request</p>
    </div>
    

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

<span class="param-type">'requested'</span>
|

<span class="param-type">'success'</span>
|

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


            </li>
        </ul>
    
    -->

    
<dl class="details">

    
</dl>


</dd>
<hr>
        </dl>
    

</article>

</section>


</div>

<footer>
    <img class="logo" src="img/toast-ui.png" style="">
    <div class="footer-text">NHN Entertainment. Frontend Development Lab</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tui-doc.js"></script>
<script src="scripts/linenumber.js"></script>

    <script>
        var id = '_sub'.replace(/"/g, '_');
        var selectedApi = document.getElementById(id); // do not use jquery selector
        var $selectedApi = $(selectedApi);

        $selectedApi.removeClass('hidden');
        $selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
        showLnbApi();
    </script>

</body>
</html>