diff options
Diffstat (limited to 'MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement-pysrc.html')
| -rw-r--r-- | MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement-pysrc.html | 227 |
1 files changed, 227 insertions, 0 deletions
diff --git a/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement-pysrc.html b/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement-pysrc.html new file mode 100644 index 0000000..89c1487 --- /dev/null +++ b/MAFH2/fortuneengine/docs/epydoc/fortuneengine.GameEngineElement-pysrc.html @@ -0,0 +1,227 @@ +<?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</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> :: + Module 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-pysrc.html" + target="_top">no frames</a>]</span></td></tr> + </table> + </td> + </tr> +</table> +<h1 class="epydoc">Source Code for <a href="fortuneengine.GameEngineElement-module.html">Module fortuneengine.GameEngineElement</a></h1> +<pre class="py-src"> +<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># FortuneEngine is free software: you can redistribute it and/or modify</tt> </tt> +<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"># it under the terms of the GNU General Public License as published by</tt> </tt> +<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"># the Free Software Foundation, either version 3 of the License, or</tt> </tt> +<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"># (at your option) any later version.</tt> </tt> +<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> +<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"># FortuneEngine is distributed in the hope that it will be useful,</tt> </tt> +<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"># but WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt> +<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</tt> </tt> +<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"># GNU General Public License for more details.</tt> </tt> +<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> +<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"># You should have received a copy of the GNU General Public License</tt> </tt> +<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"># along with the FortuneEngine. If not, see <http://www.gnu.org/licenses/>.</tt> </tt> +<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt> +<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-comment"># Author: Justin Lewis <jlew.blackout@gmail.com></tt> </tt> +<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"> </tt> +<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package fortuneengine=fortuneengine-module.html"><a title="fortuneengine" class="py-name" href="#" onclick="return doclink('link-0', 'fortuneengine', 'link-0');">fortuneengine</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Module fortuneengine.GameEngine=fortuneengine.GameEngine-module.html,Class fortuneengine.GameEngine.GameEngine=fortuneengine.GameEngine.GameEngine-class.html"><a title="fortuneengine.GameEngine +fortuneengine.GameEngine.GameEngine" class="py-name" href="#" onclick="return doclink('link-1', 'GameEngine', 'link-1');">GameEngine</a></tt> <tt class="py-keyword">import</tt> <tt id="link-2" class="py-name"><a title="fortuneengine.GameEngine +fortuneengine.GameEngine.GameEngine" class="py-name" href="#" onclick="return doclink('link-2', 'GameEngine', 'link-1');">GameEngine</a></tt> </tt> +<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-comment">#from fortuneengine.DrawableFontObject import DrawableFontObject</tt> </tt> +<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-comment">#from fortuneengine.DrawableObject import DrawableObject</tt> </tt> +<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-comment">#from fortuneengine.DynamicDrawableObject import DynamicDrawableObject</tt> </tt> +<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"> </tt> +<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"> </tt> +<a name="GameEngineElement"></a><div id="GameEngineElement-def"><a name="L22"></a><tt class="py-lineno"> 22</tt> <a class="py-toggle" href="#" id="GameEngineElement-toggle" onclick="return toggle('GameEngineElement');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="fortuneengine.GameEngineElement.GameEngineElement-class.html">GameEngineElement</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +</div><div id="GameEngineElement-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="GameEngineElement-expanded"><a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> +<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring"> The GameEngineElement is a helper object that can be extended by</tt> </tt> +<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring"> other classes. When the class is extended, it will automatically</tt> </tt> +<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"><tt class="py-docstring"> register its self for the event and draw loops with the game engine.</tt> </tt> +<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> +<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"> </tt> +<a name="GameEngineElement.__init__"></a><div id="GameEngineElement.__init__-def"><a name="L29"></a><tt class="py-lineno"> 29</tt> <a class="py-toggle" href="#" id="GameEngineElement.__init__-toggle" onclick="return toggle('GameEngineElement.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="fortuneengine.GameEngineElement.GameEngineElement-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">has_draw</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-param">has_event</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +</div><div id="GameEngineElement.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="GameEngineElement.__init__-expanded"><a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> +<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-docstring"> Default constructor for GameEngineElement</tt> </tt> +<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> +<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-docstring"> @param has_draw: boolean to signify if element should be drawn</tt> </tt> +<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-docstring"> @param has_event: boolean to signify whether the element should be</tt> </tt> +<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-docstring"> given events from the queue</tt> </tt> +<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> +<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__has_draw</tt> <tt class="py-op">=</tt> <tt class="py-name">has_draw</tt> </tt> +<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__has_event</tt> <tt class="py-op">=</tt> <tt class="py-name">has_event</tt> </tt> +<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__in_engine</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> +<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">game_engine</tt> <tt class="py-op">=</tt> <tt id="link-3" class="py-name"><a title="fortuneengine.GameEngine +fortuneengine.GameEngine.GameEngine" class="py-name" href="#" onclick="return doclink('link-3', 'GameEngine', 'link-1');">GameEngine</a></tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Variable fortuneengine.GameEngine.GameEngine.instance=fortuneengine.GameEngine.GameEngine-class.html#instance"><a title="fortuneengine.GameEngine.GameEngine.instance" class="py-name" href="#" onclick="return doclink('link-4', 'instance', 'link-4');">instance</a></tt> </tt> +<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__ddo_list</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt> +</div><a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> </tt> +<a name="GameEngineElement.is_in_engine"></a><div id="GameEngineElement.is_in_engine-def"><a name="L43"></a><tt class="py-lineno"> 43</tt> <a class="py-toggle" href="#" id="GameEngineElement.is_in_engine-toggle" onclick="return toggle('GameEngineElement.is_in_engine');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="fortuneengine.GameEngineElement.GameEngineElement-class.html#is_in_engine">is_in_engine</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +</div><div id="GameEngineElement.is_in_engine-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="GameEngineElement.is_in_engine-expanded"><a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> +<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"> Returns true if object has been registered with the game engine.</tt> </tt> +<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> +<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__in_engine</tt> </tt> +</div><a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> </tt> +<a name="GameEngineElement.add_to_scene"></a><div id="GameEngineElement.add_to_scene-def"><a name="L49"></a><tt class="py-lineno"> 49</tt> <a class="py-toggle" href="#" id="GameEngineElement.add_to_scene-toggle" onclick="return toggle('GameEngineElement.add_to_scene');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="fortuneengine.GameEngineElement.GameEngineElement-class.html#add_to_scene">add_to_scene</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">objects</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +</div><div id="GameEngineElement.add_to_scene-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="GameEngineElement.add_to_scene-expanded"><a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> +<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> Adds some objects to the DynamicDrawableObject list and the</tt> </tt> +<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> game engine's scene.</tt> </tt> +<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt> +<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"> @param objects: A list of DynamicDrawableObjects</tt> </tt> +<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> +<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> </tt> +<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">game_engine</tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method fortuneengine.GameEngine.GameEngine.get_scene()=fortuneengine.GameEngine.GameEngine-class.html#get_scene"><a title="fortuneengine.GameEngine.GameEngine.get_scene" class="py-name" href="#" onclick="return doclink('link-5', 'get_scene', 'link-5');">get_scene</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Method fortuneengine.Scene.Scene.addObjects()=fortuneengine.Scene.Scene-class.html#addObjects"><a title="fortuneengine.Scene.Scene.addObjects" class="py-name" href="#" onclick="return doclink('link-6', 'addObjects', 'link-6');">addObjects</a></tt><tt class="py-op">(</tt><tt class="py-name">objects</tt><tt class="py-op">)</tt> </tt> +<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__ddo_list</tt> <tt class="py-op">+=</tt> <tt class="py-name">objects</tt> </tt> +</div><a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"> </tt> +<a name="GameEngineElement.add_to_engine"></a><div id="GameEngineElement.add_to_engine-def"><a name="L60"></a><tt class="py-lineno"> 60</tt> <a class="py-toggle" href="#" id="GameEngineElement.add_to_engine-toggle" onclick="return toggle('GameEngineElement.add_to_engine');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="fortuneengine.GameEngineElement.GameEngineElement-class.html#add_to_engine">add_to_engine</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +</div><div id="GameEngineElement.add_to_engine-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="GameEngineElement.add_to_engine-expanded"><a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> +<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"> Registers the object with the game engine. Registers draw and event</tt> </tt> +<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> call backs separately if they were set to true in the constructor.</tt> </tt> +<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> +<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__in_engine</tt><tt class="py-op">:</tt> </tt> +<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__in_engine</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt> +<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> </tt> +<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__has_draw</tt><tt class="py-op">:</tt> </tt> +<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">game_engine</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method fortuneengine.GameEngine.GameEngine.add_draw_callback()=fortuneengine.GameEngine.GameEngine-class.html#add_draw_callback"><a title="fortuneengine.GameEngine.GameEngine.add_draw_callback" class="py-name" href="#" onclick="return doclink('link-7', 'add_draw_callback', 'link-7');">add_draw_callback</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method fortuneengine.GameEngineElement.GameEngineElement.draw()=fortuneengine.GameEngineElement.GameEngineElement-class.html#draw,Method fortuneengine.Scene.Scene.draw()=fortuneengine.Scene.Scene-class.html#draw,Method fortuneengine.pyconsole.pyconsole.Console.draw()=fortuneengine.pyconsole.pyconsole.Console-class.html#draw"><a title="fortuneengine.GameEngineElement.GameEngineElement.draw +fortuneengine.Scene.Scene.draw +fortuneengine.pyconsole.pyconsole.Console.draw" class="py-name" href="#" onclick="return doclink('link-8', 'draw', 'link-8');">draw</a></tt><tt class="py-op">)</tt> </tt> +<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> </tt> +<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__has_event</tt><tt class="py-op">:</tt> </tt> +<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">game_engine</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name" targets="Method fortuneengine.GameEngine.GameEngine.add_event_callback()=fortuneengine.GameEngine.GameEngine-class.html#add_event_callback"><a title="fortuneengine.GameEngine.GameEngine.add_event_callback" class="py-name" href="#" onclick="return doclink('link-9', 'add_event_callback', 'link-9');">add_event_callback</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name" targets="Method fortuneengine.GameEngineElement.GameEngineElement.event_handler()=fortuneengine.GameEngineElement.GameEngineElement-class.html#event_handler"><a title="fortuneengine.GameEngineElement.GameEngineElement.event_handler" class="py-name" href="#" onclick="return doclink('link-10', 'event_handler', 'link-10');">event_handler</a></tt><tt class="py-op">)</tt> </tt> +</div><a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> </tt> +<a name="GameEngineElement.remove_from_engine"></a><div id="GameEngineElement.remove_from_engine-def"><a name="L74"></a><tt class="py-lineno"> 74</tt> <a class="py-toggle" href="#" id="GameEngineElement.remove_from_engine-toggle" onclick="return toggle('GameEngineElement.remove_from_engine');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="fortuneengine.GameEngineElement.GameEngineElement-class.html#remove_from_engine">remove_from_engine</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +</div><div id="GameEngineElement.remove_from_engine-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="GameEngineElement.remove_from_engine-expanded"><a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> +<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> Removes the object from the correct queues in the engine</tt> </tt> +<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> +<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__in_engine</tt><tt class="py-op">:</tt> </tt> +<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__in_engine</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt> +<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> </tt> +<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__has_draw</tt><tt class="py-op">:</tt> </tt> +<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">game_engine</tt><tt class="py-op">.</tt><tt id="link-11" class="py-name" targets="Method fortuneengine.GameEngine.GameEngine.remove_draw_callback()=fortuneengine.GameEngine.GameEngine-class.html#remove_draw_callback"><a title="fortuneengine.GameEngine.GameEngine.remove_draw_callback" class="py-name" href="#" onclick="return doclink('link-11', 'remove_draw_callback', 'link-11');">remove_draw_callback</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-12" class="py-name"><a title="fortuneengine.GameEngineElement.GameEngineElement.draw +fortuneengine.Scene.Scene.draw +fortuneengine.pyconsole.pyconsole.Console.draw" class="py-name" href="#" onclick="return doclink('link-12', 'draw', 'link-8');">draw</a></tt><tt class="py-op">)</tt> </tt> +<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"> </tt> +<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__has_event</tt><tt class="py-op">:</tt> </tt> +<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">game_engine</tt><tt class="py-op">.</tt><tt id="link-13" class="py-name" targets="Method fortuneengine.GameEngine.GameEngine.remove_event_callback()=fortuneengine.GameEngine.GameEngine-class.html#remove_event_callback"><a title="fortuneengine.GameEngine.GameEngine.remove_event_callback" class="py-name" href="#" onclick="return doclink('link-13', 'remove_event_callback', 'link-13');">remove_event_callback</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name"><a title="fortuneengine.GameEngineElement.GameEngineElement.event_handler" class="py-name" href="#" onclick="return doclink('link-14', 'event_handler', 'link-10');">event_handler</a></tt><tt class="py-op">)</tt> </tt> +<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> </tt> +<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__ddo_list</tt> <tt class="py-op">==</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">object</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__ddo_list</tt><tt class="py-op">:</tt> </tt> +<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">game_engine</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name"><a title="fortuneengine.GameEngine.GameEngine.get_scene" class="py-name" href="#" onclick="return doclink('link-15', 'get_scene', 'link-5');">get_scene</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method fortuneengine.Scene.Scene.removeObject()=fortuneengine.Scene.Scene-class.html#removeObject"><a title="fortuneengine.Scene.Scene.removeObject" class="py-name" href="#" onclick="return doclink('link-16', 'removeObject', 'link-16');">removeObject</a></tt><tt class="py-op">(</tt><tt class="py-name">object</tt><tt class="py-op">)</tt> </tt> +</div><a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> </tt> +<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> </tt> +<a name="GameEngineElement.event_handler"></a><div id="GameEngineElement.event_handler-def"><a name="L92"></a><tt class="py-lineno"> 92</tt> <a class="py-toggle" href="#" id="GameEngineElement.event_handler-toggle" onclick="return toggle('GameEngineElement.event_handler');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="fortuneengine.GameEngineElement.GameEngineElement-class.html#event_handler">event_handler</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">event</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +</div><div id="GameEngineElement.event_handler-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="GameEngineElement.event_handler-expanded"><a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> +<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> This method should be overridden by the user-specified class that</tt> </tt> +<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> extends this GameEngineElement class. This method specifies how that</tt> </tt> +<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> class will handle events given to it by the engine.</tt> </tt> +<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt> +<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> @return: true if the user wants to prevent the event from</tt> </tt> +<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> continuing down the queue</tt> </tt> +<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> +<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> +</div><a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> </tt> +<a name="GameEngineElement.draw"></a><div id="GameEngineElement.draw-def"><a name="L103"></a><tt class="py-lineno">103</tt> <a class="py-toggle" href="#" id="GameEngineElement.draw-toggle" onclick="return toggle('GameEngineElement.draw');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="fortuneengine.GameEngineElement.GameEngineElement-class.html#draw">draw</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">screen</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> +</div><div id="GameEngineElement.draw-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="GameEngineElement.draw-expanded"><a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> +<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> This method should be overridden by the user-specified class that</tt> </tt> +<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"> extends this GameEngineElement class. This method specifies how the</tt> </tt> +<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-docstring"> class will be drawn.</tt> </tt> +<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> +<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> +</div></div><a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"> </tt><script type="text/javascript"> +<!-- +expandto(location.href); +// --> +</script> +</pre> +<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> |