diff options
Diffstat (limited to 'MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement.GameEngineElement-class.html')
| -rw-r--r-- | MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement.GameEngineElement-class.html | 446 |
1 files changed, 446 insertions, 0 deletions
diff --git a/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement.GameEngineElement-class.html b/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement.GameEngineElement-class.html new file mode 100644 index 0000000..408c18e --- /dev/null +++ b/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement.GameEngineElement-class.html @@ -0,0 +1,446 @@ +<?xml version="1.0" encoding="ascii"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>fortuneengine.GameEngineElement.GameEngineElement</title> + <link rel="stylesheet" href="epydoc.css" type="text/css" /> + <script type="text/javascript" src="epydoc.js"></script> +</head> + +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="fortuneengine-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <th class="navbar" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <span class="breadcrumbs"> + <a href="fortuneengine-module.html">Package fortuneengine</a> :: + <a href="fortuneengine.GameEngineElement-module.html">Module GameEngineElement</a> :: + Class GameEngineElement + </span> + </td> + <td> + <table cellpadding="0" cellspacing="0"> + <!-- hide/show private --> + <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" + onclick="toggle_private();">hide private</a>]</span></td></tr> + <tr><td align="right"><span class="options" + >[<a href="frames.html" target="_top">frames</a + >] | <a href="fortuneengine.GameEngineElement.GameEngineElement-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class GameEngineElement</h1><p class="nomargin-top"><span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement">source code</a></span></p> +<pre class="base-tree"> +object --+ + | + <strong class="uidshort">GameEngineElement</strong> +</pre> + +<hr /> +<p>The GameEngineElement is a helper object that can be extended by other + classes. When the class is extended, it will automatically register its + self for the event and draw loops with the game engine.</p> + +<!-- ==================== INSTANCE METHODS ==================== --> +<a name="section-InstanceMethods"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Instance Methods</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-InstanceMethods" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="fortuneengine.GameEngineElement.GameEngineElement-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">has_draw</span>=<span class="summary-sig-default">True</span>, + <span class="summary-sig-arg">has_event</span>=<span class="summary-sig-default">True</span>)</span><br /> + Default constructor for GameEngineElement</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.__init__">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="is_in_engine"></a><span class="summary-sig-name">is_in_engine</span>(<span class="summary-sig-arg">self</span>)</span><br /> + Returns true if object has been registered with the game engine.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.is_in_engine">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="fortuneengine.GameEngineElement.GameEngineElement-class.html#add_to_scene" class="summary-sig-name">add_to_scene</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">objects</span>)</span><br /> + Adds some objects to the DynamicDrawableObject list and the game + engine's scene.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.add_to_scene">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="fortuneengine.GameEngineElement.GameEngineElement-class.html#add_to_engine" class="summary-sig-name">add_to_engine</a>(<span class="summary-sig-arg">self</span>)</span><br /> + Registers the object with the game engine.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.add_to_engine">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a name="remove_from_engine"></a><span class="summary-sig-name">remove_from_engine</span>(<span class="summary-sig-arg">self</span>)</span><br /> + Removes the object from the correct queues in the engine</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.remove_from_engine">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="fortuneengine.GameEngineElement.GameEngineElement-class.html#event_handler" class="summary-sig-name">event_handler</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">event</span>)</span><br /> + This method should be overridden by the user-specified class that + extends this GameEngineElement class.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.event_handler">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> +<tr> + <td width="15%" align="right" valign="top" class="summary"> + <span class="summary-type"> </span> + </td><td class="summary"> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr> + <td><span class="summary-sig"><a href="fortuneengine.GameEngineElement.GameEngineElement-class.html#draw" class="summary-sig-name">draw</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">screen</span>)</span><br /> + This method should be overridden by the user-specified class that + extends this GameEngineElement class.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.draw">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__delattr__</code>, + <code>__format__</code>, + <code>__getattribute__</code>, + <code>__hash__</code>, + <code>__new__</code>, + <code>__reduce__</code>, + <code>__reduce_ex__</code>, + <code>__repr__</code>, + <code>__setattr__</code>, + <code>__sizeof__</code>, + <code>__str__</code>, + <code>__subclasshook__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== PROPERTIES ==================== --> +<a name="section-Properties"></a> +<table class="summary" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Properties</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-Properties" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: + <code>__class__</code> + </p> + </td> + </tr> +</table> +<!-- ==================== METHOD DETAILS ==================== --> +<a name="section-MethodDetails"></a> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="table-header"> + <td colspan="2" class="table-header"> + <table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr valign="top"> + <td align="left"><span class="table-header">Method Details</span></td> + <td align="right" valign="top" + ><span class="options">[<a href="#section-MethodDetails" + class="privatelink" onclick="toggle_private();" + >hide private</a>]</span></td> + </tr> + </table> + </td> +</tr> +</table> +<a name="__init__"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">has_draw</span>=<span class="sig-default">True</span>, + <span class="sig-arg">has_event</span>=<span class="sig-default">True</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.__init__">source code</a></span> + </td> + </tr></table> + + <p>Default constructor for GameEngineElement</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>has_draw</code></strong> - boolean to signify if element should be drawn</li> + <li><strong class="pname"><code>has_event</code></strong> - boolean to signify whether the element should be given events + from the queue</li> + </ul></dd> + <dt>Overrides: + object.__init__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="add_to_scene"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">add_to_scene</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">objects</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.add_to_scene">source code</a></span> + </td> + </tr></table> + + <p>Adds some objects to the DynamicDrawableObject list and the game + engine's scene.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>objects</code></strong> - A list of DynamicDrawableObjects</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="add_to_engine"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">add_to_engine</span>(<span class="sig-arg">self</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.add_to_engine">source code</a></span> + </td> + </tr></table> + + <p>Registers the object with the game engine. Registers draw and event + call backs separately if they were set to true in the constructor.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<a name="event_handler"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">event_handler</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">event</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.event_handler">source code</a></span> + </td> + </tr></table> + + <p>This method should be overridden by the user-specified class that + extends this GameEngineElement class. This method specifies how that + class will handle events given to it by the engine.</p> + <dl class="fields"> + <dt>Returns:</dt> + <dd>true if the user wants to prevent the event from continuing down + the queue</dd> + </dl> +</td></tr></table> +</div> +<a name="draw"></a> +<div> +<table class="details" border="1" cellpadding="3" + cellspacing="0" width="100%" bgcolor="white"> +<tr><td> + <table width="100%" cellpadding="0" cellspacing="0" border="0"> + <tr valign="top"><td> + <h3 class="epydoc"><span class="sig"><span class="sig-name">draw</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">screen</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameEngineElement-pysrc.html#GameEngineElement.draw">source code</a></span> + </td> + </tr></table> + + <p>This method should be overridden by the user-specified class that + extends this GameEngineElement class. This method specifies how the class + will be drawn.</p> + <dl class="fields"> + </dl> +</td></tr></table> +</div> +<br /> +<!-- ==================== NAVIGATION BAR ==================== --> +<table class="navbar" border="0" width="100%" cellpadding="0" + bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="middle"> + <!-- Home link --> + <th> <a + href="fortuneengine-module.html">Home</a> </th> + + <!-- Tree link --> + <th> <a + href="module-tree.html">Trees</a> </th> + + <!-- Index link --> + <th> <a + href="identifier-index.html">Indices</a> </th> + + <!-- Help link --> + <th> <a + href="help.html">Help</a> </th> + + <th class="navbar" width="100%"></th> + </tr> +</table> +<table border="0" cellpadding="0" cellspacing="0" width="100%%"> + <tr> + <td align="left" class="footer"> + Generated by Epydoc 3.0.1 on Sun Aug 22 00:13:13 2010 + </td> + <td align="right" class="footer"> + <a target="mainFrame" href="http://epydoc.sourceforge.net" + >http://epydoc.sourceforge.net</a> + </td> + </tr> +</table> + +<script type="text/javascript"> + <!-- + // Private objects are initially displayed (because if + // javascript is turned off then we want them to be + // visible); but by default, we want to hide them. So hide + // them unless we have a cookie that says to show them. + checkCookie(); + // --> +</script> +</body> +</html> |