diff options
Diffstat (limited to 'MAFH2/fortuneengine/docs/epydoc/fortuneengine.DrawableObject.DrawableObject-class.html')
| -rw-r--r-- | MAFH2/fortuneengine/docs/epydoc/fortuneengine.DrawableObject.DrawableObject-class.html | 628 |
1 files changed, 628 insertions, 0 deletions
diff --git a/MAFH2/fortuneengine/docs/epydoc/fortuneengine.DrawableObject.DrawableObject-class.html b/MAFH2/fortuneengine/docs/epydoc/fortuneengine.DrawableObject.DrawableObject-class.html new file mode 100644 index 0000000..3eeadab --- /dev/null +++ b/MAFH2/fortuneengine/docs/epydoc/fortuneengine.DrawableObject.DrawableObject-class.html @@ -0,0 +1,628 @@ +<?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.DrawableObject.DrawableObject</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.DrawableObject-module.html">Module DrawableObject</a> :: + Class DrawableObject + </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.DrawableObject.DrawableObject-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class DrawableObject</h1><p class="nomargin-top"><span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject">source code</a></span></p> +<pre class="base-tree"> + object --+ + | +pygame.sprite.Sprite --+ + | + <strong class="uidshort">DrawableObject</strong> +</pre> + +<dl><dt>Known Subclasses:</dt> +<dd> + <ul class="subclass-list"> +<li><a href="fortuneengine.DynamicDrawableObject.DynamicDrawableObject-class.html">DynamicDrawableObject.DynamicDrawableObject</a></li><li>, <a href="fortuneengine.DrawableFontObject.DrawableFontObject-class.html">DrawableFontObject.DrawableFontObject</a></li> </ul> +</dd></dl> + +<hr /> +<!-- ==================== 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.DrawableObject.DrawableObject-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">images</span>, + <span class="summary-sig-arg">textfileName</span>, + <span class="summary-sig-arg">transparent</span>=<span class="summary-sig-default">False</span>, + <span class="summary-sig-arg">x</span>=<span class="summary-sig-default">0</span>, + <span class="summary-sig-arg">y</span>=<span class="summary-sig-default">0</span>)</span><br /> + x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.__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="repopulateImages"></a><span class="summary-sig-name">repopulateImages</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">newImages</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.repopulateImages">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="addImages"></a><span class="summary-sig-name">addImages</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">images</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.addImages">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="goToAnim"></a><span class="summary-sig-name">goToAnim</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">animName</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.goToAnim">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="goToFrame"></a><span class="summary-sig-name">goToFrame</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">frame</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.goToFrame">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="nudge"></a><span class="summary-sig-name">nudge</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">x</span>, + <span class="summary-sig-arg">y</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.nudge">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="scale"></a><span class="summary-sig-name">scale</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">x</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">y</span>=<span class="summary-sig-default">None</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.scale">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="fill"></a><span class="summary-sig-name">fill</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">color</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.fill">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="getXSize"></a><span class="summary-sig-name">getXSize</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.getXSize">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="getYSize"></a><span class="summary-sig-name">getYSize</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.getYSize">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="rotate"></a><span class="summary-sig-name">rotate</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">angle</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.rotate">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="getRotation"></a><span class="summary-sig-name">getRotation</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.getRotation">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="setPosition"></a><span class="summary-sig-name">setPosition</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">x</span>=<span class="summary-sig-default">None</span>, + <span class="summary-sig-arg">y</span>=<span class="summary-sig-default">None</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.setPosition">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="getXPos"></a><span class="summary-sig-name">getXPos</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.getXPos">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="getYPos"></a><span class="summary-sig-name">getYPos</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.getYPos">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="calcColorKey"></a><span class="summary-sig-name">calcColorKey</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">x</span>=<span class="summary-sig-default">0</span>, + <span class="summary-sig-arg">y</span>=<span class="summary-sig-default">0</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.calcColorKey">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="makeTransparent"></a><span class="summary-sig-name">makeTransparent</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">bool</span>=<span class="summary-sig-default">True</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.makeTransparent">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="setColorKey"></a><span class="summary-sig-name">setColorKey</span>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">aColor</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.setColorKey">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.DrawableObject.DrawableObject-class.html#update" class="summary-sig-name">update</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">t</span>=<span class="summary-sig-default">None</span>)</span><br /> + method to control sprite behavior Sprite.update(*args):</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.update">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="nextFrame"></a><span class="summary-sig-name">nextFrame</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.nextFrame">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="nextCurrentAnimFrame"></a><span class="summary-sig-name">nextCurrentAnimFrame</span>(<span class="summary-sig-arg">self</span>)</span></td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.nextCurrentAnimFrame">source code</a></span> + + </td> + </tr> + </table> + + </td> + </tr> + <tr> + <td colspan="2" class="summary"> + <p class="indent-wrapped-lines"><b>Inherited from <code>pygame.sprite.Sprite</code></b>: + <code>__repr__</code>, + <code>add</code>, + <code>add_internal</code>, + <code>alive</code>, + <code>groups</code>, + <code>kill</code>, + <code>remove</code>, + <code>remove_internal</code> + </p> + <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>__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">images</span>, + <span class="sig-arg">textfileName</span>, + <span class="sig-arg">transparent</span>=<span class="sig-default">False</span>, + <span class="sig-arg">x</span>=<span class="sig-default">0</span>, + <span class="sig-arg">y</span>=<span class="sig-default">0</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.__init__">source code</a></span> + </td> + </tr></table> + + <p>x.__init__(...) initializes x; see x.__class__.__doc__ for + signature</p> + <dl class="fields"> + <dt>Overrides: + object.__init__ + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </dl> +</td></tr></table> +</div> +<a name="update"></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">update</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">t</span>=<span class="sig-default">None</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.DrawableObject-pysrc.html#DrawableObject.update">source code</a></span> + </td> + </tr></table> + + <p>method to control sprite behavior Sprite.update(*args):</p> + <p>The default implementation of this method does nothing; it's just a + convenient "hook" that you can override. This method is called + by Group.update() with whatever arguments you give it.</p> + <p>There is no need to use this method if not using the convenience + method by the same name in the Group class.</p> + <dl class="fields"> + <dt>Overrides: + pygame.sprite.Sprite.update + <dd><em class="note">(inherited documentation)</em></dd> + </dt> + </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> |