diff options
| author | piernov <piernov@piernov.org> | 2016-05-10 23:12:04 +0200 |
|---|---|---|
| committer | piernov <piernov@piernov.org> | 2016-05-10 23:12:04 +0200 |
| commit | 4a77dbec06bf7812fa6326cb103dce52144e49c3 (patch) | |
| tree | eda1f82d99b2600fdcbd3772ab327cee12296910 | |
| parent | 4b04ed3abe48a1623b84b5c84fde8ee1b141f3e3 (diff) | |
| download | candybox-4a77dbec06bf7812fa6326cb103dce52144e49c3.tar.gz candybox-4a77dbec06bf7812fa6326cb103dce52144e49c3.tar.bz2 candybox-4a77dbec06bf7812fa6326cb103dce52144e49c3.tar.xz candybox-4a77dbec06bf7812fa6326cb103dce52144e49c3.zip | |
Update phpdoc
25 files changed, 792 insertions, 504 deletions
diff --git a/doc/phpdoc/classes.svg b/doc/phpdoc/classes.svg index 7422c49..e64f82f 100644 --- a/doc/phpdoc/classes.svg +++ b/doc/phpdoc/classes.svg @@ -13,20 +13,20 @@ <path fill="none" stroke="gray" d="M20,-8C20,-8 89,-8 89,-8 95,-8 101,-14 101,-20 101,-20 101,-176 101,-176 101,-182 95,-188 89,-188 89,-188 20,-188 20,-188 14,-188 8,-182 8,-176 8,-176 8,-20 8,-20 8,-14 14,-8 20,-8"/> <text text-anchor="middle" x="54.5" y="-175.2" font-family="Times,serif" font-size="11.00" fill="gray">Global</text> </g> +<!-- \\Monster --> +<g id="node1" class="node"><title>\\Monster</title> +<polygon fill="none" stroke="black" points="86.5,-160 22.5,-160 22.5,-124 86.5,-124 86.5,-160"/> +<text text-anchor="middle" x="54.5" y="-139.2" font-family="Courier,monospace" font-size="11.00">Monster</text> +</g> <!-- \\Inventory --> -<g id="node1" class="node"><title>\\Inventory</title> -<polygon fill="none" stroke="black" points="93,-160 16,-160 16,-124 93,-124 93,-160"/> -<text text-anchor="middle" x="54.5" y="-139.2" font-family="Courier,monospace" font-size="11.00">Inventory</text> +<g id="node2" class="node"><title>\\Inventory</title> +<polygon fill="none" stroke="black" points="93,-106 16,-106 16,-70 93,-70 93,-106"/> +<text text-anchor="middle" x="54.5" y="-85.2" font-family="Courier,monospace" font-size="11.00">Inventory</text> </g> <!-- \\Item --> -<g id="node2" class="node"><title>\\Item</title> -<polygon fill="none" stroke="black" points="81.5,-106 27.5,-106 27.5,-70 81.5,-70 81.5,-106"/> -<text text-anchor="middle" x="54.5" y="-85.2" font-family="Courier,monospace" font-size="11.00">Item</text> -</g> -<!-- \\Monster --> -<g id="node3" class="node"><title>\\Monster</title> -<polygon fill="none" stroke="black" points="86.5,-52 22.5,-52 22.5,-16 86.5,-16 86.5,-52"/> -<text text-anchor="middle" x="54.5" y="-31.2" font-family="Courier,monospace" font-size="11.00">Monster</text> +<g id="node3" class="node"><title>\\Item</title> +<polygon fill="none" stroke="black" points="81.5,-52 27.5,-52 27.5,-16 81.5,-16 81.5,-52"/> +<text text-anchor="middle" x="54.5" y="-31.2" font-family="Courier,monospace" font-size="11.00">Item</text> </g> </g> </svg> diff --git a/doc/phpdoc/classes/Inventory.html b/doc/phpdoc/classes/Inventory.html index 18149d5..d8918b9 100644 --- a/doc/phpdoc/classes/Inventory.html +++ b/doc/phpdoc/classes/Inventory.html @@ -554,7 +554,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/classes/Item.html b/doc/phpdoc/classes/Item.html index eab07f2..210ae23 100644 --- a/doc/phpdoc/classes/Item.html +++ b/doc/phpdoc/classes/Item.html @@ -477,7 +477,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/classes/Monster.html b/doc/phpdoc/classes/Monster.html index 859dead..cc6417e 100644 --- a/doc/phpdoc/classes/Monster.html +++ b/doc/phpdoc/classes/Monster.html @@ -187,7 +187,7 @@ <a id="method___construct"></a> <div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse"> <h2>Monster's constructor</h2> - <pre>__construct(string $name, integer $level, integer $hp, integer $xp, string $icon) : void</pre> + <pre>__construct(string $name, integer $level, integer $hp, integer $xp, integer $power, string $icon) : void</pre> <div class="labels"> </div> @@ -217,6 +217,10 @@ <code>integer</code><p><p>Exp given by the Monster</p></p> </div> <div class="subelement argument"> + <h4>$power</h4> + <code>integer</code><p><p>Monster's power</p></p> + </div> + <div class="subelement argument"> <h4>$icon</h4> <code>string</code><p><p>Item's icon</p></p> </div> @@ -384,6 +388,31 @@ </div> </div> </div> + <a id="property_power"> </a> + <div class="element clickable property public property_power" data-toggle="collapse" data-target=".property_power .collapse"> + <h2>power</h2> + <pre>power : </pre> + <div class="labels"> + </div> + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + <h3>Type(s)</h3> + <code></code> + </div> + </div> + </div> </div> </div> <a id="\Monster"></a> @@ -404,7 +433,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/deprecated.html b/doc/phpdoc/deprecated.html index 9aaf18f..8772708 100644 --- a/doc/phpdoc/deprecated.html +++ b/doc/phpdoc/deprecated.html @@ -120,7 +120,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/errors.html b/doc/phpdoc/errors.html index 6d6d671..c382529 100644 --- a/doc/phpdoc/errors.html +++ b/doc/phpdoc/errors.html @@ -108,14 +108,15 @@ </div> </li> <li class="nav-header">Navigation</li> - <li><a href="#upload.php"><i class="icon-file"></i> upload.php</a></li> - <li><a href="#craftmine.php"><i class="icon-file"></i> craftmine.php</a></li> - <li><a href="#inc/Inventory.inc"><i class="icon-file"></i> inc/Inventory.inc</a></li> - <li><a href="#inc/shop.inc"><i class="icon-file"></i> inc/shop.inc</a></li> - <li><a href="#inc/perso.inc"><i class="icon-file"></i> inc/perso.inc</a></li> - <li><a href="#inc/Item.inc"><i class="icon-file"></i> inc/Item.inc</a></li> + <li><a href="#craftmine.php"><i class="icon-file"></i> craftmine.php</a></li> + <li><a href="#upload.php"><i class="icon-file"></i> upload.php</a></li> <li><a href="#inc/Monster.inc"><i class="icon-file"></i> inc/Monster.inc</a></li> - </ul> + <li><a href="#inc/Inventory.inc"><i class="icon-file"></i> inc/Inventory.inc</a></li> + <li><a href="#inc/shop.inc"><i class="icon-file"></i> inc/shop.inc</a></li> + <li><a href="#inc/perso.inc"><i class="icon-file"></i> inc/perso.inc</a></li> + <li><a href="#inc/Item.inc"><i class="icon-file"></i> inc/Item.inc</a></li> + <li><a href="#inc/guild.inc"><i class="icon-file"></i> inc/guild.inc</a></li> + </ul> </div> <div class="span8"> @@ -126,6 +127,32 @@ <div class="package-contents"> + <a name="craftmine.php" id="craftmine.php"></a> + <h3> + <i class="icon-file"></i> + craftmine.php + <span class="pull-right badge badge-info">1</span> + </h3> + <div> + <table class="table markers table-bordered"> + <thead> + <tr> + <th>Type</th> + <th>Line</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr class="error"> + <td>error</td> + <td>0</td> + <td>No summary was found for this file</td> + </tr> + </tbody> + </table> + </div> + </div> + <div class="package-contents"> <a name="upload.php" id="upload.php"></a> <h3> <i class="icon-file"></i> @@ -152,11 +179,11 @@ </div> </div> <div class="package-contents"> - <a name="craftmine.php" id="craftmine.php"></a> + <a name="inc/Monster.inc" id="inc/Monster.inc"></a> <h3> <i class="icon-file"></i> - craftmine.php - <span class="pull-right badge badge-info">1</span> + inc/Monster.inc + <span class="pull-right badge badge-info">2</span> </h3> <div> <table class="table markers table-bordered"> @@ -173,11 +200,20 @@ <td>0</td> <td>No summary was found for this file</td> </tr> + <tr class="error"> + <td>error</td> + <td>39</td> + <td>No summary for property $power</td> + </tr> </tbody> </table> </div> </div> <div class="package-contents"> + </div> + <div class="package-contents"> + </div> + <div class="package-contents"> <a name="inc/Inventory.inc" id="inc/Inventory.inc"></a> <h3> <i class="icon-file"></i> @@ -210,8 +246,6 @@ <div class="package-contents"> </div> <div class="package-contents"> - </div> - <div class="package-contents"> <a name="inc/shop.inc" id="inc/shop.inc"></a> <h3> <i class="icon-file"></i> @@ -238,17 +272,11 @@ </div> </div> <div class="package-contents"> - </div> - <div class="package-contents"> - </div> - <div class="package-contents"> - </div> - <div class="package-contents"> <a name="inc/perso.inc" id="inc/perso.inc"></a> <h3> <i class="icon-file"></i> inc/perso.inc - <span class="pull-right badge badge-info">1</span> + <span class="pull-right badge badge-info">4</span> </h3> <div> <table class="table markers table-bordered"> @@ -265,6 +293,21 @@ <td>27</td> <td>Argument $num is missing from the Docblock of increasePerso</td> </tr> + <tr class="error"> + <td>error</td> + <td>43</td> + <td>Argument $item is missing from the Docblock of limitUse</td> + </tr> + <tr class="error"> + <td>error</td> + <td>60</td> + <td>No summary for function \initUsedItem()</td> + </tr> + <tr class="error"> + <td>error</td> + <td>69</td> + <td>No summary for function \reusable()</td> + </tr> </tbody> </table> </div> @@ -296,10 +339,10 @@ </div> </div> <div class="package-contents"> - <a name="inc/Monster.inc" id="inc/Monster.inc"></a> + <a name="inc/guild.inc" id="inc/guild.inc"></a> <h3> <i class="icon-file"></i> - inc/Monster.inc + inc/guild.inc <span class="pull-right badge badge-info">1</span> </h3> <div> @@ -314,13 +357,15 @@ <tbody> <tr class="error"> <td>error</td> - <td>0</td> - <td>No summary was found for this file</td> + <td>19</td> + <td>No summary for function \initMinersIfNeeded()</td> </tr> </tbody> </table> </div> </div> + <div class="package-contents"> + </div> </div> </div> </div> @@ -329,7 +374,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/graph_class.html b/doc/phpdoc/graph_class.html index 068a2e8..4b4374a 100644 --- a/doc/phpdoc/graph_class.html +++ b/doc/phpdoc/graph_class.html @@ -121,7 +121,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/index.html b/doc/phpdoc/index.html index 1c76dcf..735f4d4 100644 --- a/doc/phpdoc/index.html +++ b/doc/phpdoc/index.html @@ -129,7 +129,7 @@ <li class="nav-header">Reports</li> <li> <a href="errors.html"> - <i class="icon-list-alt"></i> Errors <span class="label label-info">7</span> + <i class="icon-list-alt"></i> Errors <span class="label label-info">12</span> </a> </li> @@ -141,7 +141,7 @@ </li> <li> <a href="markers.html"> - <i class="icon-list-alt"></i> Markers <span class="label label-info">7</span> + <i class="icon-list-alt"></i> Markers <span class="label label-info">6</span> </a> </li> @@ -155,7 +155,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/markers.html b/doc/phpdoc/markers.html index 4765760..5a397b1 100644 --- a/doc/phpdoc/markers.html +++ b/doc/phpdoc/markers.html @@ -99,11 +99,10 @@ <div class="span4"> <ul class="side-nav nav nav-list"> <li class="nav-header">Navigation</li> - <li><a href="#inc/dungeon.inc"><i class="icon-file"></i> inc/dungeon.inc</a></li> - <li><a href="#inc/shop.inc"><i class="icon-file"></i> inc/shop.inc</a></li> - <li><a href="#inc/Item.inc"><i class="icon-file"></i> inc/Item.inc</a></li> - <li><a href="#inc/Monster.inc"><i class="icon-file"></i> inc/Monster.inc</a></li> - </ul> + <li><a href="#inc/Monster.inc"><i class="icon-file"></i> inc/Monster.inc</a></li> + <li><a href="#inc/dungeon.inc"><i class="icon-file"></i> inc/dungeon.inc</a></li> + <li><a href="#inc/shop.inc"><i class="icon-file"></i> inc/shop.inc</a></li> + </ul> </div> <div class="span8"> @@ -115,12 +114,12 @@ <div id="marker-accordion"> - <div class="package-contents"> - <a name="inc/dungeon.inc" id="inc/dungeon.inc"></a> + <div class="package-contents"> + <a name="inc/Monster.inc" id="inc/Monster.inc"></a> <h3> <i class="icon-file"></i> - inc/dungeon.inc - <span class="pull-right badge badge-info">3</span> + inc/Monster.inc + <span class="pull-right badge badge-info">1</span> </h3> <div> <table class="table markers table-bordered"> @@ -131,28 +130,18 @@ </tr> <tr> <td>TODO</td> - <td>21</td> - <td>again, cost is a string?</td> - </tr> - <tr> - <td>TODO</td> - <td>42</td> - <td>is the $_SESSION["dungeon"] array useful (and created beforehand)?</td> - </tr> - <tr> - <td>TODO</td> - <td>69</td> - <td>Account was already debited</td> + <td>23</td> + <td>unused</td> </tr> </table> </div> </div> - <div class="package-contents"> - <a name="inc/shop.inc" id="inc/shop.inc"></a> + <div class="package-contents"> + <a name="inc/dungeon.inc" id="inc/dungeon.inc"></a> <h3> <i class="icon-file"></i> - inc/shop.inc - <span class="pull-right badge badge-info">2</span> + inc/dungeon.inc + <span class="pull-right badge badge-info">3</span> </h3> <div> <table class="table markers table-bordered"> @@ -164,44 +153,27 @@ <tr> <td>TODO</td> <td>22</td> - <td>handle errors</td> + <td>again, cost is a string?</td> </tr> <tr> <td>TODO</td> - <td>23</td> - <td>cost is a string?</td> + <td>44</td> + <td>is the $_SESSION["dungeon"] array useful (and created beforehand)?</td> </tr> - </table> - </div> - </div> - <div class="package-contents"> - <a name="inc/Item.inc" id="inc/Item.inc"></a> - <h3> - <i class="icon-file"></i> - inc/Item.inc - <span class="pull-right badge badge-info">1</span> - </h3> - <div> - <table class="table markers table-bordered"> - <tr> - <th>Type</th> - <th>Line</th> - <th>Description</th> - </tr> <tr> <td>TODO</td> - <td>66</td> - <td>do something with power</td> + <td>71</td> + <td>Account was already debited</td> </tr> </table> </div> </div> - <div class="package-contents"> - <a name="inc/Monster.inc" id="inc/Monster.inc"></a> + <div class="package-contents"> + <a name="inc/shop.inc" id="inc/shop.inc"></a> <h3> <i class="icon-file"></i> - inc/Monster.inc - <span class="pull-right badge badge-info">1</span> + inc/shop.inc + <span class="pull-right badge badge-info">2</span> </h3> <div> <table class="table markers table-bordered"> @@ -212,13 +184,18 @@ </tr> <tr> <td>TODO</td> + <td>22</td> + <td>handle errors</td> + </tr> + <tr> + <td>TODO</td> <td>23</td> - <td>unused</td> + <td>cost is a string?</td> </tr> </table> </div> </div> - </div> + </div> </div> </div> </div> @@ -227,7 +204,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/namespaces/default.html b/doc/phpdoc/namespaces/default.html index 87e1895..4e502d4 100644 --- a/doc/phpdoc/namespaces/default.html +++ b/doc/phpdoc/namespaces/default.html @@ -700,8 +700,42 @@ </div> <a href="../namespaces/default.html#function_increasePerso" class="more">« More »</a> </div> - <div id="function_initCraftMine" class="element ajax clickable function" data-toggle="collapse" data-target="#function_initCraftMine .collapse"> - <h1>initCraftMine<a href="../namespaces/default.html#function_initCraftMine">¶</a></h1> + <div id="function_initDungeon" class="element ajax clickable function" data-toggle="collapse" data-target="#function_initDungeon .collapse"> + <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 class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + package + </th> + <td> + + <p>inc\dungeon.inc</p> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + + </div> + </div> + </div> + <a href="../namespaces/default.html#function_initDungeon" class="more">« More »</a> </div> + + <div id="function_initMineIfNeeded" class="element ajax clickable function" data-toggle="collapse" data-target="#function_initMineIfNeeded .collapse"> + <h1>initMineIfNeeded<a href="../namespaces/default.html#function_initMineIfNeeded">¶</a></h1> <p class="short_description">Initializes the gold amount and miners count in the session.</p> <div class="details collapse"> @@ -732,11 +766,11 @@ </div> </div> </div> - <a href="../namespaces/default.html#function_initCraftMine" class="more">« More »</a> </div> + <a href="../namespaces/default.html#function_initMineIfNeeded" class="more">« More »</a> </div> - <div id="function_initDungeon" class="element ajax clickable function" data-toggle="collapse" data-target="#function_initDungeon .collapse"> - <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="function_initMinersIfNeeded" class="element ajax clickable function" data-toggle="collapse" data-target="#function_initMinersIfNeeded .collapse"> + <h1>initMinersIfNeeded<a href="../namespaces/default.html#function_initMinersIfNeeded">¶</a></h1> + <p class="short_description"></p> <div class="details collapse"> <div class="row collapse"> @@ -750,7 +784,7 @@ </th> <td> - <p>inc\dungeon.inc</p> + <p>inc\guild.inc</p> </td> </tr> <tr> @@ -766,7 +800,7 @@ </div> </div> </div> - <a href="../namespaces/default.html#function_initDungeon" class="more">« More »</a> </div> + <a href="../namespaces/default.html#function_initMinersIfNeeded" class="more">« More »</a> </div> <div id="function_initPerso" class="element ajax clickable function" data-toggle="collapse" data-target="#function_initPerso .collapse"> <h1>initPerso<a href="../namespaces/default.html#function_initPerso">¶</a></h1> @@ -836,6 +870,40 @@ </div> <a href="../namespaces/default.html#function_initShop" class="more">« More »</a> </div> + <div id="function_initUsedItem" class="element ajax clickable function" data-toggle="collapse" data-target="#function_initUsedItem .collapse"> + <h1>initUsedItem<a href="../namespaces/default.html#function_initUsedItem">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"> + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + package + </th> + <td> + + <p>inc\perso.inc</p> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + + </div> + </div> + </div> + <a href="../namespaces/default.html#function_initUsedItem" class="more">« More »</a> </div> + <div id="function_launchDungeon" class="element ajax clickable function" data-toggle="collapse" data-target="#function_launchDungeon .collapse"> <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> @@ -870,6 +938,48 @@ </div> <a href="../namespaces/default.html#function_launchDungeon" class="more">« More »</a> </div> + <div id="function_limitUse" class="element ajax clickable function" data-toggle="collapse" data-target="#function_limitUse .collapse"> + <h1>limitUse<a href="../namespaces/default.html#function_limitUse">¶</a></h1> + <p class="short_description">traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1</p> + <div class="details collapse"> + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + package + </th> + <td> + + <p>inc\perso.inc</p> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + <h3>Arguments</h3> + <div class="subelement argument"> + <h4>$item</h4> + <code></code><p></p> + </div> + + </div> + </div> + </div> + <a href="../namespaces/default.html#function_limitUse" class="more">« More »</a> </div> + <div id="function_listSaves" class="element ajax clickable function" data-toggle="collapse" data-target="#function_listSaves .collapse"> <h1>listSaves<a href="../namespaces/default.html#function_listSaves">¶</a></h1> <p class="short_description">Sends the list of available saves to the client.</p> @@ -1044,6 +1154,40 @@ </div> <a href="../namespaces/default.html#function_reportBadRequest" class="more">« More »</a> </div> + <div id="function_reusable" class="element ajax clickable function" data-toggle="collapse" data-target="#function_reusable .collapse"> + <h1>reusable<a href="../namespaces/default.html#function_reusable">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"> + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + package + </th> + <td> + + <p>inc\perso.inc</p> + </td> + </tr> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + + </div> + </div> + </div> + <a href="../namespaces/default.html#function_reusable" class="more">« More »</a> </div> + <div id="function_saveGame" class="element ajax clickable function" data-toggle="collapse" data-target="#function_saveGame .collapse"> <h1>saveGame<a href="../namespaces/default.html#function_saveGame">¶</a></h1> <p class="short_description">Save the XML save tree as an XML file named after the results of genFilename in SAVEDIR.</p> @@ -1580,6 +1724,19 @@ XML errors are simply ignored and an error is sent to the client if something wr <div class="namespace-indent"> <h3><i class="icon-custom icon-constant"></i> Constants</h3> + <div id="constant_SAVEDIR" class="element ajax clickable constant" data-toggle="collapse" data-target="#constant_SAVEDIR .collapse"> + <h1>SAVEDIR<a href="../namespaces/default.html#constant_SAVEDIR">¶</a></h1> + <p class="short_description">Directory to save to and load from.</p> + <div class="details collapse"> + <p>The PHP/Apache user must have write permission on this directory. +Use the following commands to give write permissions to the http group:</p> +<samp> +sudo chown :http data/save +sudo chmod g+w data/save +</samp> + </div> + <a href="../namespaces/default.html#constant_SAVEDIR" class="more">« More »</a> </div> + <div id="constant_GUILD_COST" class="element ajax clickable constant" data-toggle="collapse" data-target="#constant_GUILD_COST .collapse"> <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> @@ -1596,19 +1753,6 @@ XML errors are simply ignored and an error is sent to the client if something wr </div> <a href="../namespaces/default.html#constant_MINER_COST" class="more">« More »</a> </div> - <div id="constant_SAVEDIR" class="element ajax clickable constant" data-toggle="collapse" data-target="#constant_SAVEDIR .collapse"> - <h1>SAVEDIR<a href="../namespaces/default.html#constant_SAVEDIR">¶</a></h1> - <p class="short_description">Directory to save to and load from.</p> - <div class="details collapse"> - <p>The PHP/Apache user must have write permission on this directory. -Use the following commands to give write permissions to the http group:</p> -<samp> -sudo chown :http data/save -sudo chmod g+w data/save -</samp> - </div> - <a href="../namespaces/default.html#constant_SAVEDIR" class="more">« More »</a> </div> - </div> <div class="namespace-indent"> @@ -1650,7 +1794,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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/Default.html b/doc/phpdoc/packages/Default.html index 0caa25c..dd17cc6 100644 --- a/doc/phpdoc/packages/Default.html +++ b/doc/phpdoc/packages/Default.html @@ -154,7 +154,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/default.html b/doc/phpdoc/packages/default.html index 5b519ce..f49f437 100644 --- a/doc/phpdoc/packages/default.html +++ b/doc/phpdoc/packages/default.html @@ -308,7 +308,7 @@ <li> - <span class="divider">\</span><a href="../packages/inc.Inventory.inc.html">Inventory.inc</a> + <span class="divider">\</span><a href="../packages/inc.Monster.inc.html">Monster.inc</a> </li> </ul> @@ -320,11 +320,11 @@ <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> + <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> </div> @@ -342,7 +342,7 @@ <li> - <span class="divider">\</span><a href="../packages/inc.dungeon.inc.html">dungeon.inc</a> + <span class="divider">\</span><a href="../packages/inc.craftmine.inc.html">craftmine.inc</a> </li> </ul> @@ -350,53 +350,11 @@ <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 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 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> @@ -462,55 +420,26 @@ <li> - <span class="divider">\</span><a href="../packages/inc.guild.inc.html">guild.inc</a> + <span class="divider">\</span><a href="../packages/inc.Inventory.inc.html">Inventory.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> + <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> </div> </div> - @@ -637,7 +566,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.dungeon.inc.html">dungeon.inc</a> </li> </ul> @@ -645,53 +574,53 @@ 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 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_loadShop" class="more">« More »</a> + <a href="../namespaces/default.html#function_generateMonster" 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 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_getItem" class="more">« More »</a> + <a href="../namespaces/default.html#function_initDungeon" 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 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_initShop" class="more">« More »</a> + <a href="../namespaces/default.html#function_sendDungeon" class="more">« More »</a> </div> - <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 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="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 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="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 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_buyItem" class="more">« More »</a> + <a href="../namespaces/default.html#function_sendDungeonProgress" 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="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_useItem" class="more">« More »</a> + <a href="../namespaces/default.html#function_exitDungeon" class="more">« More »</a> </div> </div> @@ -711,7 +640,7 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.mine.inc.html">mine.inc</a> + <span class="divider">\</span><a href="../packages/inc.account.inc.html">account.inc</a> </li> </ul> @@ -719,25 +648,18 @@ sudo chmod g+w data/save <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 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_withdrawMine" class="more">« More »</a> + <a href="../namespaces/default.html#function_debitAccount" 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="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_sendMine" class="more">« More »</a> + <a href="../namespaces/default.html#function_creditAccount" class="more">« More »</a> </div> </div> @@ -757,7 +679,7 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.craftmine.inc.html">craftmine.inc</a> + <span class="divider">\</span><a href="../packages/inc.shop.inc.html">shop.inc</a> </li> </ul> @@ -765,50 +687,53 @@ sudo chmod g+w data/save <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="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> - - - - - - <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="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> - - <li> - <span class="divider">\</span><a href="../packages/inc.account.inc.html">account.inc</a> - </li> + <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> - </ul> + <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 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="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="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_debitAccount" class="more">« More »</a> + <a href="../namespaces/default.html#function_buyItem" 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="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_creditAccount" class="more">« More »</a> + <a href="../namespaces/default.html#function_useItem" class="more">« More »</a> </div> </div> @@ -850,6 +775,30 @@ sudo chmod g+w data/save <a href="../namespaces/default.html#function_increasePerso" class="more">« More »</a> </div> + <div id="limitUse" class="element ajax clickable function"> + <h1>limitUse<a href="../namespaces/default.html#function_limitUse">¶</a></h1> + <p class="short_description">traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_limitUse" class="more">« More »</a> + </div> + + <div id="initUsedItem" class="element ajax clickable function"> + <h1>initUsedItem<a href="../namespaces/default.html#function_initUsedItem">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_initUsedItem" class="more">« More »</a> + </div> + + <div id="reusable" class="element ajax clickable function"> + <h1>reusable<a href="../namespaces/default.html#function_reusable">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_reusable" class="more">« More »</a> + </div> + <div id="updatePerso" class="element ajax clickable function"> <h1>updatePerso<a href="../namespaces/default.html#function_updatePerso">¶</a></h1> <p class="short_description">Copies stats given in POST request to session.</p> @@ -915,26 +864,108 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.Monster.inc.html">Monster.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="initMinersIfNeeded" class="element ajax clickable function"> + <h1>initMinersIfNeeded<a href="../namespaces/default.html#function_initMinersIfNeeded">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_initMinersIfNeeded" class="more">« More »</a> + </div> + + <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> + <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> + + + + <ul class="breadcrumb"> + <li><a href="../index.html"><i class="icon-th"></i></a></li> + - <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> + + <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="initMineIfNeeded" class="element ajax clickable function"> + <h1>initMineIfNeeded<a href="../namespaces/default.html#function_initMineIfNeeded">¶</a></h1> + <p class="short_description">Initializes the gold amount and miners count in the session.</p> <div class="details collapse"></div> - <a href="../classes/Monster.html" class="more">« More »</a> + <a href="../namespaces/default.html#function_initMineIfNeeded" 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 class="details collapse"></div> + <a href="../namespaces/default.html#function_sendMine" class="more">« More »</a> </div> </div> + + @@ -947,7 +978,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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.Inventory.inc.html b/doc/phpdoc/packages/inc.Inventory.inc.html index 4cc9b21..3d981d1 100644 --- a/doc/phpdoc/packages/inc.Inventory.inc.html +++ b/doc/phpdoc/packages/inc.Inventory.inc.html @@ -162,7 +162,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.Item.inc.html b/doc/phpdoc/packages/inc.Item.inc.html index bea2d41..e77eca2 100644 --- a/doc/phpdoc/packages/inc.Item.inc.html +++ b/doc/phpdoc/packages/inc.Item.inc.html @@ -162,7 +162,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.Monster.inc.html b/doc/phpdoc/packages/inc.Monster.inc.html index 234a20d..9253f84 100644 --- a/doc/phpdoc/packages/inc.Monster.inc.html +++ b/doc/phpdoc/packages/inc.Monster.inc.html @@ -162,7 +162,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.account.inc.html b/doc/phpdoc/packages/inc.account.inc.html index b77b8f4..ebe8672 100644 --- a/doc/phpdoc/packages/inc.account.inc.html +++ b/doc/phpdoc/packages/inc.account.inc.html @@ -167,7 +167,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.craftmine.inc.html b/doc/phpdoc/packages/inc.craftmine.inc.html index 3d98bbd..7d7ee1c 100644 --- a/doc/phpdoc/packages/inc.craftmine.inc.html +++ b/doc/phpdoc/packages/inc.craftmine.inc.html @@ -160,7 +160,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.dungeon.inc.html b/doc/phpdoc/packages/inc.dungeon.inc.html index a6c2668..de7994a 100644 --- a/doc/phpdoc/packages/inc.dungeon.inc.html +++ b/doc/phpdoc/packages/inc.dungeon.inc.html @@ -202,7 +202,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.guild.inc.html b/doc/phpdoc/packages/inc.guild.inc.html index ed8ab9b..d61d019 100644 --- a/doc/phpdoc/packages/inc.guild.inc.html +++ b/doc/phpdoc/packages/inc.guild.inc.html @@ -140,6 +140,13 @@ <div class="package-indent"> <h3><i class="icon-custom icon-function"></i> Functions</h3> + <div id="initMinersIfNeeded" class="element ajax clickable function"> + <h1>initMinersIfNeeded<a href="../namespaces/default.html#function_initMinersIfNeeded">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_initMinersIfNeeded" class="more">« More »</a> + </div> + <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> @@ -191,7 +198,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.html b/doc/phpdoc/packages/inc.html index b1e32db..ad993d1 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.Inventory.inc.html">Inventory.inc</a> + <span class="divider">\</span><a href="../packages/inc.Monster.inc.html">Monster.inc</a> </li> </ul> @@ -264,11 +264,11 @@ <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> + <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> </div> @@ -286,7 +286,7 @@ <li> - <span class="divider">\</span><a href="../packages/inc.dungeon.inc.html">dungeon.inc</a> + <span class="divider">\</span><a href="../packages/inc.craftmine.inc.html">craftmine.inc</a> </li> </ul> @@ -294,53 +294,11 @@ <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 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 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> @@ -406,55 +364,26 @@ <li> - <span class="divider">\</span><a href="../packages/inc.guild.inc.html">guild.inc</a> + <span class="divider">\</span><a href="../packages/inc.Inventory.inc.html">Inventory.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> + <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> </div> </div> - @@ -581,7 +510,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.dungeon.inc.html">dungeon.inc</a> </li> </ul> @@ -589,53 +518,53 @@ 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 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_loadShop" class="more">« More »</a> + <a href="../namespaces/default.html#function_generateMonster" 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 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_getItem" class="more">« More »</a> + <a href="../namespaces/default.html#function_initDungeon" 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 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_initShop" class="more">« More »</a> + <a href="../namespaces/default.html#function_sendDungeon" class="more">« More »</a> </div> - <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 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="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 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="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 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_buyItem" class="more">« More »</a> + <a href="../namespaces/default.html#function_sendDungeonProgress" 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="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_useItem" class="more">« More »</a> + <a href="../namespaces/default.html#function_exitDungeon" class="more">« More »</a> </div> </div> @@ -655,7 +584,7 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.mine.inc.html">mine.inc</a> + <span class="divider">\</span><a href="../packages/inc.account.inc.html">account.inc</a> </li> </ul> @@ -663,25 +592,18 @@ sudo chmod g+w data/save <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 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_withdrawMine" class="more">« More »</a> + <a href="../namespaces/default.html#function_debitAccount" 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="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_sendMine" class="more">« More »</a> + <a href="../namespaces/default.html#function_creditAccount" class="more">« More »</a> </div> </div> @@ -701,7 +623,7 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.craftmine.inc.html">craftmine.inc</a> + <span class="divider">\</span><a href="../packages/inc.shop.inc.html">shop.inc</a> </li> </ul> @@ -709,50 +631,53 @@ sudo chmod g+w data/save <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="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> - - - - - - <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="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> - - <li> - <span class="divider">\</span><a href="../packages/inc.account.inc.html">account.inc</a> - </li> + <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> - </ul> + <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 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="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="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_debitAccount" class="more">« More »</a> + <a href="../namespaces/default.html#function_buyItem" 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="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_creditAccount" class="more">« More »</a> + <a href="../namespaces/default.html#function_useItem" class="more">« More »</a> </div> </div> @@ -794,6 +719,30 @@ sudo chmod g+w data/save <a href="../namespaces/default.html#function_increasePerso" class="more">« More »</a> </div> + <div id="limitUse" class="element ajax clickable function"> + <h1>limitUse<a href="../namespaces/default.html#function_limitUse">¶</a></h1> + <p class="short_description">traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_limitUse" class="more">« More »</a> + </div> + + <div id="initUsedItem" class="element ajax clickable function"> + <h1>initUsedItem<a href="../namespaces/default.html#function_initUsedItem">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_initUsedItem" class="more">« More »</a> + </div> + + <div id="reusable" class="element ajax clickable function"> + <h1>reusable<a href="../namespaces/default.html#function_reusable">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_reusable" class="more">« More »</a> + </div> + <div id="updatePerso" class="element ajax clickable function"> <h1>updatePerso<a href="../namespaces/default.html#function_updatePerso">¶</a></h1> <p class="short_description">Copies stats given in POST request to session.</p> @@ -859,26 +808,108 @@ sudo chmod g+w data/save <li> - <span class="divider">\</span><a href="../packages/inc.Monster.inc.html">Monster.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="initMinersIfNeeded" class="element ajax clickable function"> + <h1>initMinersIfNeeded<a href="../namespaces/default.html#function_initMinersIfNeeded">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_initMinersIfNeeded" class="more">« More »</a> + </div> + + <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> + <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> + + + + <ul class="breadcrumb"> + <li><a href="../index.html"><i class="icon-th"></i></a></li> + - <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> + + <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="initMineIfNeeded" class="element ajax clickable function"> + <h1>initMineIfNeeded<a href="../namespaces/default.html#function_initMineIfNeeded">¶</a></h1> + <p class="short_description">Initializes the gold amount and miners count in the session.</p> <div class="details collapse"></div> - <a href="../classes/Monster.html" class="more">« More »</a> + <a href="../namespaces/default.html#function_initMineIfNeeded" 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 class="details collapse"></div> + <a href="../namespaces/default.html#function_sendMine" class="more">« More »</a> </div> </div> + + @@ -890,7 +921,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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.messages.inc.html b/doc/phpdoc/packages/inc.messages.inc.html index 23ce6ad..9c8e376 100644 --- a/doc/phpdoc/packages/inc.messages.inc.html +++ b/doc/phpdoc/packages/inc.messages.inc.html @@ -174,7 +174,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.mine.inc.html b/doc/phpdoc/packages/inc.mine.inc.html index 734a429..a650551 100644 --- a/doc/phpdoc/packages/inc.mine.inc.html +++ b/doc/phpdoc/packages/inc.mine.inc.html @@ -140,11 +140,11 @@ <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> + <div id="initMineIfNeeded" class="element ajax clickable function"> + <h1>initMineIfNeeded<a href="../namespaces/default.html#function_initMineIfNeeded">¶</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> + <a href="../namespaces/default.html#function_initMineIfNeeded" class="more">« More »</a> </div> <div id="withdrawMine" class="element ajax clickable function"> @@ -174,7 +174,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.perso.inc.html b/doc/phpdoc/packages/inc.perso.inc.html index 8c471aa..a06aac3 100644 --- a/doc/phpdoc/packages/inc.perso.inc.html +++ b/doc/phpdoc/packages/inc.perso.inc.html @@ -154,6 +154,30 @@ <a href="../namespaces/default.html#function_increasePerso" class="more">« More »</a> </div> + <div id="limitUse" class="element ajax clickable function"> + <h1>limitUse<a href="../namespaces/default.html#function_limitUse">¶</a></h1> + <p class="short_description">traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1</p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_limitUse" class="more">« More »</a> + </div> + + <div id="initUsedItem" class="element ajax clickable function"> + <h1>initUsedItem<a href="../namespaces/default.html#function_initUsedItem">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_initUsedItem" class="more">« More »</a> + </div> + + <div id="reusable" class="element ajax clickable function"> + <h1>reusable<a href="../namespaces/default.html#function_reusable">¶</a></h1> + <p class="short_description"></p> + <div class="details collapse"></div> + <a href="../namespaces/default.html#function_reusable" class="more">« More »</a> + </div> + <div id="updatePerso" class="element ajax clickable function"> <h1>updatePerso<a href="../namespaces/default.html#function_updatePerso">¶</a></h1> <p class="short_description">Copies stats given in POST request to session.</p> @@ -181,7 +205,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.savegame.inc.html b/doc/phpdoc/packages/inc.savegame.inc.html index 2ec1e2d..80fb2f5 100644 --- a/doc/phpdoc/packages/inc.savegame.inc.html +++ b/doc/phpdoc/packages/inc.savegame.inc.html @@ -240,7 +240,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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.shop.inc.html b/doc/phpdoc/packages/inc.shop.inc.html index 6908e0f..70efa52 100644 --- a/doc/phpdoc/packages/inc.shop.inc.html +++ b/doc/phpdoc/packages/inc.shop.inc.html @@ -202,7 +202,7 @@ 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 Mon, 09 May 2016 14:01:23 +0200.<br/> + generated on Tue, 10 May 2016 23:11:53 +0200.<br/> </footer> </body> </html> |
