Anda di halaman 1dari 22

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.

org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>sge.StellarClass &mdash; The Pygame SGE 0.8.0 documentation</title> <link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '', VERSION: '0.8.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <link rel="top" title="The Pygame SGE 0.8.0 documentation" href="index.html" /> <link rel="up" title="Classes" href="classes.html" /> <link rel="next" title="sge.Room" href="Room.html" /> <link rel="prev" title="sge.Font" href="Font.html" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="Room.html" title="sge.Room" accesskey="N">next</a> |</li> <li class="right" > <a href="Font.html" title="sge.Font" accesskey="P">previous</a> |</li> <li><a href="index.html">The Pygame SGE 0.8.0 documentation</a> &raquo;< /li> <li><a href="classes.html" accesskey="U">Classes</a> &raquo;</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="sge-stellarclass"> <h1>sge.StellarClass<a class="headerlink" href="#sge-stellarclass" title="Permal ink to this headline"></a></h1>

<dl class="class"> <dt id="sge.StellarClass"> <em class="property">class </em><tt class="descclassname">sge.</tt><tt class="de scname">StellarClass</tt><big>(</big><em>x</em>, <em>y</em>, <em>z=0</em>, <em>I D=None</em>, <em>sprite=None</em>, <em>visible=True</em>, <em>active=True</em>, <em>detects_collisions=True</em>, <em>bbox_x=None</em>, <em>bbox_y=None</em>, <e m>bbox_width=None</em>, <em>bbox_height=None</em>, <em>collision_ellipse=False</ em>, <em>collision_precise=False</em>, <em>xvelocity=0</em>, <em>yvelocity=0</em >, <em>image_index=0</em>, <em>image_fps=None</em>, <em>image_xscale=1</em>, <em >image_yscale=1</em>, <em>image_rotation=0</em>, <em>image_alpha=255</em>, <em>i mage_blend=None</em><big>)</big><a class="headerlink" href="#sge.StellarClass" t itle="Permalink to this definition"></a></dt> <dd><p>Class for game objects.</p> <p>This class is used for game objects, such as the player, enemies, bullets, and the HUD. Generally, each type of object has its own subclass of <a class="reference internal" href="#sge.StellarClass" title="sge.St ellarClass"><tt class="xref py py-class docutils literal"><span class="pre">sge. StellarClass</span></tt></a>.</p> <dl class="attribute"> <dt id="StellarClass.x"> <tt class="descname">x</tt><a class="headerlink" href="#StellarClass.x" title="P ermalink to this definition"></a></dt> <dd><p>The horizontal position of the object in the room.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.y"> <tt class="descname">y</tt><a class="headerlink" href="#StellarClass.y" title="P ermalink to this definition"></a></dt> <dd><p>The vertical position of the object in the room.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.z"> <tt class="descname">z</tt><a class="headerlink" href="#StellarClass.z" title="P ermalink to this definition"></a></dt> <dd><p>The Z-axis position of the object in the room.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.sprite"> <tt class="descname">sprite</tt><a class="headerlink" href="#StellarClass.sprite " title="Permalink to this definition"></a></dt> <dd><p>The sprite currently in use by this object. Set to <tt class="xref py py -const docutils literal"><span class="pre">None</span></tt> for no sprite.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.visible"> <tt class="descname">visible</tt><a class="headerlink" href="#StellarClass.visib le" title="Permalink to this definition"></a></dt> <dd><p>Whether or not the object&#8217;s sprite should be projected onto the screen.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.active"> <tt class="descname">active</tt><a class="headerlink" href="#StellarClass.active " title="Permalink to this definition"></a></dt>

<dd><p>Indicates whether the object is active (<tt class="xref py py-const docut ils literal"><span class="pre">True</span></tt>) or inactive (<tt class="xref py py-const docutils literal"><span class="pre">False< /span></tt>). While the object is active, it will exhibit normal behavior; events will be executed normally as will any other automatic functionality, such as adding <a class="reference internal" href="#StellarClass.xvelocity" title="StellarClass .xvelocity"><tt class="xref py py-attr docutils literal"><span class="pre">xvelo city</span></tt></a> and <a class="reference internal" href="#StellarClass.yvelo city" title="StellarClass.yvelocity"><tt class="xref py py-attr docutils literal "><span class="pre">yvelocity</span></tt></a> to <a class="reference internal" href="#StellarClass.x" title="StellarClass.x">< tt class="xref py py-attr docutils literal"><span class="pre">x</span></tt></a> and <a class="reference internal" href="#StellarClass.y" title="StellarClass.y"> <tt class="xref py py-attr docutils literal"><span class="pre">y</span></tt></a> . If <a class="reference internal" href="#StellarClass.active" title="StellarCl ass.active"><tt class="xref py py-attr docutils literal"><span class="pre">activ e</span></tt></a> is <tt class="xref py py-const docutils literal"><span class=" pre">False</span></tt>, automatic functionality and normal events will be disabled and events which have names starting with <tt class="docutils literal"><span class=" pre">event_inactive_</span></tt> will be executed instead of the corresponding normal events.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Inactive <a class="reference internal" href="#sge.StellarClass" title="sge.StellarClass"><tt class="xref py py-class docutils literal"><span cla ss="pre">sge.StellarClass</span></tt></a> objects are still visible by default and continue to be involved in collisions. In addition, collision events and destroy events still occur even if the object is inactive. If you wish for the object to not be visible, set <a class="reference internal" href="#StellarClass.visible" title ="StellarClass.visible"><tt class="xref py py-attr docutils literal"><span class ="pre">visible</span></tt></a> to <tt class="xref py py-const docutils literal"> <span class="pre">False</span></tt>. If you wish for the object to not be involved in collisions, set <a class="reference internal" href="#StellarClass.detects_collisions" title="Ste llarClass.detects_collisions"><tt class="xref py py-attr docutils literal"><span class="pre">detects_collisions</span></tt></a> to <tt class="xref py py-const d ocutils literal"><span class="pre">False</span></tt>.</p> </div> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Making an object inactive will not likely have a significant effect on performance. For performance enhancement, it is far more effective to exclude objects from collision detection. Object deactivation is meant to be used to easily maintain control over objects that are currently being excluded from collision detection (e.g. to prevent a gravity effect that would otherwise occur, or to prevent the object from moving through walls).</p> </div> </dd></dl> <dl class="attribute"> <dt id="StellarClass.detects_collisions"> <tt class="descname">detects_collisions</tt><a class="headerlink" href="#Stellar Class.detects_collisions" title="Permalink to this definition"></a></dt> <dd><p>Whether or not the object should be involved in collision detection. Setting this to <tt class="xref py py-const docutils literal"><span

class="pre">False</span></tt> can improve performance if the object doesn&#8217;t need to detect collisions.</p> <p>Depending on the game, a useful strategy to boost performance can be to exclude an object from collision detection while it is outside the view. If you do this, you likely also to set <a class="reference internal" href="#StellarClass.active" title="StellarClass.ac tive"><tt class="xref py py-attr docutils literal"><span class="pre">active</spa n></tt></a> to <tt class="xref py py-const docutils literal"><span class="pre">F alse</span></tt> as well so that the object doesn&#8217;t move in undesireable ways (e.g. through walls).</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.bbox_x"> <tt class="descname">bbox_x</tt><a class="headerlink" href="#StellarClass.bbox_x " title="Permalink to this definition"></a></dt> <dd><p>The horizontal location of the bounding box relative to the object&#8217;s position. If set to <tt class="xref py py-const docutils literal "><span class="pre">None</span></tt>, the value recommended by the sprite is used.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.bbox_y"> <tt class="descname">bbox_y</tt><a class="headerlink" href="#StellarClass.bbox_y " title="Permalink to this definition"></a></dt> <dd><p>The vertical location of the bounding box relative to the object&#8217;s position. If set to <tt class="xref py py-const docutils literal "><span class="pre">None</span></tt>, the value recommended by the sprite is used.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.bbox_width"> <tt class="descname">bbox_width</tt><a class="headerlink" href="#StellarClass.bb ox_width" title="Permalink to this definition"></a></dt> <dd><p>The width of the bounding box in pixels. If set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> , the value recommended by the sprite is used.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.bbox_height"> <tt class="descname">bbox_height</tt><a class="headerlink" href="#StellarClass.b box_height" title="Permalink to this definition"></a></dt> <dd><p>The height of the bounding box in pixels. If set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> , the value recommended by the sprite is used.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.collision_ellipse"> <tt class="descname">collision_ellipse</tt><a class="headerlink" href="#StellarC lass.collision_ellipse" title="Permalink to this definition"></a></dt> <dd><p>Whether or not an ellipse (rather than a rectangle) should be used for collision detection.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.collision_precise">

<tt class="descname">collision_precise</tt><a class="headerlink" href="#StellarC lass.collision_precise" title="Permalink to this definition"></a></dt> <dd><p>Whether or not precise (pixel-perfect) collision detection should be used. Note that this can be inefficient and does not work well with animated sprites.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.bbox_left"> <tt class="descname">bbox_left</tt><a class="headerlink" href="#StellarClass.bbo x_left" title="Permalink to this definition"></a></dt> <dd><p>The position of the left side of the bounding box in the room (same as <a class="reference internal" href="#StellarClass.x" title="StellarClas s.x"><tt class="xref py py-attr docutils literal"><span class="pre">x</span></tt ></a> + <a class="reference internal" href="#StellarClass.bbox_x" title="Stellar Class.bbox_x"><tt class="xref py py-attr docutils literal"><span class="pre">bbo x_x</span></tt></a>).</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.bbox_right"> <tt class="descname">bbox_right</tt><a class="headerlink" href="#StellarClass.bb ox_right" title="Permalink to this definition"></a></dt> <dd><p>The position of the right side of the bounding box in the room (same as <a class="reference internal" href="#StellarClass.bbox_left" title="Ste llarClass.bbox_left"><tt class="xref py py-attr docutils literal"><span class="p re">bbox_left</span></tt></a> + <a class="reference internal" href="#StellarClas s.bbox_width" title="StellarClass.bbox_width"><tt class="xref py py-attr docutil s literal"><span class="pre">bbox_width</span></tt></a>).</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.bbox_top"> <tt class="descname">bbox_top</tt><a class="headerlink" href="#StellarClass.bbox _top" title="Permalink to this definition"></a></dt> <dd><p>The position of the top side of the bounding box in the room (same as <a class="reference internal" href="#StellarClass.y" title="StellarClas s.y"><tt class="xref py py-attr docutils literal"><span class="pre">y</span></tt ></a> + <a class="reference internal" href="#StellarClass.bbox_y" title="Stellar Class.bbox_y"><tt class="xref py py-attr docutils literal"><span class="pre">bbo x_y</span></tt></a>).</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.bbox_bottom"> <tt class="descname">bbox_bottom</tt><a class="headerlink" href="#StellarClass.b box_bottom" title="Permalink to this definition"></a></dt> <dd><p>The position of the bottom side of the bounding box in the room (same as <a class="reference internal" href="#StellarClass.bbox_top" title="Stel larClass.bbox_top"><tt class="xref py py-attr docutils literal"><span class="pre ">bbox_top</span></tt></a> + <a class="reference internal" href="#StellarClass.b box_height" title="StellarClass.bbox_height"><tt class="xref py py-attr docutils literal"><span class="pre">bbox_height</span></tt></a>).</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.xvelocity"> <tt class="descname">xvelocity</tt><a class="headerlink" href="#StellarClass.xve locity" title="Permalink to this definition"></a></dt> <dd><p>The velocity of the object toward the right.</p>

</dd></dl> <dl class="attribute"> <dt id="StellarClass.yvelocity"> <tt class="descname">yvelocity</tt><a class="headerlink" href="#StellarClass.yve locity" title="Permalink to this definition"></a></dt> <dd><p>The velocity of the object toward the bottom.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.speed"> <tt class="descname">speed</tt><a class="headerlink" href="#StellarClass.speed" title="Permalink to this definition"></a></dt> <dd><p>The total (directional) speed of the object.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.move_direction"> <tt class="descname">move_direction</tt><a class="headerlink" href="#StellarClas s.move_direction" title="Permalink to this definition"></a></dt> <dd><p>The direction of the object&#8217;s movement in degrees, with <tt class=" docutils literal"><span class="pre">0</span></tt> being directly to the right and rotation in a positive direction being counter-clockwise.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.image_index"> <tt class="descname">image_index</tt><a class="headerlink" href="#StellarClass.i mage_index" title="Permalink to this definition"></a></dt> <dd><p>The animation frame currently being displayed, with <tt class="docutils l iteral"><span class="pre">0</span></tt> being the first one.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.image_fps"> <tt class="descname">image_fps</tt><a class="headerlink" href="#StellarClass.ima ge_fps" title="Permalink to this definition"></a></dt> <dd><p>The animation rate in frames per second. If set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> , the value recommended by the sprite is used.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.image_speed"> <tt class="descname">image_speed</tt><a class="headerlink" href="#StellarClass.i mage_speed" title="Permalink to this definition"></a></dt> <dd><p>The animation rate as a factor of <tt class="xref py py-attr docutils lit eral"><span class="pre">sge.game.fps</span></tt>. If set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></ tt>, the value recommended by the sprite is used.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.image_xscale"> <tt class="descname">image_xscale</tt><a class="headerlink" href="#StellarClass. image_xscale" title="Permalink to this definition"></a></dt> <dd><p>The horizontal scale factor for the sprite.</p> </dd></dl>

<dl class="attribute"> <dt id="StellarClass.image_yscale"> <tt class="descname">image_yscale</tt><a class="headerlink" href="#StellarClass. image_yscale" title="Permalink to this definition"></a></dt> <dd><p>The vertical scale factor for the sprite.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.image_rotation"> <tt class="descname">image_rotation</tt><a class="headerlink" href="#StellarClas s.image_rotation" title="Permalink to this definition"></a></dt> <dd><p>The rotation of the sprite in degrees, with rotation in a positive direction being counter-clockwise.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.image_alpha"> <tt class="descname">image_alpha</tt><a class="headerlink" href="#StellarClass.i mage_alpha" title="Permalink to this definition"></a></dt> <dd><p>The alpha value applied to the entire image, where <tt class="docutils li teral"><span class="pre">255</span></tt> is the original image, <tt class="docutils literal"><span class="pre">128</span></tt> i s half the opacity of the original image, <tt class="docutils literal"><span class="pre">0</span></tt> is fully tra nsparent, etc.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.image_blend"> <tt class="descname">image_blend</tt><a class="headerlink" href="#StellarClass.i mage_blend" title="Permalink to this definition"></a></dt> <dd><p>The color to blend with the sprite. Set to <tt class="xref py py-const d ocutils literal"><span class="pre">None</span></tt> for no color blending.</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.id"> <tt class="descname">id</tt><a class="headerlink" href="#StellarClass.id" title= "Permalink to this definition"></a></dt> <dd><p>The unique identifier for this object. (Read-only)</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.xstart"> <tt class="descname">xstart</tt><a class="headerlink" href="#StellarClass.xstart " title="Permalink to this definition"></a></dt> <dd><p>The initial value of <a class="reference internal" href="#StellarClass.x" title="StellarClass.x"><tt class="xref py py-attr docutils literal"><span class ="pre">x</span></tt></a> when the object was created. (Read-only)</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.ystart"> <tt class="descname">ystart</tt><a class="headerlink" href="#StellarClass.ystart " title="Permalink to this definition"></a></dt> <dd><p>The initial value of <a class="reference internal" href="#StellarClass.y" title="StellarClass.y"><tt class="xref py py-attr docutils literal"><span class

="pre">y</span></tt></a> when the object was created. (Read-only)</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.xprevious"> <tt class="descname">xprevious</tt><a class="headerlink" href="#StellarClass.xpr evious" title="Permalink to this definition"></a></dt> <dd><p>The value of <a class="reference internal" href="#StellarClass.x" title=" StellarClass.x"><tt class="xref py py-attr docutils literal"><span class="pre">x </span></tt></a> at the end of the previous frame. (Read-only)</p> </dd></dl> <dl class="attribute"> <dt id="StellarClass.yprevious"> <tt class="descname">yprevious</tt><a class="headerlink" href="#StellarClass.ypr evious" title="Permalink to this definition"></a></dt> <dd><p>The value of <a class="reference internal" href="#StellarClass.y" title=" StellarClass.y"><tt class="xref py py-attr docutils literal"><span class="pre">y </span></tt></a> at the end of the previous frame. (Read-only)</p> </dd></dl> </dd></dl> <div class="section" id="sge-stellarclass-methods"> <h2>sge.StellarClass Methods<a class="headerlink" href="#sge-stellarclass-method s" title="Permalink to this headline"></a></h2> <dl class="method"> <dt id="sge.StellarClass.__init__"> <tt class="descclassname">StellarClass.</tt><tt class="descname">__init__</tt><b ig>(</big><em>x</em>, <em>y</em>, <em>z=0</em>, <em>ID=None</em>, <em>sprite=Non e</em>, <em>visible=True</em>, <em>active=True</em>, <em>detects_collisions=True </em>, <em>bbox_x=None</em>, <em>bbox_y=None</em>, <em>bbox_width=None</em>, <em >bbox_height=None</em>, <em>collision_ellipse=False</em>, <em>collision_precise= False</em>, <em>xvelocity=0</em>, <em>yvelocity=0</em>, <em>image_index=0</em>, <em>image_fps=None</em>, <em>image_xscale=1</em>, <em>image_yscale=1</em>, <em>i mage_rotation=0</em>, <em>image_alpha=255</em>, <em>image_blend=None</em><big>)< /big><a class="headerlink" href="#sge.StellarClass.__init__" title="Permalink to this definition"></a></dt> <dd><p>Constructor method.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">ID</span></tt> &#8211; The va lue to set <a class="reference internal" href="#StellarClass.id" title="StellarC lass.id"><tt class="xref py py-attr docutils literal"><span class="pre">id</span ></tt></a> to. If set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> , <tt class="docutils literal"><span class="pre">fname</span></tt> minus the ext ension will be used, modified by the SGE if it is already the unique identifier of another music object.</li> </ul> <p>All other arugments set the respective initial attributes of the object. See the documentation for <a class="reference internal" href="#sge.Stel larClass" title="sge.StellarClass"><tt class="xref py py-class docutils literal" ><span class="pre">sge.StellarClass</span></tt></a> for more information.</p> </dd></dl>

<dl class="method"> <dt id="sge.StellarClass.collides"> <tt class="descclassname">StellarClass.</tt><tt class="descname">collides</tt><b ig>(</big><em>other</em>, <em>x=None</em>, <em>y=None</em><big>)</big><a class=" headerlink" href="#sge.StellarClass.collides" title="Permalink to this definitio n"></a></dt> <dd><p>Return whether or not this object collides with another.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">other</span></tt> &#8211; The object to check for a collision with, or the unique identifier of said object. <tt class="docutils literal"><span class="pre ">other</span></tt> can also be a class to check for collisions with.</li> <li><tt class="docutils literal"><span class="pre">x</span></tt> &#8211; The hor izontal position to pretend this object is at for the purpose of the collision detection. If set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> , <a class="reference internal" href="#StellarClass.x" title="StellarClass.x"><t t class="xref py py-attr docutils literal"><span class="pre">x</span></tt></a> w ill be used.</li> <li><tt class="docutils literal"><span class="pre">y</span></tt> &#8211; The ver tical position to pretend this object is at for the purpose of the collision detection. If set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> , <a class="reference internal" href="#StellarClass.y" title="StellarClass.y"><t t class="xref py py-attr docutils literal"><span class="pre">y</span></tt></a> w ill be used.</li> </ul> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.set_alarm"> <tt class="descclassname">StellarClass.</tt><tt class="descname">set_alarm</tt>< big>(</big><em>alarm_id</em>, <em>value</em><big>)</big><a class="headerlink" hr ef="#sge.StellarClass.set_alarm" title="Permalink to this definition"></a></dt> <dd><p>Set an alarm.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">alarm_id</span></tt> &#8211; The unique identifier of the alarm to set. Any value can be used as a unique identifier for an alarm.</li> <li><tt class="docutils literal"><span class="pre">value</span></tt> &#8211; The value to set the alarm to. Set to <tt class="xref py py-const docutils literal"><span class="pre">None</span></tt> to disable the alarm.</li> </ul> <p>After this method is called, <tt class="docutils literal"><span class="pre">v alue</span></tt> will reduce by 1 each frame (adjusted for delta timing if it is enabled) until it reaches 0, at which point <a class="reference internal" href="#sge.StellarClass. event_alarm" title="sge.StellarClass.event_alarm"><tt class="xref py py-meth doc utils literal"><span class="pre">sge.StellarClass.event_alarm()</span></tt></a> will be executed with <tt class="docutils literal"><span class="pre">alarm_id</s pan></tt>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.get_alarm">

<tt class="descclassname">StellarClass.</tt><tt class="descname">get_alarm</tt>< big>(</big><em>alarm_id</em><big>)</big><a class="headerlink" href="#sge.Stellar Class.get_alarm" title="Permalink to this definition"></a></dt> <dd><p>Return the value of an alarm.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">alarm_id</span></tt> &#8211; The unique identifier of the alarm to check.</li> </ul> <p>If the alarm has not been set, <tt class="xref py py-const docutils literal"> <span class="pre">None</span></tt> will be returned.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.destroy"> <tt class="descclassname">StellarClass.</tt><tt class="descname">destroy</tt><bi g>(</big><big>)</big><a class="headerlink" href="#sge.StellarClass.destroy" titl e="Permalink to this definition"></a></dt> <dd><p>Destroy the object.</p> </dd></dl> <dl class="classmethod"> <dt id="sge.StellarClass.create"> <em class="property">classmethod </em><tt class="descclassname">StellarClass.</t t><tt class="descname">create</tt><big>(</big><em>*args</em>, <em>**kwargs</em>< big>)</big><a class="headerlink" href="#sge.StellarClass.create" title="Permalin k to this definition"></a></dt> <dd><p>Create an object of this class in the current room.</p> <p><tt class="docutils literal"><span class="pre">args</span></tt> and <tt class ="docutils literal"><span class="pre">kwargs</span></tt> are passed to the const ructor method of <tt class="docutils literal"><span class="pre">cls</span></tt> as arguments. Ca lling <tt class="docutils literal"><span class="pre">obj</span> <span class="pre">=</s pan> <span class="pre">cls.create(*args,</span> <span class="pre">**kwargs)</spa n></tt> is the same as:</p> <div class="highlight-python"><div class="highlight"><pre><span class="n">obj</s pan> <span class="o">=</span> <span class="n">cls</span><span class="p">(</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <spa n class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="n">sge</span><span class="o">.</span><span class="n">game</span><sp an class="o">.</span><span class="n">current_room</span><span class="o">.</span> <span class="n">add</span><span class="p">(</span><span class="n">obj</span><spa n class="p">)</span> </pre></div> </div> </dd></dl> </div> <div class="section" id="sge-stellarclass-event-methods"> <h2>sge.StellarClass Event Methods<a class="headerlink" href="#sge-stellarclassevent-methods" title="Permalink to this headline"></a></h2> <dl class="method"> <dt id="sge.StellarClass.event_create"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_create</t t><big>(</big><big>)</big><a class="headerlink" href="#sge.StellarClass.event_cr eate" title="Permalink to this definition"></a></dt> <dd><p>Create event.</p> <p>Called when the object is created. It is always called after any room start events occurring at the same time.</p>

</dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_destroy"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_destroy</ tt><big>(</big><big>)</big><a class="headerlink" href="#sge.StellarClass.event_d estroy" title="Permalink to this definition"></a></dt> <dd><p>Destroy event.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_step"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_step</tt> <big>(</big><em>time_passed</em><big>)</big><a class="headerlink" href="#sge.Ste llarClass.event_step" title="Permalink to this definition"></a></dt> <dd><p>Step event.</p> <p>This event is executed each frame after automatic updates to objects (such as the effects of the speed variables), but before collision events.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_step" title="sge.Game.event_step"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_step()</span></tt></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_alarm"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_alarm</tt ><big>(</big><em>alarm_id</em><big>)</big><a class="headerlink" href="#sge.Stell arClass.event_alarm" title="Permalink to this definition"></a></dt> <dd><p>Alarm event.</p> <p>Called when the value of an alarm reaches 0.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">alarm_id</span></tt> &#8211; The unique identifier of the alarm which was set off.</li> </ul> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_animation_end"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_animation _end</tt><big>(</big><big>)</big><a class="headerlink" href="#sge.StellarClass.e vent_animation_end" title="Permalink to this definition"></a></dt> <dd><p>Animation End event.</p> <p>Called when an animation cycle ends.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_key_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_key_press </tt><big>(</big><em>key</em>, <em>char</em><big>)</big><a class="headerlink" hr ef="#sge.StellarClass.event_key_press" title="Permalink to this definition"></a>< /dt> <dd><p>Key press event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_key_press" title="sge.Game.event_key_press"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_key_press()</span></tt></a> for

more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_key_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_key_relea se</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#sge.Stel larClass.event_key_release" title="Permalink to this definition"></a></dt> <dd><p>Key release event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_key_release" title="sge.Game.event_key_release"><tt class="xref py pymeth docutils literal"><span class="pre">sge.Game.event_key_release()</span></tt ></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_mouse_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_mouse_mov e</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href=" #sge.StellarClass.event_mouse_move" title="Permalink to this definition"></a></dt > <dd><p>Mouse move event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_mouse_move" title="sge.Game.event_mouse_move"><tt class="xref py py-me th docutils literal"><span class="pre">sge.Game.event_mouse_move()</span></tt></ a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_mouse_button_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_mouse_but ton_press</tt><big>(</big><em>button</em><big>)</big><a class="headerlink" href= "#sge.StellarClass.event_mouse_button_press" title="Permalink to this definition "></a></dt> <dd><p>Mouse button press event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_mouse_button_press" title="sge.Game.event_mouse_button_press"><tt class="xref py py-meth docutils l iteral"><span class="pre">sge.Game.event_mouse_button_press()</span></tt></a> fo r more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_mouse_button_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_mouse_but ton_release</tt><big>(</big><em>button</em><big>)</big><a class="headerlink" hre f="#sge.StellarClass.event_mouse_button_release" title="Permalink to this defini tion"></a></dt> <dd><p>Mouse button release event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_mouse_button_releas e" title="sge.Game.event_mouse_button_release"><tt class="xref py py-meth docuti ls literal"><span class="pre">sge.Game.event_mouse_button_release()</span></tt>< /a> for more information.</p> </dd></dl> <dl class="method">

<dt id="sge.StellarClass.event_joystick_axis_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_joystick_ axis_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>axis</em>, <em>value</ em><big>)</big><a class="headerlink" href="#sge.StellarClass.event_joystick_axis _move" title="Permalink to this definition"></a></dt> <dd><p>Joystick axis move event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_axis_move" title="sge.Game.event_joystick_axis_move"><tt class="xref py py-meth docutils l iteral"><span class="pre">sge.Game.event_joystick_axis_move()</span></tt></a> fo r more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_joystick_hat_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_joystick_ hat_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>hat</em>, <em>x</em>, < em>y</em><big>)</big><a class="headerlink" href="#sge.StellarClass.event_joystic k_hat_move" title="Permalink to this definition"></a></dt> <dd><p>Joystick HAT move event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_hat_move" title="sge.Game.event_joystick_hat_move"><tt class="xref py py-meth docutils lit eral"><span class="pre">sge.Game.event_joystick_hat_move()</span></tt></a> for m ore information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_joystick_trackball_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_joystick_ trackball_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>ball</em>, <em>x< /em>, <em>y</em><big>)</big><a class="headerlink" href="#sge.StellarClass.event_ joystick_trackball_move" title="Permalink to this definition"></a></dt> <dd><p>Joystick trackball move event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_trackball_ move" title="sge.Game.event_joystick_trackball_move"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_joystick_trackball_move()</sp an></tt></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_joystick_button_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_joystick_ button_press</tt><big>(</big><em>name</em>, <em>ID</em>, <em>button</em><big>)</ big><a class="headerlink" href="#sge.StellarClass.event_joystick_button_press" t itle="Permalink to this definition"></a></dt> <dd><p>Joystick button press event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_button_pre ss" title="sge.Game.event_joystick_button_press"><tt class="xref py py-meth docu tils literal"><span class="pre">sge.Game.event_joystick_button_press()</span></t t></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_joystick_button_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_joystick_

button_release</tt><big>(</big><em>name</em>, <em>ID</em>, <em>button</em><big>) </big><a class="headerlink" href="#sge.StellarClass.event_joystick_button_releas e" title="Permalink to this definition"></a></dt> <dd><p>Joystick button release event.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_button_rel ease" title="sge.Game.event_joystick_button_release"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_joystick_button_release()</sp an></tt></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_collision"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_collision </tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#sge.Stel larClass.event_collision" title="Permalink to this definition"></a></dt> <dd><p>Default collision event.</p> <p>Called when another object collides with this object and none of the directional collision events are appropriate. In particular, this is called if the collision was already happening in the previous frame. This is also the event method called by the directional collision event methods by default.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">other</span></tt> &#8211; The other object which was collided with.</li> </ul> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_collision_left"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_collision _left</tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#sge .StellarClass.event_collision_left" title="Permalink to this definition"></a></dt > <dd><p>Left collision event.</p> <p>Called when another object collides with this object&#8217;s left side.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">other</span></tt> &#8211; The other object which was collided with.</li> </ul> <p>By default, this method simply calls <a class="reference internal" href="#sge.StellarClass.event_collision" title="sg e.StellarClass.event_collision"><tt class="xref py py-meth docutils literal"><sp an class="pre">sge.StellarClass.event_collision()</span></tt></a>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_collision_right"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_collision _right</tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#sg e.StellarClass.event_collision_right" title="Permalink to this definition"></a></ dt> <dd><p>Right collision event.</p> <p>Called when another object collides with this object&#8217;s right side.</p> <p>Arguments:</p>

<ul class="simple"> <li><tt class="docutils literal"><span class="pre">other</span></tt> &#8211; The other object which was collided with.</li> </ul> <p>By default, this method simply calls <a class="reference internal" href="#sge.StellarClass.event_collision" title="sg e.StellarClass.event_collision"><tt class="xref py py-meth docutils literal"><sp an class="pre">sge.StellarClass.event_collision()</span></tt></a>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_collision_top"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_collision _top</tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#sge. StellarClass.event_collision_top" title="Permalink to this definition"></a></dt> <dd><p>Top collision event.</p> <p>Called when another object collides with this object&#8217;s top side.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">other</span></tt> &#8211; The other object which was collided with.</li> </ul> <p>By default, this method simply calls <a class="reference internal" href="#sge.StellarClass.event_collision" title="sg e.StellarClass.event_collision"><tt class="xref py py-meth docutils literal"><sp an class="pre">sge.StellarClass.event_collision()</span></tt></a>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_collision_bottom"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_collision _bottom</tt><big>(</big><em>other</em><big>)</big><a class="headerlink" href="#s ge.StellarClass.event_collision_bottom" title="Permalink to this definition"></a> </dt> <dd><p>Bottom collision event.</p> <p>Called when another object collides with this object&#8217;s bottom side.</p> <p>Arguments:</p> <ul class="simple"> <li><tt class="docutils literal"><span class="pre">other</span></tt> &#8211; The other object which was collided with.</li> </ul> <p>By default, this method simply calls <a class="reference internal" href="#sge.StellarClass.event_collision" title="sg e.StellarClass.event_collision"><tt class="xref py py-meth docutils literal"><sp an class="pre">sge.StellarClass.event_collision()</span></tt></a>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_step"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ step</tt><big>(</big><em>time_passed</em><big>)</big><a class="headerlink" href= "#sge.StellarClass.event_inactive_step" title="Permalink to this definition"></a> </dt> <dd><p>Step event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="#sge.StellarCla ss.event_step" title="sge.StellarClass.event_step"><tt class="xref py py-meth do cutils literal"><span class="pre">sge.StellarClass.event_step()</span></tt></a> for more information. The object is considered to be inactive when <a class="reference internal" href="#StellarClass.active" title="StellarCla

ss.active"><tt class="xref py py-attr docutils literal"><span class="pre">active </span></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pr e">False</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_key_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ key_press</tt><big>(</big><em>key</em>, <em>char</em><big>)</big><a class="heade rlink" href="#sge.StellarClass.event_inactive_key_press" title="Permalink to thi s definition"></a></dt> <dd><p>Key press event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_key_press" title="sge.Game.event_key_press"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_key_press()</span></tt></a> for more information. The object is considered to be inactive when <a class="reference internal" href="#StellarClass.active" title="StellarClass.ac tive"><tt class="xref py py-attr docutils literal"><span class="pre">active</spa n></tt></a> is <tt class="xref py py-const docutils literal"><span class="pre">F alse</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_key_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ key_release</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href=" #sge.StellarClass.event_inactive_key_release" title="Permalink to this definitio n"></a></dt> <dd><p>Key release event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_key_release" title="sge.Game.event_key_release"><tt class="xref py pymeth docutils literal"><span class="pre">sge.Game.event_key_release()</span></tt ></a> for more information. The object is considered to be inactive when <a class="reference internal" href="#StellarClass.active" title="StellarClass.ac tive"><tt class="xref py py-attr docutils literal"><span class="pre">active</spa n></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">Fa lse</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_mouse_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ mouse_move</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlin k" href="#sge.StellarClass.event_inactive_mouse_move" title="Permalink to this d efinition"></a></dt> <dd><p>Mouse move event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_mouse_move" title="sge.Game.event_mouse_move"><tt class="xref py py-me th docutils literal"><span class="pre">sge.Game.event_mouse_move()</span></tt></ a> for more information. The object is considered to be inactive when <a class="reference internal" href="#StellarClass.active" title="StellarClass.ac tive"><tt class="xref py py-attr docutils literal"><span class="pre">active</spa n></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">Fa lse</span></tt>.</p> </dd></dl> <dl class="method">

<dt id="sge.StellarClass.event_inactive_mouse_button_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ mouse_button_press</tt><big>(</big><em>button</em><big>)</big><a class="headerli nk" href="#sge.StellarClass.event_inactive_mouse_button_press" title="Permalink to this definition"></a></dt> <dd><p>Mouse button press event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_mouse_button_press" title="sge.Game.event_mouse_button_press"><tt class="xref py py-meth docutils l iteral"><span class="pre">sge.Game.event_mouse_button_press()</span></tt></a> fo r more information. The object is considered to be inactive when <a class="reference internal" href= "#StellarClass.active" title="StellarClass.active"><tt class="xref py py-attr do cutils literal"><span class="pre">active</span></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">False</span></tt> .</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_mouse_button_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ mouse_button_release</tt><big>(</big><em>button</em><big>)</big><a class="header link" href="#sge.StellarClass.event_inactive_mouse_button_release" title="Permal ink to this definition"></a></dt> <dd><p>Mouse button release event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_mouse_button_releas e" title="sge.Game.event_mouse_button_release"><tt class="xref py py-meth docuti ls literal"><span class="pre">sge.Game.event_mouse_button_release()</span></tt>< /a> for more information. The object is considered to be inactive when <a class="reference internal" href="#StellarClass.active" title="StellarClass.ac tive"><tt class="xref py py-attr docutils literal"><span class="pre">active</spa n></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">Fa lse</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_joystick_axis_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ joystick_axis_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>axis</em>, <e m>value</em><big>)</big><a class="headerlink" href="#sge.StellarClass.event_inac tive_joystick_axis_move" title="Permalink to this definition"></a></dt> <dd><p>Joystick axis move event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_axis_move" title="sge.Game.event_joystick_axis_move"><tt class="xref py py-meth docutils l iteral"><span class="pre">sge.Game.event_joystick_axis_move()</span></tt></a> fo r more information. The object is considered to be inactive when <a class="reference internal" href= "#StellarClass.active" title="StellarClass.active"><tt class="xref py py-attr do cutils literal"><span class="pre">active</span></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">False</span></tt> .</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_joystick_hat_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ joystick_hat_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>hat</em>, <em>

x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sge.StellarClass.even t_inactive_joystick_hat_move" title="Permalink to this definition"></a></dt> <dd><p>Joystick HAT move event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_hat_move" title="sge.Game.event_joystick_hat_move"><tt class="xref py py-meth docutils lit eral"><span class="pre">sge.Game.event_joystick_hat_move()</span></tt></a> for m ore information. The object is considered to be inactive when <a class="reference internal" href= "#StellarClass.active" title="StellarClass.active"><tt class="xref py py-attr do cutils literal"><span class="pre">active</span></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">False</span></tt> .</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_joystick_trackball_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ joystick_trackball_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>ball</em >, <em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sge.StellarCla ss.event_inactive_joystick_trackball_move" title="Permalink to this definition">< /a></dt> <dd><p>Joystick trackball move event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_trackball_ move" title="sge.Game.event_joystick_trackball_move"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_joystick_trackball_move()</sp an></tt></a> for more information. The object is considered to be inactive when <a class="reference internal" href="#StellarClass.active" title="StellarClass.ac tive"><tt class="xref py py-attr docutils literal"><span class="pre">active</spa n></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">Fa lse</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_joystick_button_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ joystick_button_press</tt><big>(</big><em>name</em>, <em>ID</em>, <em>button</em ><big>)</big><a class="headerlink" href="#sge.StellarClass.event_inactive_joysti ck_button_press" title="Permalink to this definition"></a></dt> <dd><p>Joystick button press event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_button_pre ss" title="sge.Game.event_joystick_button_press"><tt class="xref py py-meth docu tils literal"><span class="pre">sge.Game.event_joystick_button_press()</span></t t></a> for more information. The object is considered to be inactive when <a class="reference internal" href="#StellarClass.active" title="StellarClass.ac tive"><tt class="xref py py-attr docutils literal"><span class="pre">active</spa n></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">Fa lse</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_inactive_joystick_button_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_inactive_ joystick_button_release</tt><big>(</big><em>name</em>, <em>ID</em>, <em>button</ em><big>)</big><a class="headerlink" href="#sge.StellarClass.event_inactive_joys tick_button_release" title="Permalink to this definition"></a></dt>

<dd><p>Joystick button release event when this object is inactive.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_button_rel ease" title="sge.Game.event_joystick_button_release"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_joystick_button_release()</sp an></tt></a> for more information. The object is considered to be inactive when <a class="reference internal" href="#StellarClass.active" title="StellarClass.ac tive"><tt class="xref py py-attr docutils literal"><span class="pre">active</spa n></tt></a> is <tt class="xref py py-attr docutils literal"><span class="pre">Fa lse</span></tt>.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_key_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_ke y_press</tt><big>(</big><em>key</em>, <em>char</em><big>)</big><a class="headerl ink" href="#sge.StellarClass.event_paused_key_press" title="Permalink to this de finition"></a></dt> <dd><p>Key press event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_key_press" title="sge.Game.event_key_press"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_key_press()</span></tt></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_key_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_ke y_release</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#s ge.StellarClass.event_paused_key_release" title="Permalink to this definition"></ a></dt> <dd><p>Key release event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_key_release" title="sge.Game.event_key_release"><tt class="xref py pymeth docutils literal"><span class="pre">sge.Game.event_key_release()</span></tt ></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_mouse_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_mo use_move</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sge.StellarClass.event_paused_mouse_move" title="Permalink to this defin ition"></a></dt> <dd><p>Mouse move event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.G ame.event_mouse_move" title="sge.Game.event_mouse_move"><tt class="xref py py-me th docutils literal"><span class="pre">sge.Game.event_mouse_move()</span></tt></ a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_mouse_button_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_mo use_button_press</tt><big>(</big><em>button</em><big>)</big><a class="headerlink " href="#sge.StellarClass.event_paused_mouse_button_press" title="Permalink to t

his definition"></a></dt> <dd><p>Mouse button press event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_mouse_button_press" title="sge.Game.event_mouse_button_press"><tt class="xref py py-meth docutils l iteral"><span class="pre">sge.Game.event_mouse_button_press()</span></tt></a> fo r more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_mouse_button_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_mo use_button_release</tt><big>(</big><em>button</em><big>)</big><a class="headerli nk" href="#sge.StellarClass.event_paused_mouse_button_release" title="Permalink to this definition"></a></dt> <dd><p>Mouse button release event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_mouse_button_releas e" title="sge.Game.event_mouse_button_release"><tt class="xref py py-meth docuti ls literal"><span class="pre">sge.Game.event_mouse_button_release()</span></tt>< /a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_joystick_axis_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_jo ystick_axis_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>axis</em>, <em> value</em><big>)</big><a class="headerlink" href="#sge.StellarClass.event_paused _joystick_axis_move" title="Permalink to this definition"></a></dt> <dd><p>Joystick axis move event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_axis_move" title="sge.Game.event_joystick_axis_move"><tt class="xref py py-meth docutils l iteral"><span class="pre">sge.Game.event_joystick_axis_move()</span></tt></a> fo r more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_joystick_hat_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_jo ystick_hat_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>hat</em>, <em>x< /em>, <em>y</em><big>)</big><a class="headerlink" href="#sge.StellarClass.event_ paused_joystick_hat_move" title="Permalink to this definition"></a></dt> <dd><p>Joystick HAT move event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_hat_move" title="sge.Game.event_joystick_hat_move"><tt class="xref py py-meth docutils lit eral"><span class="pre">sge.Game.event_joystick_hat_move()</span></tt></a> for m ore information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_joystick_trackball_move"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_jo ystick_trackball_move</tt><big>(</big><em>name</em>, <em>ID</em>, <em>ball</em>, <em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sge.StellarClass .event_paused_joystick_trackball_move" title="Permalink to this definition"></a>< /dt> <dd><p>Joystick trackball move event when paused.</p>

<p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_trackball_ move" title="sge.Game.event_joystick_trackball_move"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_joystick_trackball_move()</sp an></tt></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_joystick_button_press"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_jo ystick_button_press</tt><big>(</big><em>name</em>, <em>ID</em>, <em>button</em>< big>)</big><a class="headerlink" href="#sge.StellarClass.event_paused_joystick_b utton_press" title="Permalink to this definition"></a></dt> <dd><p>Joystick button press event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_button_pre ss" title="sge.Game.event_joystick_button_press"><tt class="xref py py-meth docu tils literal"><span class="pre">sge.Game.event_joystick_button_press()</span></t t></a> for more information.</p> </dd></dl> <dl class="method"> <dt id="sge.StellarClass.event_paused_joystick_button_release"> <tt class="descclassname">StellarClass.</tt><tt class="descname">event_paused_jo ystick_button_release</tt><big>(</big><em>name</em>, <em>ID</em>, <em>button</em ><big>)</big><a class="headerlink" href="#sge.StellarClass.event_paused_joystick _button_release" title="Permalink to this definition"></a></dt> <dd><p>Joystick button release event when paused.</p> <p>See the documentation for <a class="reference internal" href="Game.html#sge.Game.event_joystick_button_rel ease" title="sge.Game.event_joystick_button_release"><tt class="xref py py-meth docutils literal"><span class="pre">sge.Game.event_joystick_button_release()</sp an></tt></a> for more information.</p> </dd></dl> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <p class="logo"><a href="index.html"> <img class="logo" src="_static/sge_logo_alpha_black.png" alt="Logo "/> </a></p> <h3><a href="index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">sge.StellarClass</a><ul> <li><a class="reference internal" href="#sge-stellarclass-methods">sge.StellarCl ass Methods</a></li> <li><a class="reference internal" href="#sge-stellarclass-event-methods">sge.Ste llarClass Event Methods</a></li> </ul> </li>

</ul> <h4>Previous topic</h4> <p class="topless"><a href="Font.html" title="previous chapter">sge.Font</a></p> <h4>Next topic</h4> <p class="topless"><a href="Room.html" title="next chapter">sge.Room</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/StellarClass.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="Room.html" title="sge.Room" >next</a> |</li> <li class="right" > <a href="Font.html" title="sge.Font" >previous</a> |</li> <li><a href="index.html">The Pygame SGE 0.8.0 documentation</a> &raquo;< /li> <li><a href="classes.html" >Classes</a> &raquo;</li> </ul> </div> <div class="footer"> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>

Anda mungkin juga menyukai