Skip to content

Commit

Permalink
Changed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@MikeHart66
MikeHart66 committed Oct 24, 2015
1 parent 9a7dbf2 commit 34a1a25
Show file tree
Hide file tree
Showing 25 changed files with 77 additions and 76 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,4 @@ fantomEngine provides a lot of feature like these:
* **Easy scene/room management**.
* Objects can be composed of several single images.
* **Automatic object pooling**.
* **Custom GUI elements**
2 changes: 1 addition & 1 deletion docs/cftAStar.monkey.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cftBox2D.monkey.html
View file

Large diffs are not rendered by default.

96 changes: 48 additions & 48 deletions docs/cftEngine.monkey.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cftFont.monkey.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
<title>fantomEngine.cftFont</title>
</head>
<body>
<h2>Module fantomEngine.cftFont</h2><blockquote><nav><b>fantomEngine documentation</b> | <a href="index.html">Home</a> | <a href="classes.html">Classes</a> | <a href="3rdpartytools.html">3rd party tools</a> | <a href="examples.html">Examples</a> | <a href="changes.html">Changes</a></nav></blockquote><br>The module cftFont hosts several classes which add bitmap font drawing to fantomEngine. Bitmap fonts are important if you need to show text information inside your game fast and easy.<br><h3>Table of contents:</h3><p>Classes:</p><p><ul><li><a href="#824ftFont">ftFont</a> &emsp;&emsp;<FONT COLOR="#FF0000>" <b>Added fontMachine support in version 1.54</b></FONT></ul></p><table style="width: 100%" id="824ftFont"><tbody><tr id="ftFont"><td class="tablehead" colspan="2">Class ftFont</td></tr><tr><td style="width:90px">Changes:</td><td>Added fontMachine support in version 1.54</td></tr><tr><td style="width:90px">Description:</td><td>The class ftFont provides a few methods regarding the definition of a loaded font.</td></tr><tr><td style="width:90px">Table of contents:</td><td>Methods:<br><ul><li><a href="#826Height">Height</a> &emsp;&emsp;<i>( Method Height:Int() )</i><li><a href="#827Length">Length</a> &emsp;&emsp;<i>( Method Length:Int(t:String) )</i></ul><br></td></tr><tr><td colspan="2"><table style="width: 100%" class="subtable"><tbody><tr id="826Height"><td class="subtablehead" colspan="2"id="Height">Method Height:Int()</td></tr><tr><td style="width:90px"><br>Syntax:<br><br></td><td><br><b>Int</b> = ftFont.<b>Height</b> ()</td></tr><tr><td style="width:90px">Description:</td><td>Returns the maximum height of the font.</td></tr><tr><td style="width:90px">Return type:</td><td>Int</td></tr></tbody></table><tr><td colspan="2"><table style="width: 100%" class="subtable"><tbody><tr id="827Length"><td class="subtablehead" colspan="2"id="Length">Method Length:Int(t:String)</td></tr><tr><td style="width:90px"><br>Syntax:<br><br></td><td><br><b>Int</b> = ftFont.<b>Length</b> (t:String)</td></tr><tr><td style="width:90px">Description:</td><td>Returns the length in pixel of the given text string.</td></tr><tr><td style="width:90px">Return type:</td><td>Int</td></tr><tr><td style="width:90px">Parameters:</td><td><table border="0"" width:100%" class="subtable"><tr><th>Name</th><th>Type</th><th>Value</th></tr><tr><td>t</td><td>String</td><td></td></tr></table></td></tr></tbody></table></tbody></table>This fantomEngine framework is released under the MIT license:<br><blockquote>Copyright (c) 2011-2016 Michael Hartlef<br><br>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, and to permit persons to whom the software is furnished to do so, subject to the following conditions:<br><br>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the software.<br><br>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<br></blockquote><br><p class="footer">This document was generated using the <a href="http://www.fantomgl.com">DocMonk</a> document generator ( Version 2.0 )</p></body>
<h2>Module fantomEngine.cftFont</h2><blockquote><nav><b>fantomEngine documentation</b> | <a href="index.html">Home</a> | <a href="classes.html">Classes</a> | <a href="3rdpartytools.html">3rd party tools</a> | <a href="examples.html">Examples</a> | <a href="changes.html">Changes</a></nav></blockquote><br>The module cftFont hosts several classes which add bitmap font drawing to fantomEngine. Bitmap fonts are important if you need to show text information inside your game fast and easy.<br><h3>Table of contents:</h3><p>Classes:</p><p><ul><li><a href="#823ftFont">ftFont</a> &emsp;&emsp;<FONT COLOR="#FF0000>" <b>Added fontMachine support in version 1.54</b></FONT></ul></p><table style="width: 100%" id="823ftFont"><tbody><tr id="ftFont"><td class="tablehead" colspan="2">Class ftFont</td></tr><tr><td style="width:90px">Changes:</td><td>Added fontMachine support in version 1.54</td></tr><tr><td style="width:90px">Description:</td><td>The class ftFont provides a few methods regarding the definition of a loaded font.</td></tr><tr><td style="width:90px">Table of contents:</td><td>Methods:<br><ul><li><a href="#825Height">Height</a> &emsp;&emsp;<i>( Method Height:Int() )</i><li><a href="#826Length">Length</a> &emsp;&emsp;<i>( Method Length:Int(t:String) )</i></ul><br></td></tr><tr><td colspan="2"><table style="width: 100%" class="subtable"><tbody><tr id="825Height"><td class="subtablehead" colspan="2"id="Height">Method Height:Int()</td></tr><tr><td style="width:90px"><br>Syntax:<br><br></td><td><br><b>Int</b> = ftFont.<b>Height</b> ()</td></tr><tr><td style="width:90px">Description:</td><td>Returns the maximum height of the font.</td></tr><tr><td style="width:90px">Return type:</td><td>Int</td></tr></tbody></table><tr><td colspan="2"><table style="width: 100%" class="subtable"><tbody><tr id="826Length"><td class="subtablehead" colspan="2"id="Length">Method Length:Int(t:String)</td></tr><tr><td style="width:90px"><br>Syntax:<br><br></td><td><br><b>Int</b> = ftFont.<b>Length</b> (t:String)</td></tr><tr><td style="width:90px">Description:</td><td>Returns the length in pixel of the given text string.</td></tr><tr><td style="width:90px">Return type:</td><td>Int</td></tr><tr><td style="width:90px">Parameters:</td><td><table border="0"" width:100%" class="subtable"><tr><th>Name</th><th>Type</th><th>Value</th></tr><tr><td>t</td><td>String</td><td></td></tr></table></td></tr></tbody></table></tbody></table>This fantomEngine framework is released under the MIT license:<br><blockquote>Copyright (c) 2011-2016 Michael Hartlef<br><br>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software, and to permit persons to whom the software is furnished to do so, subject to the following conditions:<br><br>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the software.<br><br>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<br></blockquote><br><p class="footer">This document was generated using the <a href="http://www.fantomgl.com">DocMonk</a> document generator ( Version 2.0 )</p></body>
</html>
2 changes: 1 addition & 1 deletion docs/cftFunctions.monkey.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/cftGui.monkey.html
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 34a1a25

Please sign in to comment.