aboutsummaryrefslogtreecommitdiffstats
path: root/doc/phpdoc/classes/Monster.html
diff options
context:
space:
mode:
authorpiernov <piernov@piernov.org>2016-05-08 20:45:40 +0200
committerpiernov <piernov@piernov.org>2016-05-08 20:45:40 +0200
commit9f28616dfd1cc425c5013937bab729217b7be2e6 (patch)
treec08a53708a6f59374d56b872c4047cbf80c81e27 /doc/phpdoc/classes/Monster.html
parent07f9658d2fecc5f88cc27fba8502246a30d8fdc0 (diff)
downloadcandybox-9f28616dfd1cc425c5013937bab729217b7be2e6.tar.gz
candybox-9f28616dfd1cc425c5013937bab729217b7be2e6.tar.bz2
candybox-9f28616dfd1cc425c5013937bab729217b7be2e6.tar.xz
candybox-9f28616dfd1cc425c5013937bab729217b7be2e6.zip
Add build_doc.sh script + generated phpdoc
Diffstat (limited to 'doc/phpdoc/classes/Monster.html')
-rw-r--r--doc/phpdoc/classes/Monster.html410
1 files changed, 410 insertions, 0 deletions
diff --git a/doc/phpdoc/classes/Monster.html b/doc/phpdoc/classes/Monster.html
new file mode 100644
index 0000000..5f22810
--- /dev/null
+++ b/doc/phpdoc/classes/Monster.html
@@ -0,0 +1,410 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
+ <meta charset="utf-8"/>
+ <title> API Documentation &raquo; \Monster
+</title>
+ <meta name="author" content=""/>
+ <meta name="description" content=""/>
+
+ <link href="../css/template.css" rel="stylesheet" media="all"/>
+
+ <!--[if lt IE 9]>
+ <script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
+ <![endif]-->
+ <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
+ <script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
+ <script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
+ <script src="../js/bootstrap.js" type="text/javascript"></script>
+ <script src="../js/template.js" type="text/javascript"></script>
+ <script src="../js/prettify/prettify.min.js" type="text/javascript"></script>
+
+ <link rel="shortcut icon" href="../img/favicon.ico"/>
+ <link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
+ <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
+ <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
+ </head>
+<body>
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span> <span class="icon-bar"></span>
+ <span class="icon-bar"></span> </a>
+ <a class="brand" href="../index.html">API Documentation</a>
+
+ <div class="nav-collapse">
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
+ API Documentation <b class="caret"></b>
+ </a>
+ <ul class="dropdown-menu">
+ </ul>
+ </li>
+ <li class="dropdown" id="charts-menu">
+ <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
+ Charts <b class="caret"></b>
+ </a>
+ <ul class="dropdown-menu">
+ <li>
+ <a href="../graph_class.html">
+ <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="dropdown" id="reports-menu">
+ <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
+ Reports <b class="caret"></b>
+ </a>
+ <ul class="dropdown-menu">
+ <li>
+ <a href="../errors.html">
+ <i class="icon-list-alt"></i>&#160;Errors
+ </a>
+ </li>
+ <li>
+ <a href="../markers.html">
+ <i class="icon-list-alt"></i>&#160;Markers
+ </a>
+ </li>
+ <li>
+ <a href="../deprecated.html">
+ <i class="icon-list-alt"></i>&#160;Deprecated
+ </a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ <div class="go_to_top">
+ <a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
+ </div>
+ </div>
+
+ <div id="___" class="container">
+ <noscript>
+ <div class="alert alert-warning">
+ Javascript is disabled; several features are only available if Javascript is enabled.
+ </div>
+ </noscript>
+
+
+ <style>
+ .deprecated h2 {
+ text-decoration: line-through;
+ }
+ </style>
+ <div class="row">
+ <div class="span4">
+ <div class="btn-group view pull-right" data-toggle="buttons-radio">
+ <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button>
+ <button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
+ </div>
+ <div class="btn-group visibility" data-toggle="buttons-checkbox">
+ <button class="btn public active" title="Show public elements">Public</button>
+ <button class="btn protected" title="Show protected elements">Protected</button>
+ <button class="btn private" title="Show private elements">Private</button>
+ <button class="btn inherited active" title="Show inherited elements">Inherited</button>
+ </div>
+
+ <ul class="side-nav nav nav-list">
+ <li class="nav-header">
+ <i class="icon-custom icon-method"></i> Methods
+ <ul>
+ <li class="method public">
+ <a href="#method___construct" title="__construct :: Monster&#039;s constructor">
+ <span class="description">Monster&#039;s constructor</span><pre>__construct</pre>
+ </a>
+ </li>
+
+ </ul>
+ </li>
+ <li class="nav-header protected">» Protected
+ <ul>
+ </ul>
+ </li>
+ <li class="nav-header private">» Private
+ <ul>
+ </ul>
+ </li>
+ <li class="nav-header">
+ <i class="icon-custom icon-constant"></i> Constants
+ <ul>
+ </ul>
+ </li>
+ </ul>
+
+
+ </div>
+
+ <div class="span8">
+ <div class="element class">
+ <h1>Monster</h1>
+ <small style="display: block; text-align: right">
+ </small>
+ <p class="short_description">Represent an Item in the shop or in the Inventory.</p>
+ <div class="details">
+ <div class="long_description">
+
+ </div>
+ <table class="table table-bordered">
+ <tr>
+ <th>
+ package
+ </th>
+ <td>
+
+ <p>inc\Monster.inc</p>
+ </td>
+ </tr>
+ <tr>
+ <th>
+ author
+ </th>
+ <td>
+
+ <p>Alexandre Renoux</p>
+ </td>
+ </tr>
+ <tr>
+ <th>
+ author
+ </th>
+ <td>
+
+ <p>Pierre-Emmanuel Novac</p>
+ </td>
+ </tr>
+ </table>
+
+ <h3><i class="icon-custom icon-method"></i> Methods</h3>
+ <a id="method___construct"></a>
+ <div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
+ <h2>Monster&#039;s constructor</h2>
+ <pre>__construct(string $name, integer $level, integer $hp, integer $xp, string $icon) : void</pre>
+ <div class="labels">
+ </div>
+
+
+ <div class="row collapse">
+ <div class="detail-description">
+ <div class="long_description"></div>
+
+ <table class="table">
+ </table>
+
+ <h3>Arguments</h3>
+ <div class="subelement argument">
+ <h4>$name</h4>
+ <code>string</code><p><p>Monster's name</p></p>
+ </div>
+ <div class="subelement argument">
+ <h4>$level</h4>
+ <code>integer</code><p><p>Monster's level</p></p>
+ </div>
+ <div class="subelement argument">
+ <h4>$hp</h4>
+ <code>integer</code><p><p>Monster's HP</p></p>
+ </div>
+ <div class="subelement argument">
+ <h4>$xp</h4>
+ <code>integer</code><p><p>Exp given by the Monster</p></p>
+ </div>
+ <div class="subelement argument">
+ <h4>$icon</h4>
+ <code>string</code><p><p>Item's icon</p></p>
+ </div>
+
+ </div>
+ </div>
+
+ </div>
+
+
+ <h3><i class="icon-custom icon-property"></i> Properties</h3>
+ <a id="property_name"> </a>
+ <div class="element clickable property public property_name" data-toggle="collapse" data-target=".property_name .collapse">
+ <h2>Name of the Monster.</h2>
+ <pre>name : string</pre>
+ <div class="labels">
+ </div>
+ <div class="row collapse">
+ <div class="detail-description">
+ <div class="long_description"></div>
+
+ <table class="table">
+ <tr>
+ <th>
+ var
+ </th>
+ <td>
+ <p>Name of the Monster.</p>
+ </td>
+ </tr>
+ </table>
+
+ <h3>Type(s)</h3>
+ <code>string</code>
+ </div>
+ </div>
+ </div>
+ <a id="property_icon"> </a>
+ <div class="element clickable property public property_icon" data-toggle="collapse" data-target=".property_icon .collapse">
+ <h2>Monster&#039;s icon.</h2>
+ <pre>icon : string</pre>
+ <div class="labels">
+ </div>
+ <div class="row collapse">
+ <div class="detail-description">
+ <div class="long_description"></div>
+
+ <table class="table">
+ <tr>
+ <th>
+ var
+ </th>
+ <td>
+ <p>Monster's icon.</p>
+ </td>
+ </tr>
+ </table>
+
+ <h3>Type(s)</h3>
+ <code>string</code>
+ </div>
+ </div>
+ </div>
+ <a id="property_desc"> </a>
+ <div class="element clickable property public property_desc" data-toggle="collapse" data-target=".property_desc .collapse">
+ <h2>Monster&#039;s description.</h2>
+ <pre>desc : \desc</pre>
+ <div class="labels">
+ </div>
+ <div class="row collapse">
+ <div class="detail-description">
+ <div class="long_description"></div>
+
+ <table class="table">
+ <tr>
+ <th>
+ var
+ </th>
+ <td>
+ <p>Monster's description.</p>
+ </td>
+ </tr>
+ </table>
+
+ <h3>Type(s)</h3>
+ <code>\desc</code>
+ </div>
+ </div>
+ </div>
+ <a id="property_hp"> </a>
+ <div class="element clickable property public property_hp" data-toggle="collapse" data-target=".property_hp .collapse">
+ <h2>HP of the Monster.</h2>
+ <pre>hp : integer</pre>
+ <div class="labels">
+ </div>
+ <div class="row collapse">
+ <div class="detail-description">
+ <div class="long_description"></div>
+
+ <table class="table">
+ <tr>
+ <th>
+ var
+ </th>
+ <td>
+ <p>HP of the Monster.</p>
+ </td>
+ </tr>
+ </table>
+
+ <h3>Type(s)</h3>
+ <code>integer</code>
+ </div>
+ </div>
+ </div>
+ <a id="property_xp"> </a>
+ <div class="element clickable property public property_xp" data-toggle="collapse" data-target=".property_xp .collapse">
+ <h2>Exp given by this monster.</h2>
+ <pre>xp : integer</pre>
+ <div class="labels">
+ </div>
+ <div class="row collapse">
+ <div class="detail-description">
+ <div class="long_description"></div>
+
+ <table class="table">
+ <tr>
+ <th>
+ var
+ </th>
+ <td>
+ <p>Exp given by this monster.</p>
+ </td>
+ </tr>
+ </table>
+
+ <h3>Type(s)</h3>
+ <code>integer</code>
+ </div>
+ </div>
+ </div>
+ <a id="property_level"> </a>
+ <div class="element clickable property public property_level" data-toggle="collapse" data-target=".property_level .collapse">
+ <h2>Monster&#039;s level.</h2>
+ <pre>level : integer</pre>
+ <div class="labels">
+ </div>
+ <div class="row collapse">
+ <div class="detail-description">
+ <div class="long_description"></div>
+
+ <table class="table">
+ <tr>
+ <th>
+ var
+ </th>
+ <td>
+ <p>Monster's level.</p>
+ </td>
+ </tr>
+ </table>
+
+ <h3>Type(s)</h3>
+ <code>integer</code>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+ <a id="\Monster"></a>
+ <ul class="breadcrumb">
+ <li><a href="../index.html"><i class="icon-custom icon-class"></i></a></li>
+
+
+ <li><span class="divider">\</span><a href="../namespaces/default.html">\</a></li>
+
+ <li class="active"><span class="divider">\</span><a href="../classes/Monster.html">Monster</a></li>
+ </ul>
+ </div>
+ </div>
+
+ </div>
+
+ <footer class="span12">
+ 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/>
+ </footer>
+ </body>
+</html>
generated by cgit v1.2.3-70-g09d2 (git 2.47.0) at 2024-11-21 22:46:40 +0000