diff options
Diffstat (limited to 'doc/phpdoc/packages/inc.html')
| -rw-r--r-- | doc/phpdoc/packages/inc.html | 368 |
1 files changed, 184 insertions, 184 deletions
diff --git a/doc/phpdoc/packages/inc.html b/doc/phpdoc/packages/inc.html index c5528a7..b1e32db 100644 --- a/doc/phpdoc/packages/inc.html +++ b/doc/phpdoc/packages/inc.html @@ -252,7 +252,7 @@ <li> - <span class="divider">\</span><a href="../packages/inc.Monster.inc.html">Monster.inc</a> + <span class="divider">\</span><a href="../packages/inc.Inventory.inc.html">Inventory.inc</a> </li> </ul> @@ -264,11 +264,11 @@ <h3><i class="icon-custom icon-class"></i> Classes, interfaces and traits</h3> - <div id="Monster" class="element ajax clickable class"> - <h1>Monster<a href="../classes/Monster.html">¶</a></h1> - <p class="short_description">Represent an Item in the shop or in the Inventory.</p> - <div class="details collapse"></div> - <a href="../classes/Monster.html" class="more">« More »</a> + <div id="Inventory" class="element ajax clickable class"> + <h1>Inventory<a href="../classes/Inventory.html">¶</a></h1> + <p class="short_description">Represent the player's Inventory.</p> + <div class="details collapse">Implemented as a singleton in the session.</div> + <a href="../classes/Inventory.html" class="more">« More »</a> </div> </div> @@ -286,7 +286,7 @@ <li> - <span class="divider">\</span><a href="../packages/inc.craftmine.inc.html">craftmine.inc</a> + <span class="divider">\</span><a href="../packages/inc.dungeon.inc.html">dungeon.inc</a> </li> </ul> @@ -294,11 +294,53 @@ <div class="package-indent"> <h3><i class="icon-custom icon-function"></i> Functions</h3> - <div id="sendCraftMine" class="element ajax clickable function"> - <h1>sendCraftMine<a href="../namespaces/default.html#function_sendCraftMine">¶</a></h1> - <p class="short_description">Sends all data from previous session on page load.</p> - <div class="details collapse">All data from the different modules are packed in an array.</div> - <a href="../namespaces/default.html#function_sendCraftMine" class="more">« More »</a> + <div id="generateMonster" class="element ajax clickable function"> + <h1>generateMonster<a href="../namespaces/default.html#function_generateMonster">¶</a></h1> + <p class="short_description">Loads all the dungeon's monsters from the XML file data/monsters.xml.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_generateMonster" class="more">« More »</a> + </div> + + <div id="initDungeon" class="element ajax clickable function"> + <h1>initDungeon<a href="../namespaces/default.html#function_initDungeon">¶</a></h1> + <p class="short_description">Marks the dungeon as accessible in the session.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_initDungeon" class="more">« More »</a> + </div> + + <div id="sendDungeon" class="element ajax clickable function"> + <h1>sendDungeon<a href="../namespaces/default.html#function_sendDungeon">¶</a></h1> + <p class="short_description">Returns the dungeon array if it was created.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_sendDungeon" class="more">« More »</a> + </div> + + <div id="buildDungeon" class="element ajax clickable function"> + <h1>buildDungeon<a href="../namespaces/default.html#function_buildDungeon">¶</a></h1> + <p class="short_description">Allows acces to the dungeon in the session and sends it to the client.</p> + <div class="details collapse">Debits the dungeon's ticket cost from the player's gold.</div> + <a href="../namespaces/default.html#function_buildDungeon" class="more">« More »</a> + </div> + + <div id="launchDungeon" class="element ajax clickable function"> + <h1>launchDungeon<a href="../namespaces/default.html#function_launchDungeon">¶</a></h1> + <p class="short_description">Sends monsters for a specific floor as specified by the floor POST parameter to the client.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_launchDungeon" class="more">« More »</a> + </div> + + <div id="sendDungeonProgress" class="element ajax clickable function"> + <h1>sendDungeonProgress<a href="../namespaces/default.html#function_sendDungeonProgress">¶</a></h1> + <p class="short_description">Updates floor and monster number from the POST parameters in the session.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_sendDungeonProgress" class="more">« More »</a> + </div> + + <div id="exitDungeon" class="element ajax clickable function"> + <h1>exitDungeon<a href="../namespaces/default.html#function_exitDungeon">¶</a></h1> + <p class="short_description">Marks the dungeon as not accessible in the session.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_exitDungeon" class="more">« More »</a> </div> </div> @@ -364,26 +406,55 @@ <li> - <span class="divider">\</span><a href="../packages/inc.Inventory.inc.html">Inventory.inc</a> + <span class="divider">\</span><a href="../packages/inc.guild.inc.html">guild.inc</a> </li> </ul> - + <div class="package-indent"> + <h3><i class="icon-custom icon-function"></i> Functions</h3> + <div id="createGuild" class="element ajax clickable function"> + <h1>createGuild<a href="../namespaces/default.html#function_createGuild">¶</a></h1> + <p class="short_description">Create the miners guild in the session.</p> + <div class="details collapse">Debits GUILD_COST from the player's gold.</div> + <a href="../namespaces/default.html#function_createGuild" class="more">« More »</a> + </div> + + <div id="hireMiner" class="element ajax clickable function"> + <h1>hireMiner<a href="../namespaces/default.html#function_hireMiner">¶</a></h1> + <p class="short_description">Hire one miner.</p> + <div class="details collapse">Debits MINER_COST from the player's gold.</div> + <a href="../namespaces/default.html#function_hireMiner" class="more">« More »</a> + </div> + + <div id="sendMiners" class="element ajax clickable function"> + <h1>sendMiners<a href="../namespaces/default.html#function_sendMiners">¶</a></h1> + <p class="short_description">Returns the number of miners currently in the guild.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_sendMiners" class="more">« More »</a> + </div> + + </div> <div class="package-indent"> - <h3><i class="icon-custom icon-class"></i> Classes, interfaces and traits</h3> - - - <div id="Inventory" class="element ajax clickable class"> - <h1>Inventory<a href="../classes/Inventory.html">¶</a></h1> - <p class="short_description">Represent the player's Inventory.</p> - <div class="details collapse">Implemented as a singleton in the session.</div> - <a href="../classes/Inventory.html" class="more">« More »</a> + <h3><i class="icon-custom icon-constant"></i> Constants</h3> + <div id="GUILD_COST" class="element ajax clickable constant"> + <h1>GUILD_COST<a href="../namespaces/default.html#constant_GUILD_COST">¶</a></h1> + <p class="short_description">Amount of gold required to build the miners guild.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#constant_GUILD_COST" class="more">« More »</a> + </div> + + <div id="MINER_COST" class="element ajax clickable constant"> + <h1>MINER_COST<a href="../namespaces/default.html#constant_MINER_COST">¶</a></h1> + <p class="short_description">Amount of gold required to hire a miner.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#constant_MINER_COST" class="more">« More »</a> </div> </div> + @@ -510,7 +581,7 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.dungeon.inc.html">dungeon.inc</a> + <span class="divider">\</span><a href="../packages/inc.shop.inc.html">shop.inc</a> </li> </ul> @@ -518,53 +589,53 @@ sudo chmod g+w data/save <div class="package-indent"> <h3><i class="icon-custom icon-function"></i> Functions</h3> - <div id="generateMonster" class="element ajax clickable function"> - <h1>generateMonster<a href="../namespaces/default.html#function_generateMonster">¶</a></h1> - <p class="short_description">Loads all the dungeon's monsters from the XML file data/monsters.xml.</p> + <div id="loadShop" class="element ajax clickable function"> + <h1>loadShop<a href="../namespaces/default.html#function_loadShop">¶</a></h1> + <p class="short_description">Loads all the shop's items from the XML file data/items.xml.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_generateMonster" class="more">« More »</a> + <a href="../namespaces/default.html#function_loadShop" class="more">« More »</a> </div> - <div id="initDungeon" class="element ajax clickable function"> - <h1>initDungeon<a href="../namespaces/default.html#function_initDungeon">¶</a></h1> - <p class="short_description">Marks the dungeon as accessible in the session.</p> + <div id="getItem" class="element ajax clickable function"> + <h1>getItem<a href="../namespaces/default.html#function_getItem">¶</a></h1> + <p class="short_description">Gets an Item object from the shop from its name.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_initDungeon" class="more">« More »</a> + <a href="../namespaces/default.html#function_getItem" class="more">« More »</a> </div> - <div id="sendDungeon" class="element ajax clickable function"> - <h1>sendDungeon<a href="../namespaces/default.html#function_sendDungeon">¶</a></h1> - <p class="short_description">Returns the dungeon array if it was created.</p> + <div id="initShop" class="element ajax clickable function"> + <h1>initShop<a href="../namespaces/default.html#function_initShop">¶</a></h1> + <p class="short_description">Marks the shop as created in the session.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_sendDungeon" class="more">« More »</a> + <a href="../namespaces/default.html#function_initShop" class="more">« More »</a> </div> - <div id="buildDungeon" class="element ajax clickable function"> - <h1>buildDungeon<a href="../namespaces/default.html#function_buildDungeon">¶</a></h1> - <p class="short_description">Allows acces to the dungeon in the session and sends it to the client.</p> - <div class="details collapse">Debits the dungeon's ticket cost from the player's gold.</div> - <a href="../namespaces/default.html#function_buildDungeon" class="more">« More »</a> + <div id="sendShop" class="element ajax clickable function"> + <h1>sendShop<a href="../namespaces/default.html#function_sendShop">¶</a></h1> + <p class="short_description">Returns the shop array if it was created.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_sendShop" class="more">« More »</a> </div> - <div id="launchDungeon" class="element ajax clickable function"> - <h1>launchDungeon<a href="../namespaces/default.html#function_launchDungeon">¶</a></h1> - <p class="short_description">Sends monsters for a specific floor as specified by the floor POST parameter to the client.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#function_launchDungeon" class="more">« More »</a> + <div id="buildShop" class="element ajax clickable function"> + <h1>buildShop<a href="../namespaces/default.html#function_buildShop">¶</a></h1> + <p class="short_description">Creates the shop in the session and sends it to the client.</p> + <div class="details collapse">Debits the shop's cost from the player's gold.</div> + <a href="../namespaces/default.html#function_buildShop" class="more">« More »</a> </div> - <div id="sendDungeonProgress" class="element ajax clickable function"> - <h1>sendDungeonProgress<a href="../namespaces/default.html#function_sendDungeonProgress">¶</a></h1> - <p class="short_description">Updates floor and monster number from the POST parameters in the session.</p> + <div id="buyItem" class="element ajax clickable function"> + <h1>buyItem<a href="../namespaces/default.html#function_buyItem">¶</a></h1> + <p class="short_description">Debits the item's cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_sendDungeonProgress" class="more">« More »</a> + <a href="../namespaces/default.html#function_buyItem" class="more">« More »</a> </div> - <div id="exitDungeon" class="element ajax clickable function"> - <h1>exitDungeon<a href="../namespaces/default.html#function_exitDungeon">¶</a></h1> - <p class="short_description">Marks the dungeon as not accessible in the session.</p> + <div id="useItem" class="element ajax clickable function"> + <h1>useItem<a href="../namespaces/default.html#function_useItem">¶</a></h1> + <p class="short_description">Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_exitDungeon" class="more">« More »</a> + <a href="../namespaces/default.html#function_useItem" class="more">« More »</a> </div> </div> @@ -584,7 +655,7 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.account.inc.html">account.inc</a> + <span class="divider">\</span><a href="../packages/inc.mine.inc.html">mine.inc</a> </li> </ul> @@ -592,18 +663,25 @@ sudo chmod g+w data/save <div class="package-indent"> <h3><i class="icon-custom icon-function"></i> Functions</h3> - <div id="debitAccount" class="element ajax clickable function"> - <h1>debitAccount<a href="../namespaces/default.html#function_debitAccount">¶</a></h1> - <p class="short_description">Debits the account of a certain amount of gold.</p> + <div id="initCraftMine" class="element ajax clickable function"> + <h1>initCraftMine<a href="../namespaces/default.html#function_initCraftMine">¶</a></h1> + <p class="short_description">Initializes the gold amount and miners count in the session.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_debitAccount" class="more">« More »</a> + <a href="../namespaces/default.html#function_initCraftMine" class="more">« More »</a> </div> - <div id="creditAccount" class="element ajax clickable function"> - <h1>creditAccount<a href="../namespaces/default.html#function_creditAccount">¶</a></h1> - <p class="short_description">Credits the account of a certain amount of gold.</p> + <div id="withdrawMine" class="element ajax clickable function"> + <h1>withdrawMine<a href="../namespaces/default.html#function_withdrawMine">¶</a></h1> + <p class="short_description">Transfers all gold from the mine to the player's account.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_creditAccount" class="more">« More »</a> + <a href="../namespaces/default.html#function_withdrawMine" class="more">« More »</a> + </div> + + <div id="sendMine" class="element ajax clickable function"> + <h1>sendMine<a href="../namespaces/default.html#function_sendMine">¶</a></h1> + <p class="short_description">Returns the amount of gold currently owned by the player.</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_sendMine" class="more">« More »</a> </div> </div> @@ -623,7 +701,7 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.shop.inc.html">shop.inc</a> + <span class="divider">\</span><a href="../packages/inc.craftmine.inc.html">craftmine.inc</a> </li> </ul> @@ -631,53 +709,50 @@ sudo chmod g+w data/save <div class="package-indent"> <h3><i class="icon-custom icon-function"></i> Functions</h3> - <div id="loadShop" class="element ajax clickable function"> - <h1>loadShop<a href="../namespaces/default.html#function_loadShop">¶</a></h1> - <p class="short_description">Loads all the shop's items from the XML file data/items.xml.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#function_loadShop" class="more">« More »</a> - </div> - - <div id="getItem" class="element ajax clickable function"> - <h1>getItem<a href="../namespaces/default.html#function_getItem">¶</a></h1> - <p class="short_description">Gets an Item object from the shop from its name.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#function_getItem" class="more">« More »</a> + <div id="sendCraftMine" class="element ajax clickable function"> + <h1>sendCraftMine<a href="../namespaces/default.html#function_sendCraftMine">¶</a></h1> + <p class="short_description">Sends all data from previous session on page load.</p> + <div class="details collapse">All data from the different modules are packed in an array.</div> + <a href="../namespaces/default.html#function_sendCraftMine" class="more">« More »</a> </div> - <div id="initShop" class="element ajax clickable function"> - <h1>initShop<a href="../namespaces/default.html#function_initShop">¶</a></h1> - <p class="short_description">Marks the shop as created in the session.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#function_initShop" class="more">« More »</a> - </div> + </div> + + + + + + <ul class="breadcrumb"> + <li><a href="../index.html"><i class="icon-th"></i></a></li> + + + + <li> + <span class="divider">\</span><a href="../packages/inc.html">inc</a> + </li> - <div id="sendShop" class="element ajax clickable function"> - <h1>sendShop<a href="../namespaces/default.html#function_sendShop">¶</a></h1> - <p class="short_description">Returns the shop array if it was created.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#function_sendShop" class="more">« More »</a> - </div> + + <li> + <span class="divider">\</span><a href="../packages/inc.account.inc.html">account.inc</a> + </li> - <div id="buildShop" class="element ajax clickable function"> - <h1>buildShop<a href="../namespaces/default.html#function_buildShop">¶</a></h1> - <p class="short_description">Creates the shop in the session and sends it to the client.</p> - <div class="details collapse">Debits the shop's cost from the player's gold.</div> - <a href="../namespaces/default.html#function_buildShop" class="more">« More »</a> - </div> + </ul> - <div id="buyItem" class="element ajax clickable function"> - <h1>buyItem<a href="../namespaces/default.html#function_buyItem">¶</a></h1> - <p class="short_description">Debits the item's cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.</p> + + <div class="package-indent"> + <h3><i class="icon-custom icon-function"></i> Functions</h3> + <div id="debitAccount" class="element ajax clickable function"> + <h1>debitAccount<a href="../namespaces/default.html#function_debitAccount">¶</a></h1> + <p class="short_description">Debits the account of a certain amount of gold.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_buyItem" class="more">« More »</a> + <a href="../namespaces/default.html#function_debitAccount" class="more">« More »</a> </div> - <div id="useItem" class="element ajax clickable function"> - <h1>useItem<a href="../namespaces/default.html#function_useItem">¶</a></h1> - <p class="short_description">Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.</p> + <div id="creditAccount" class="element ajax clickable function"> + <h1>creditAccount<a href="../namespaces/default.html#function_creditAccount">¶</a></h1> + <p class="short_description">Credits the account of a certain amount of gold.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_useItem" class="more">« More »</a> + <a href="../namespaces/default.html#function_creditAccount" class="more">« More »</a> </div> </div> @@ -784,101 +859,26 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.guild.inc.html">guild.inc</a> + <span class="divider">\</span><a href="../packages/inc.Monster.inc.html">Monster.inc</a> </li> </ul> - <div class="package-indent"> - <h3><i class="icon-custom icon-function"></i> Functions</h3> - <div id="createGuild" class="element ajax clickable function"> - <h1>createGuild<a href="../namespaces/default.html#function_createGuild">¶</a></h1> - <p class="short_description">Create the miners guild in the session.</p> - <div class="details collapse">Debits GUILD_COST from the player's gold.</div> - <a href="../namespaces/default.html#function_createGuild" class="more">« More »</a> - </div> - - <div id="hireMiner" class="element ajax clickable function"> - <h1>hireMiner<a href="../namespaces/default.html#function_hireMiner">¶</a></h1> - <p class="short_description">Hire one miner.</p> - <div class="details collapse">Debits MINER_COST from the player's gold.</div> - <a href="../namespaces/default.html#function_hireMiner" class="more">« More »</a> - </div> - - <div id="sendMiners" class="element ajax clickable function"> - <h1>sendMiners<a href="../namespaces/default.html#function_sendMiners">¶</a></h1> - <p class="short_description">Returns the number of miners currently in the guild.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#function_sendMiners" class="more">« More »</a> - </div> - - </div> - <div class="package-indent"> - <h3><i class="icon-custom icon-constant"></i> Constants</h3> - <div id="GUILD_COST" class="element ajax clickable constant"> - <h1>GUILD_COST<a href="../namespaces/default.html#constant_GUILD_COST">¶</a></h1> - <p class="short_description">Amount of gold required to build the miners guild.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#constant_GUILD_COST" class="more">« More »</a> - </div> - - <div id="MINER_COST" class="element ajax clickable constant"> - <h1>MINER_COST<a href="../namespaces/default.html#constant_MINER_COST">¶</a></h1> - <p class="short_description">Amount of gold required to hire a miner.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#constant_MINER_COST" class="more">« More »</a> - </div> - - </div> - - + <div class="package-indent"> + <h3><i class="icon-custom icon-class"></i> Classes, interfaces and traits</h3> - <ul class="breadcrumb"> - <li><a href="../index.html"><i class="icon-th"></i></a></li> - - - <li> - <span class="divider">\</span><a href="../packages/inc.html">inc</a> - </li> - - - <li> - <span class="divider">\</span><a href="../packages/inc.mine.inc.html">mine.inc</a> - </li> - - </ul> - - - <div class="package-indent"> - <h3><i class="icon-custom icon-function"></i> Functions</h3> - <div id="initCraftMine" class="element ajax clickable function"> - <h1>initCraftMine<a href="../namespaces/default.html#function_initCraftMine">¶</a></h1> - <p class="short_description">Initializes the gold amount and miners count in the session.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#function_initCraftMine" class="more">« More »</a> - </div> - - <div id="withdrawMine" class="element ajax clickable function"> - <h1>withdrawMine<a href="../namespaces/default.html#function_withdrawMine">¶</a></h1> - <p class="short_description">Transfers all gold from the mine to the player's account.</p> - <div class="details collapse"></div> - <a href="../namespaces/default.html#function_withdrawMine" class="more">« More »</a> - </div> - - <div id="sendMine" class="element ajax clickable function"> - <h1>sendMine<a href="../namespaces/default.html#function_sendMine">¶</a></h1> - <p class="short_description">Returns the amount of gold currently owned by the player.</p> + <div id="Monster" class="element ajax clickable class"> + <h1>Monster<a href="../classes/Monster.html">¶</a></h1> + <p class="short_description">Represent an Item in the shop or in the Inventory.</p> <div class="details collapse"></div> - <a href="../namespaces/default.html#function_sendMine" class="more">« More »</a> + <a href="../classes/Monster.html" class="more">« More »</a> </div> </div> - - @@ -890,7 +890,7 @@ sudo chmod g+w data/save Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br/> Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/> - generated on Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> |