aboutsummaryrefslogtreecommitdiffstats
path: root/doc/phpdoc/namespaces
diff options
context:
space:
mode:
authorpiernov <piernov@piernov.org>2016-05-10 23:12:04 +0200
committerpiernov <piernov@piernov.org>2016-05-10 23:12:04 +0200
commit4a77dbec06bf7812fa6326cb103dce52144e49c3 (patch)
treeeda1f82d99b2600fdcbd3772ab327cee12296910 /doc/phpdoc/namespaces
parent4b04ed3abe48a1623b84b5c84fde8ee1b141f3e3 (diff)
downloadcandybox-4a77dbec06bf7812fa6326cb103dce52144e49c3.tar.gz
candybox-4a77dbec06bf7812fa6326cb103dce52144e49c3.tar.bz2
candybox-4a77dbec06bf7812fa6326cb103dce52144e49c3.tar.xz
candybox-4a77dbec06bf7812fa6326cb103dce52144e49c3.zip
Update phpdoc
Diffstat (limited to 'doc/phpdoc/namespaces')
-rw-r--r--doc/phpdoc/namespaces/default.html188
1 files changed, 166 insertions, 22 deletions
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&#039;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>