diff options
Diffstat (limited to 'MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameInspect.GameInspect-class.html')
-rw-r--r-- | MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameInspect.GameInspect-class.html | 481 |
1 files changed, 481 insertions, 0 deletions
diff --git a/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameInspect.GameInspect-class.html b/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameInspect.GameInspect-class.html new file mode 100644 index 0000000..10a7888 --- /dev/null +++ b/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameInspect.GameInspect-class.html @@ -0,0 +1,481 @@ +<?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.GameInspect.GameInspect</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.GameInspect-module.html">Module GameInspect</a> :: + Class GameInspect + </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.GameInspect.GameInspect-class.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<!-- ==================== CLASS DESCRIPTION ==================== --> +<h1 class="epydoc">Class GameInspect</h1><p class="nomargin-top"><span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect">source code</a></span></p> +<pre class="base-tree"> +object --+ + | + <strong class="uidshort">GameInspect</strong> +</pre> + +<hr /> +<p>GameInspect is a class that can inspect and modify object trees.</p> + <p>The top most object must be a dictionary</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.GameInspect.GameInspect-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">object_root</span>)</span><br /> + Init function of the GameInspect class.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.__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 href="fortuneengine.GameInspect.GameInspect-class.html#drilldown_object" class="summary-sig-name">drilldown_object</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">objectname</span>)</span><br /> + Takes the objectname string and tries to find the object that it is + representing and returns that object.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.drilldown_object">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.GameInspect.GameInspect-class.html#set_eval" class="summary-sig-name">set_eval</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">objectname</span>, + <span class="summary-sig-arg">statement</span>)</span><br /> + Sets the object referenced by objectname to a value returned by + passing the string stored in the val parameter to an eval statement.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.set_eval">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.GameInspect.GameInspect-class.html#set_str" class="summary-sig-name">set_str</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">objectname</span>, + <span class="summary-sig-arg">val</span>)</span><br /> + Sets the object referenced by objectname to a string passed into the + val parameter.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.set_str">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.GameInspect.GameInspect-class.html#set_int" class="summary-sig-name">set_int</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">objectname</span>, + <span class="summary-sig-arg">val</span>)</span><br /> + Sets the object referenced by objectname to an integer passed into + the val parameter.</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.set_int">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.GameInspect.GameInspect-class.html#inspect_object" class="summary-sig-name">inspect_object</a>(<span class="summary-sig-arg">self</span>, + <span class="summary-sig-arg">objectname</span>)</span><br /> + Displays information about the object path it is passed</td> + <td align="right" valign="top"> + <span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.inspect_object">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">object_root</span>)</span> + <br /><em class="fname">(Constructor)</em> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.__init__">source code</a></span> + </td> + </tr></table> + + <p>Init function of the GameInspect class.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>object_root</code></strong> - The root dictionary of the tree</li> + </ul></dd> + <dt>Overrides: + object.__init__ + </dt> + </dl> +</td></tr></table> +</div> +<a name="drilldown_object"></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">drilldown_object</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">objectname</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.drilldown_object">source code</a></span> + </td> + </tr></table> + + <p>Takes the objectname string and tries to find the object that it is + representing and returns that object.</p> + <p>Example: battle.enemy_list[1].sprite._images[1]</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>objectname</code></strong> - The string that represents the object's path.</li> + </ul></dd> + <dt>Returns:</dt> + <dd>Returns the object requested</dd> + <dt>Raises:</dt> + <dd><ul class="nomargin-top"> + <li><code><strong class='fraise'>Exception</strong></code> - Throws an Exception with the string being the path error.</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="set_eval"></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">set_eval</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">objectname</span>, + <span class="sig-arg">statement</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.set_eval">source code</a></span> + </td> + </tr></table> + + <p>Sets the object referenced by objectname to a value returned by + passing the string stored in the val parameter to an eval statement.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>objectname</code></strong> - A string representation of the location of the object being + inspected in relation to the game engine registered object.</li> + <li><strong class="pname"><code>statement</code></strong> - A string to be evaluated and set to the object.</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="set_str"></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">set_str</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">objectname</span>, + <span class="sig-arg">val</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.set_str">source code</a></span> + </td> + </tr></table> + + <p>Sets the object referenced by objectname to a string passed into the + val parameter.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>objectname</code></strong> - A string representation of the location of the object being + inspected in relation to the game engine registered object.</li> + <li><strong class="pname"><code>val</code></strong> - A string to be set as the value of the object.</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="set_int"></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">set_int</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">objectname</span>, + <span class="sig-arg">val</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.set_int">source code</a></span> + </td> + </tr></table> + + <p>Sets the object referenced by objectname to an integer passed into the + val parameter. It may be a string that holds the int as it will be type + casted.</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>objectname</code></strong> - A string representation of the location of the object being + inspected in relation to the game engine registered object.</li> + <li><strong class="pname"><code>val</code></strong> - An int/string containing an int to be set as the value of the + object.</li> + </ul></dd> + </dl> +</td></tr></table> +</div> +<a name="inspect_object"></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">inspect_object</span>(<span class="sig-arg">self</span>, + <span class="sig-arg">objectname</span>)</span> + </h3> + </td><td align="right" valign="top" + ><span class="codelink"><a href="fortuneengine.GameInspect-pysrc.html#GameInspect.inspect_object">source code</a></span> + </td> + </tr></table> + + <p>Displays information about the object path it is passed</p> + <dl class="fields"> + <dt>Parameters:</dt> + <dd><ul class="nomargin-top"> + <li><strong class="pname"><code>objectname</code></strong> - A string representation of the location of the object being + inspected in relation to the game engine registered object.</li> + </ul></dd> + </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> |