diff options
| author | piernov <piernov@piernov.org> | 2016-05-09 14:05:50 +0200 |
|---|---|---|
| committer | piernov <piernov@piernov.org> | 2016-05-09 14:05:50 +0200 |
| commit | 1e52affe15fb13e920f8942de998073238be6d01 (patch) | |
| tree | b0737eb2c9f26be6700f99d00d003e4cf6b05d7b | |
| parent | 9f28616dfd1cc425c5013937bab729217b7be2e6 (diff) | |
| download | candybox-1e52affe15fb13e920f8942de998073238be6d01.tar.gz candybox-1e52affe15fb13e920f8942de998073238be6d01.tar.bz2 candybox-1e52affe15fb13e920f8942de998073238be6d01.tar.xz candybox-1e52affe15fb13e920f8942de998073238be6d01.zip | |
Finish Inventory PHPDocphpdoc
26 files changed, 545 insertions, 630 deletions
diff --git a/doc/phpdoc/classes.svg b/doc/phpdoc/classes.svg index e64f82f..7422c49 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="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 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> <!-- \\Item --> -<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 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> </g> </svg> diff --git a/doc/phpdoc/classes/Inventory.html b/doc/phpdoc/classes/Inventory.html index 48730e5..18149d5 100644 --- a/doc/phpdoc/classes/Inventory.html +++ b/doc/phpdoc/classes/Inventory.html @@ -124,8 +124,8 @@ </li> <li class="method public"> - <a href="#method_addToXML" title="addToXML :: "> - <span class="description"></span><pre>addToXML</pre> + <a href="#method_addToXML" title="addToXML :: Generates an XML tree describing the Inventory"> + <span class="description">Generates an XML tree describing the Inventory</span><pre>addToXML</pre> </a> </li> @@ -142,8 +142,8 @@ </li> <li class="method public"> - <a href="#method_removeItem" title="removeItem :: "> - <span class="description"></span><pre>removeItem</pre> + <a href="#method_removeItem" title="removeItem :: Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count."> + <span class="description">Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count.</span><pre>removeItem</pre> </a> </li> @@ -154,8 +154,8 @@ </li> <li class="method public"> - <a href="#method_useItem" title="useItem :: "> - <span class="description"></span><pre>useItem</pre> + <a href="#method_useItem" title="useItem :: Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0."> + <span class="description">Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0.</span><pre>useItem</pre> </a> </li> @@ -173,13 +173,13 @@ </a> </li> <li class="method private"> - <a href="#method__removeItem" title="_removeItem :: "> - <span class="description"></span><pre>_removeItem</pre> + <a href="#method__removeItem" title="_removeItem :: Removes an Item object from the Inventory, not taking into account the Item's count."> + <span class="description">Removes an Item object from the Inventory, not taking into account the Item's count.</span><pre>_removeItem</pre> </a> </li> <li class="method private"> - <a href="#method__useItem" title="_useItem :: "> - <span class="description"></span><pre>_useItem</pre> + <a href="#method__useItem" title="_useItem :: Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0."> + <span class="description">Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0.</span><pre>_useItem</pre> </a> </li> </ul> @@ -264,8 +264,8 @@ </div> <a id="method__removeItem"></a> <div class="element clickable method private method__removeItem" data-toggle="collapse" data-target=".method__removeItem .collapse"> - <h2>_removeItem</h2> - <pre>_removeItem( $item) </pre> + <h2>Removes an Item object from the Inventory, not taking into account the Item's count.</h2> + <pre>_removeItem(\Item $item) : void</pre> <div class="labels"> </div> @@ -275,26 +275,12 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$item</h4> - <code></code><p></p> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to remove from the Inventory</p></p> </div> </div> @@ -303,8 +289,8 @@ </div> <a id="method__useItem"></a> <div class="element clickable method private method__useItem" data-toggle="collapse" data-target=".method__useItem .collapse"> - <h2>_useItem</h2> - <pre>_useItem( $item) </pre> + <h2>Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0.</h2> + <pre>_useItem(\Item $item) : array|false</pre> <div class="labels"> </div> @@ -314,28 +300,16 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$item</h4> - <code></code><p></p> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to consume from the Inventory</p></p> </div> + <h3>Response</h3> + <code>array|false</code><p><p>Item and updated Item's count, false if it was not found</p></p> </div> </div> @@ -369,8 +343,8 @@ </div> <a id="method_addToXML"></a> <div class="element clickable method public method_addToXML" data-toggle="collapse" data-target=".method_addToXML .collapse"> - <h2>addToXML</h2> - <pre>addToXML( $root) </pre> + <h2>Generates an XML tree describing the Inventory</h2> + <pre>addToXML(\SimpleXMLElement $root) : void</pre> <div class="labels"> </div> @@ -380,26 +354,12 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$root</h4> - <code></code><p></p> + <code>\SimpleXMLElement</code><p><p>root XML element to add the Inventory's Items to</p></p> </div> </div> @@ -466,8 +426,8 @@ </div> <a id="method_removeItem"></a> <div class="element clickable method public method_removeItem" data-toggle="collapse" data-target=".method_removeItem .collapse"> - <h2>removeItem</h2> - <pre>removeItem( $item) </pre> + <h2>Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count.</h2> + <pre>removeItem(\Item $item) : void</pre> <div class="labels"> <span class="label">static</span> </div> @@ -477,26 +437,12 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$item</h4> - <code></code><p></p> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to remove from the Inventory</p></p> </div> </div> @@ -534,8 +480,8 @@ </div> <a id="method_useItem"></a> <div class="element clickable method public method_useItem" data-toggle="collapse" data-target=".method_useItem .collapse"> - <h2>useItem</h2> - <pre>useItem( $item) </pre> + <h2>Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0.</h2> + <pre>useItem(\Item $item) : array|false</pre> <div class="labels"> <span class="label">static</span> </div> @@ -545,28 +491,16 @@ <div class="long_description"></div> <table class="table"> - <tr> - <th> - - </th> - <td> - </td> - </tr> - <tr> - <th> - - </th> - <td> - </td> - </tr> </table> <h3>Arguments</h3> <div class="subelement argument"> <h4>$item</h4> - <code></code><p></p> + <code><a href="../classes/Item.html">\Item</a></code><p><p>Item to consume from the Inventory</p></p> </div> + <h3>Response</h3> + <code>array|false</code><p><p>Item and updated Item's count, false if it was not found</p></p> </div> </div> @@ -576,8 +510,8 @@ <h3><i class="icon-custom icon-property"></i> Properties</h3> <a id="property_items"> </a> <div class="element clickable property public property_items" data-toggle="collapse" data-target=".property_items .collapse"> - <h2>Arrays of array with Item and Item's count</h2> - <pre>items : </pre> + <h2>Arrays of array with Item object and Item's count as int</h2> + <pre>items : array</pre> <div class="labels"> </div> <div class="row collapse"> @@ -587,15 +521,16 @@ <table class="table"> <tr> <th> - + var </th> <td> + <p>Arrays of array with Item object and Item's count as int</p> </td> </tr> </table> <h3>Type(s)</h3> - <code></code> + <code>array</code> </div> </div> </div> @@ -619,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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/classes/Item.html b/doc/phpdoc/classes/Item.html index 9dbd580..eab07f2 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/classes/Monster.html b/doc/phpdoc/classes/Monster.html index 5f22810..859dead 100644 --- a/doc/phpdoc/classes/Monster.html +++ b/doc/phpdoc/classes/Monster.html @@ -404,7 +404,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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/deprecated.html b/doc/phpdoc/deprecated.html index 0257223..9aaf18f 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 Sun, 08 May 2016 20:44:22 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/errors.html b/doc/phpdoc/errors.html index 2c096da..6d6d671 100644 --- a/doc/phpdoc/errors.html +++ b/doc/phpdoc/errors.html @@ -108,14 +108,14 @@ </div> </li> <li class="nav-header">Navigation</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> - <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="#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> - </ul> + <li><a href="#inc/Monster.inc"><i class="icon-file"></i> inc/Monster.inc</a></li> + </ul> </div> <div class="span8"> @@ -126,10 +126,10 @@ <div class="package-contents"> - <a name="craftmine.php" id="craftmine.php"></a> + <a name="upload.php" id="upload.php"></a> <h3> <i class="icon-file"></i> - craftmine.php + upload.php <span class="pull-right badge badge-info">1</span> </h3> <div> @@ -152,10 +152,10 @@ </div> </div> <div class="package-contents"> - <a name="upload.php" id="upload.php"></a> + <a name="craftmine.php" id="craftmine.php"></a> <h3> <i class="icon-file"></i> - upload.php + craftmine.php <span class="pull-right badge badge-info">1</span> </h3> <div> @@ -178,10 +178,10 @@ </div> </div> <div class="package-contents"> - <a name="inc/Monster.inc" id="inc/Monster.inc"></a> + <a name="inc/Inventory.inc" id="inc/Inventory.inc"></a> <h3> <i class="icon-file"></i> - inc/Monster.inc + inc/Inventory.inc <span class="pull-right badge badge-info">1</span> </h3> <div> @@ -208,11 +208,15 @@ <div class="package-contents"> </div> <div class="package-contents"> - <a name="inc/Inventory.inc" id="inc/Inventory.inc"></a> + </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> - inc/Inventory.inc - <span class="pull-right badge badge-info">11</span> + inc/shop.inc + <span class="pull-right badge badge-info">1</span> </h3> <div> <table class="table markers table-bordered"> @@ -226,58 +230,8 @@ <tbody> <tr class="error"> <td>error</td> - <td>0</td> - <td>No summary was found for this file</td> - </tr> - <tr class="error"> - <td>error</td> - <td>77</td> - <td>Argument $item is missing from the Docblock of _removeItem</td> - </tr> - <tr class="error"> - <td>error</td> - <td>77</td> - <td>No summary for method _removeItem()</td> - </tr> - <tr class="error"> - <td>error</td> - <td>86</td> - <td>Argument $item is missing from the Docblock of removeItem</td> - </tr> - <tr class="error"> - <td>error</td> - <td>86</td> - <td>No summary for method removeItem()</td> - </tr> - <tr class="error"> - <td>error</td> - <td>91</td> - <td>Argument $item is missing from the Docblock of _useItem</td> - </tr> - <tr class="error"> - <td>error</td> - <td>91</td> - <td>No summary for method _useItem()</td> - </tr> - <tr class="error"> - <td>error</td> - <td>106</td> - <td>Argument $item is missing from the Docblock of useItem</td> - </tr> - <tr class="error"> - <td>error</td> - <td>106</td> - <td>No summary for method useItem()</td> - </tr> - <tr class="error"> - <td>error</td> - <td>112</td> - <td>Argument $root is missing from the Docblock of addToXML</td> - </tr> - <tr class="error"> - <td>error</td> - <td>112</td> - <td>No summary for method addToXML()</td> + <td>48</td> + <td>Argument $name is missing from the Docblock of getItem</td> </tr> </tbody> </table> @@ -290,10 +244,10 @@ <div class="package-contents"> </div> <div class="package-contents"> - <a name="inc/shop.inc" id="inc/shop.inc"></a> + <a name="inc/perso.inc" id="inc/perso.inc"></a> <h3> <i class="icon-file"></i> - inc/shop.inc + inc/perso.inc <span class="pull-right badge badge-info">1</span> </h3> <div> @@ -308,18 +262,18 @@ <tbody> <tr class="error"> <td>error</td> - <td>48</td> - <td>Argument $name is missing from the Docblock of getItem</td> + <td>27</td> + <td>Argument $num is missing from the Docblock of increasePerso</td> </tr> </tbody> </table> </div> </div> <div class="package-contents"> - <a name="inc/perso.inc" id="inc/perso.inc"></a> + <a name="inc/Item.inc" id="inc/Item.inc"></a> <h3> <i class="icon-file"></i> - inc/perso.inc + inc/Item.inc <span class="pull-right badge badge-info">1</span> </h3> <div> @@ -334,18 +288,18 @@ <tbody> <tr class="error"> <td>error</td> - <td>27</td> - <td>Argument $num is missing from the Docblock of increasePerso</td> + <td>0</td> + <td>No summary was found for this file</td> </tr> </tbody> </table> </div> </div> <div class="package-contents"> - <a name="inc/Item.inc" id="inc/Item.inc"></a> + <a name="inc/Monster.inc" id="inc/Monster.inc"></a> <h3> <i class="icon-file"></i> - inc/Item.inc + inc/Monster.inc <span class="pull-right badge badge-info">1</span> </h3> <div> @@ -367,10 +321,6 @@ </table> </div> </div> - <div class="package-contents"> - </div> - <div class="package-contents"> - </div> </div> </div> </div> @@ -379,7 +329,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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/graph_class.html b/doc/phpdoc/graph_class.html index 0143bcc..068a2e8 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 Sun, 08 May 2016 20:44:22 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/index.html b/doc/phpdoc/index.html index 7fc372b..1c76dcf 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">17</span> + <i class="icon-list-alt"></i> Errors <span class="label label-info">7</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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/markers.html b/doc/phpdoc/markers.html index 33d05f7..4765760 100644 --- a/doc/phpdoc/markers.html +++ b/doc/phpdoc/markers.html @@ -99,11 +99,11 @@ <div class="span4"> <ul class="side-nav nav nav-list"> <li class="nav-header">Navigation</li> - <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> - <li><a href="#inc/Item.inc"><i class="icon-file"></i> inc/Item.inc</a></li> - </ul> + <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> </div> <div class="span8"> @@ -115,29 +115,7 @@ <div id="marker-accordion"> - <div class="package-contents"> - <a name="inc/Monster.inc" id="inc/Monster.inc"></a> - <h3> - <i class="icon-file"></i> - inc/Monster.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>23</td> - <td>unused</td> - </tr> - </table> - </div> - </div> - <div class="package-contents"> + <div class="package-contents"> <a name="inc/dungeon.inc" id="inc/dungeon.inc"></a> <h3> <i class="icon-file"></i> @@ -169,7 +147,7 @@ </table> </div> </div> - <div class="package-contents"> + <div class="package-contents"> <a name="inc/shop.inc" id="inc/shop.inc"></a> <h3> <i class="icon-file"></i> @@ -196,7 +174,7 @@ </table> </div> </div> - <div class="package-contents"> + <div class="package-contents"> <a name="inc/Item.inc" id="inc/Item.inc"></a> <h3> <i class="icon-file"></i> @@ -218,7 +196,29 @@ </table> </div> </div> - </div> + <div class="package-contents"> + <a name="inc/Monster.inc" id="inc/Monster.inc"></a> + <h3> + <i class="icon-file"></i> + inc/Monster.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>23</td> + <td>unused</td> + </tr> + </table> + </div> + </div> + </div> </div> </div> </div> @@ -227,7 +227,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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/namespaces/default.html b/doc/phpdoc/namespaces/default.html index fa3b993..87e1895 100644 --- a/doc/phpdoc/namespaces/default.html +++ b/doc/phpdoc/namespaces/default.html @@ -1580,19 +1580,6 @@ 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> @@ -1609,6 +1596,19 @@ sudo chmod g+w data/save </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 +1650,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> diff --git a/doc/phpdoc/packages/Default.html b/doc/phpdoc/packages/Default.html index 0ab1111..0caa25c 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/default.html b/doc/phpdoc/packages/default.html index 36062e5..5b519ce 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.Monster.inc.html">Monster.inc</a> + <span class="divider">\</span><a href="../packages/inc.Inventory.inc.html">Inventory.inc</a> </li> </ul> @@ -320,11 +320,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> @@ -342,7 +342,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> @@ -350,11 +350,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> @@ -420,26 +462,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> + @@ -566,7 +637,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> @@ -574,53 +645,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> @@ -640,7 +711,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> @@ -648,18 +719,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> @@ -679,7 +757,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> @@ -687,53 +765,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> @@ -840,101 +915,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> - - @@ -947,7 +947,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> diff --git a/doc/phpdoc/packages/inc.Inventory.inc.html b/doc/phpdoc/packages/inc.Inventory.inc.html index 2316a5d..4cc9b21 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.Item.inc.html b/doc/phpdoc/packages/inc.Item.inc.html index f9c1c45..bea2d41 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.Monster.inc.html b/doc/phpdoc/packages/inc.Monster.inc.html index dada9c0..234a20d 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.account.inc.html b/doc/phpdoc/packages/inc.account.inc.html index 49b5440..b77b8f4 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.craftmine.inc.html b/doc/phpdoc/packages/inc.craftmine.inc.html index fa7ffff..3d98bbd 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.dungeon.inc.html b/doc/phpdoc/packages/inc.dungeon.inc.html index 7d5d6a3..a6c2668 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.guild.inc.html b/doc/phpdoc/packages/inc.guild.inc.html index f301c47..ed8ab9b 100644 --- a/doc/phpdoc/packages/inc.guild.inc.html +++ b/doc/phpdoc/packages/inc.guild.inc.html @@ -191,7 +191,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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> 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> diff --git a/doc/phpdoc/packages/inc.messages.inc.html b/doc/phpdoc/packages/inc.messages.inc.html index eef0408..23ce6ad 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.mine.inc.html b/doc/phpdoc/packages/inc.mine.inc.html index 0fb2c21..734a429 100644 --- a/doc/phpdoc/packages/inc.mine.inc.html +++ b/doc/phpdoc/packages/inc.mine.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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.perso.inc.html b/doc/phpdoc/packages/inc.perso.inc.html index d724706..8c471aa 100644 --- a/doc/phpdoc/packages/inc.perso.inc.html +++ b/doc/phpdoc/packages/inc.perso.inc.html @@ -181,7 +181,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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.savegame.inc.html b/doc/phpdoc/packages/inc.savegame.inc.html index 4009130..2ec1e2d 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/doc/phpdoc/packages/inc.shop.inc.html b/doc/phpdoc/packages/inc.shop.inc.html index fbdefe6..6908e0f 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 Sun, 08 May 2016 20:44:21 +0200.<br/> + generated on Mon, 09 May 2016 14:01:23 +0200.<br/> </footer> </body> </html> diff --git a/inc/Inventory.inc b/inc/Inventory.inc index 73d82c8..58cf709 100644 --- a/inc/Inventory.inc +++ b/inc/Inventory.inc @@ -8,9 +8,9 @@ * @author Pierre-Emmanuel Novac */ class Inventory { - /** - * Arrays of array with Item and Item's count - */ + /** + * @var array Arrays of array with Item object and Item's count as int + */ public $items = array(); /** @@ -74,6 +74,12 @@ class Inventory { return $tab; } + /** + * Removes an Item object from the Inventory, not taking into account the Item's count. + * + * @param Item $item Item to remove from the Inventory + * @return void + */ private function _removeItem($item) { foreach($this->items as $k => $object) { if($object[0] == $item) { @@ -83,11 +89,23 @@ class Inventory { } } + /** + * Removes an Item object to the singleton's Inventory from session, not taking into account the Item's count. + * + * @param Item $item Item to remove from the Inventory + * @return void + */ public static function removeItem($item) { $inv = self::get(); $inv->_removeItem($item); } + /** + * Consumes an Item object from the Inventory, decrementing the Item's count and removing it if count reaches 0. + * + * @param Item $item Item to consume from the Inventory + * @return array|false Item and updated Item's count, false if it was not found + */ private function _useItem($item) { foreach($this->items as $k => $object){ if($object[0] == $item) { @@ -103,12 +121,24 @@ class Inventory { return false; } + /** + * Consumes an Item object to the singleton's Inventory from session, decrementing the Item's count and removing it if count reaches 0. + * + * @param Item $item Item to consume from the Inventory + * @return array|false Item and updated Item's count, false if it was not found + */ public static function useItem($item) { $inv = self::get(); $it = $inv->_useItem($item); return $it; } + /** + * Generates an XML tree describing the Inventory + * + * @param SimpleXMLElement $root root XML element to add the Inventory's Items to + * @return void + */ public function addToXML($root) { foreach($this->items as $item) $item[0]->addToXML($root, $item[1]); |
