diff options
| author | piernov <piernov@piernov.org> | 2016-05-10 22:24:50 +0200 |
|---|---|---|
| committer | piernov <piernov@piernov.org> | 2016-05-10 22:24:50 +0200 |
| commit | 9ad61ab6a23bd6fd51e67b85d743b4a7664ec637 (patch) | |
| tree | 04c4ef3158c9848db91e56f9318162431a6040b4 /doc/phpdoc/classes/Item.html | |
| parent | 204e838a7794bbce0d44fc35efb367abb052d02f (diff) | |
| parent | 1e52affe15fb13e920f8942de998073238be6d01 (diff) | |
| download | candybox-9ad61ab6a23bd6fd51e67b85d743b4a7664ec637.tar.gz candybox-9ad61ab6a23bd6fd51e67b85d743b4a7664ec637.tar.bz2 candybox-9ad61ab6a23bd6fd51e67b85d743b4a7664ec637.tar.xz candybox-9ad61ab6a23bd6fd51e67b85d743b4a7664ec637.zip | |
Merge branch 'phpdoc' into piernov
Diffstat (limited to 'doc/phpdoc/classes/Item.html')
| -rw-r--r-- | doc/phpdoc/classes/Item.html | 483 |
1 files changed, 483 insertions, 0 deletions
diff --git a/doc/phpdoc/classes/Item.html b/doc/phpdoc/classes/Item.html new file mode 100644 index 0000000..eab07f2 --- /dev/null +++ b/doc/phpdoc/classes/Item.html @@ -0,0 +1,483 @@ +<!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 » \Item +</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> 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> Errors + </a> + </li> + <li> + <a href="../markers.html"> + <i class="icon-list-alt"></i> Markers + </a> + </li> + <li> + <a href="../deprecated.html"> + <i class="icon-list-alt"></i> Deprecated + </a> + </li> + </ul> + </li> + </ul> + </div> + </div> + </div> + <div class="go_to_top"> + <a href="#___" style="color: inherit">Back to top  <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 :: Item's constructor"> + <span class="description">Item's constructor</span><pre>__construct</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_addToXML" title="addToXML :: Generates an XML tree describing the Item"> + <span class="description">Generates an XML tree describing the Item</span><pre>addToXML</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_consume" title="consume :: Applies Item's features on the player."> + <span class="description">Applies Item's features on the player.</span><pre>consume</pre> + </a> + </li> + + <li class="method public"> + <a href="#method_fromXML" title="fromXML :: Generates an Item object from an XML tree"> + <span class="description">Generates an Item object from an XML tree</span><pre>fromXML</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>Item</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\Item.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>Item's constructor</h2> + <pre>__construct(string $name, integer $cost, string $icon, string $desc, array $feat) : 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>Item's name</p></p> + </div> + <div class="subelement argument"> + <h4>$cost</h4> + <code>integer</code><p><p>Item's cost</p></p> + </div> + <div class="subelement argument"> + <h4>$icon</h4> + <code>string</code><p><p>Item's icon</p></p> + </div> + <div class="subelement argument"> + <h4>$desc</h4> + <code>string</code><p><p>Item's description</p></p> + </div> + <div class="subelement argument"> + <h4>$feat</h4> + <code>array</code><p><p>associative array of strings describing the Item's features</p></p> + </div> + + </div> + </div> + + </div> + <a id="method_addToXML"></a> + <div class="element clickable method public method_addToXML" data-toggle="collapse" data-target=".method_addToXML .collapse"> + <h2>Generates an XML tree describing the Item</h2> + <pre>addToXML( $root, integer $count) : 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>$root</h4> + <code></code><p></p> + </div> + <div class="subelement argument"> + <h4>$count</h4> + <code>integer</code><p><p>numbers of Items</p></p> + </div> + + </div> + </div> + + </div> + <a id="method_consume"></a> + <div class="element clickable method public method_consume" data-toggle="collapse" data-target=".method_consume .collapse"> + <h2>Applies Item's features on the player.</h2> + <pre>consume() : void</pre> + <div class="labels"> + </div> + + + <div class="row collapse"> + <div class="detail-description"> + <div class="long_description"></div> + + <table class="table"> + <tr> + <th> + + </th> + <td> + </td> + </tr> + </table> + + + </div> + </div> + + </div> + <a id="method_fromXML"></a> + <div class="element clickable method public method_fromXML" data-toggle="collapse" data-target=".method_fromXML .collapse"> + <h2>Generates an Item object from an XML tree</h2> + <pre>fromXML(\SimpleXMLElement $xml) : void</pre> + <div class="labels"> + <span class="label">static</span> </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>$xml</h4> + <code>\SimpleXMLElement</code><p><p>root XML element representing the Item</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 item.</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 item.</p> + </td> + </tr> + </table> + + <h3>Type(s)</h3> + <code>string</code> + </div> + </div> + </div> + <a id="property_cost"> </a> + <div class="element clickable property public property_cost" data-toggle="collapse" data-target=".property_cost .collapse"> + <h2>Item's cost.</h2> + <pre>cost : 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>Item's cost.</p> + </td> + </tr> + </table> + + <h3>Type(s)</h3> + <code>integer</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>Item'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>Item'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>Item's description.</h2> + <pre>desc : 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>Item's description.</p> + </td> + </tr> + </table> + + <h3>Type(s)</h3> + <code>string</code> + </div> + </div> + </div> + <a id="property_feat"> </a> + <div class="element clickable property public property_feat" data-toggle="collapse" data-target=".property_feat .collapse"> + <h2>Item's features as an associative array</h2> + <pre>feat : array</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>Item's features as an associative array</p> + </td> + </tr> + </table> + + <h3>Type(s)</h3> + <code>array</code> + </div> + </div> + </div> + </div> + </div> + <a id="\Item"></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/Item.html">Item</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 Mon, 09 May 2016 14:01:23 +0200.<br/> + </footer> + </body> +</html> |