Functions

<!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>Functions — 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="prev" title="sge.View" href="View.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="View.html" title="sge.View" accesskey="P">previous</a> |</li> <li><a href="index.html">The Pygame SGE 0.8.0 documentation</a> »< /li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="functions"> <h1>Functions<a class="headerlink" href="#functions" title="Permalink to this he adline"></a></h1> <dl class="function"> <dt id="sge.show_message"> <tt class="descclassname">sge.</tt><tt class="descname">show_message</tt><big>(< /big>text, buttons=('OK', ), default=0<big>) </big><a class="headerlink" href="#sge.show_message" title="Permalink to this de finition"></a></dt>
<dd>Show a dialog box and return the button pressed. Arguments: <ul class="simple"> <li><tt class="docutils literal">text</tt> – The message to show in the dialog box as a string.</li> <li><tt class="docutils literal">buttons</tt> – A list or tuple of strings to put in each of the buttons from left to right.</li> <li><tt class="docutils literal">default</tt> – T he number of the button to select by default, where <tt class="docutils literal">0</tt> is the first button.</li> </ul> While the dialog box is being shown, all events are stopped. The return value is the number of the button which was pressed, where <tt class="docutils literal">0</tt> is the first button. If the dialog box was closed in any way other than clicking on one of the buttons (including by clicking an “X” button or similar), <tt class="xref py py-const docu tils literal">None</tt> is returned. </dd></dl> <dl class="function"> <dt id="sge.get_text_entry"> <tt class="descclassname">sge.</tt><tt class="descname">get_text_entry</tt><big> (</big>text, default=''<big>)</big><a class="headerlink" href= "#sge.get_text_entry" title="Permalink to this definition"></a></dt> <dd>Show a text entry dialog box and return the text entered. Arguments: <ul class="simple"> <li><tt class="docutils literal">text</tt> – The message to show in the dialog box as a string.</li> <li><tt class="docutils literal">default</tt> – T he text to put in the text entry field initially.</li> </ul> The text entry dialog box is mostly the same as the regular dialog box – see the documentation for <a class="reference internal" href="#sge.s how_message" title="sge.show_message"><tt class="xref py py-func docutils litera l">sge.show_message()</tt></a> for more information – but there are some key differences: There is always an OK button and a Cancel button. If the OK button is clicked, the text in the text entry field is returned. If the Cancel button is clicked, <tt class="xref py py-const docutils literal">None</tt> is returned. </dd></dl> <dl class="function"> <dt id="sge.get_key_pressed"> <tt class="descclassname">sge.</tt><tt class="descname">get_key_pressed</tt><big >(</big>key<big>)</big><a class="headerlink" href="#sge.get_key_pressed " title="Permalink to this definition"></a></dt> <dd>Return whether or not a key is pressed. Arguments: <ul class="simple"> <li><tt class="docutils literal">key</tt> – The i dentifier string of the key to check; see below for a table of the identifier strings.</li> </ul> <table border="1" class="docutils"> <colgroup>
<col width="33%" /> <col width="38%" /> <col width="28%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Key Name</th> <th class="head">Identifier String</th> <th class="head">Unicode Character</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>0</td> <td><tt class="docutils literal">"0"</tt></td > <td><tt class="docutils literal">"0"</tt></td > </tr> <tr class="row-odd"><td>1</td> <td><tt class="docutils literal">"1"</tt></td > <td><tt class="docutils literal">"1"</tt></td > </tr> <tr class="row-even"><td>2</td> <td><tt class="docutils literal">"2"</tt></td > <td><tt class="docutils literal">"2"</tt></td > </tr> <tr class="row-odd"><td>3</td> <td><tt class="docutils literal">"3"</tt></td > <td><tt class="docutils literal">"3"</tt></td > </tr> <tr class="row-even"><td>4</td> <td><tt class="docutils literal">"4"</tt></td > <td><tt class="docutils literal">"4"</tt></td > </tr> <tr class="row-odd"><td>5</td> <td><tt class="docutils literal">"5"</tt></td > <td><tt class="docutils literal">"5"</tt></td > </tr> <tr class="row-even"><td>6</td> <td><tt class="docutils literal">"6"</tt></td > <td><tt class="docutils literal">"6"</tt></td > </tr> <tr class="row-odd"><td>7</td> <td><tt class="docutils literal">"7"</tt></td > <td><tt class="docutils literal">"7"</tt></td > </tr> <tr class="row-even"><td>8</td>
<td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>9</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>A</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>B</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>C</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>D</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>E</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>F</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>G</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>H</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>I</td>
class="pre">"8"</tt></td class="pre">"8"</tt></td
class="pre">"9"</tt></td class="pre">"9"</tt></td
class="pre">"a"</tt></td class="pre">"a"</tt></td
class="pre">"b"</tt></td class="pre">"b"</tt></td
class="pre">"c"</tt></td class="pre">"c"</tt></td
class="pre">"d"</tt></td class="pre">"d"</tt></td
class="pre">"e"</tt></td class="pre">"e"</tt></td
class="pre">"f"</tt></td class="pre">"f"</tt></td
class="pre">"g"</tt></td class="pre">"g"</tt></td
class="pre">"h"</tt></td class="pre">"h"</tt></td
<td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>J</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>K</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>L</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>M</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>N</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>O</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>P</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>Q</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-odd"><td>R</td> <td><tt class="docutils literal"> <td><tt class="docutils literal"> </tr> <tr class="row-even"><td>S</td>
class="pre">"i"</tt></td class="pre">"i"</tt></td
class="pre">"j"</tt></td class="pre">"j"</tt></td
class="pre">"k"</tt></td class="pre">"k"</tt></td
class="pre">"l"</tt></td class="pre">"l"</tt></td
class="pre">"m"</tt></td class="pre">"m"</tt></td
class="pre">"n"</tt></td class="pre">"n"</tt></td
class="pre">"o"</tt></td class="pre">"o"</tt></td
class="pre">"p"</tt></td class="pre">"p"</tt></td
class="pre">"q"</tt></td class="pre">"q"</tt></td
class="pre">"r"</tt></td class="pre">"r"</tt></td
<td><tt class="docutils literal">"s"</tt></td > <td><tt class="docutils literal">"s"</tt></td > </tr> <tr class="row-odd"><td>T</td> <td><tt class="docutils literal">"t"</tt></td > <td><tt class="docutils literal">"t"</tt></td > </tr> <tr class="row-even"><td>U</td> <td><tt class="docutils literal">"u"</tt></td > <td><tt class="docutils literal">"u"</tt></td > </tr> <tr class="row-odd"><td>V</td> <td><tt class="docutils literal">"v"</tt></td > <td><tt class="docutils literal">"v"</tt></td > </tr> <tr class="row-even"><td>W</td> <td><tt class="docutils literal">"w"</tt></td > <td><tt class="docutils literal">"w"</tt></td > </tr> <tr class="row-odd"><td>X</td> <td><tt class="docutils literal">"x"</tt></td > <td><tt class="docutils literal">"x"</tt></td > </tr> <tr class="row-even"><td>Y</td> <td><tt class="docutils literal">"y"</tt></td > <td><tt class="docutils literal">"y"</tt></td > </tr> <tr class="row-odd"><td>Z</td> <td><tt class="docutils literal">"z"</tt></td > <td><tt class="docutils literal">"z"</tt></td > </tr> <tr class="row-even"><td>Period</td> <td><tt class="docutils literal">"period"</tt ></td> <td><tt class="docutils literal">"."</tt></td > </tr> <tr class="row-odd"><td>Comma</td> <td><tt class="docutils literal">"comma"</tt> </td> <td><tt class="docutils literal">","</tt></td > </tr> <tr class="row-even"><td>Less Than</td>
<td><tt class="docutils literal">"less_than"< /tt></td> <td><tt class="docutils literal">"<"</tt>< /td> </tr> <tr class="row-odd"><td>Greater Than</td> <td><tt class="docutils literal">"greater_than"</spa n></tt></td> <td><tt class="docutils literal">">"</tt>< /td> </tr> <tr class="row-even"><td>Forward Slash</td> <td><tt class="docutils literal">"slash"</tt> </td> <td><tt class="docutils literal">"/"</tt></td > </tr> <tr class="row-odd"><td>Question Mark</td> <td><tt class="docutils literal">"question"</ tt></td> <td><tt class="docutils literal">"?"</tt></td > </tr> <tr class="row-even"><td>Apostrophe</td> <td><tt class="docutils literal">"apostrophe" </tt></td> <td><tt class="docutils literal">"'"</tt></td > </tr> <tr class="row-odd"><td>Quotation Mark</td> <td><tt class="docutils literal">"quote"</tt> </td> <td><tt class="docutils literal">'"'</tt></td> </tr> <tr class="row-even"><td>Colon</td> <td><tt class="docutils literal">"colon"</tt> </td> <td><tt class="docutils literal">":"</tt></td > </tr> <tr class="row-odd"><td>Semicolon</td> <td><tt class="docutils literal">"semicolon"< /tt></td> <td><tt class="docutils literal">";"</tt></td > </tr> <tr class="row-even"><td>Exclamation Point</td> <td><tt class="docutils literal">"exclamation"</tt></td> <td><tt class="docutils literal">"!"</tt></td > </tr> <tr class="row-odd"><td>At</td> <td><tt class="docutils literal">"at"</tt></t d> <td><tt class="docutils literal">"@"</tt> </td> </tr> <tr class="row-even"><td>Hash</td> <td><tt class="docutils literal">"hash"</tt><
/td> <td><tt class="docutils literal">"#"</tt></td > </tr> <tr class="row-odd"><td>Dollar Sign</td> <td><tt class="docutils literal">"dollar"</tt ></td> <td><tt class="docutils literal">"$"</tt></td > </tr> <tr class="row-even"><td>Carat</td> <td><tt class="docutils literal">"carat"</tt> </td> <td><tt class="docutils literal">"^"</tt></td > </tr> <tr class="row-odd"><td>Ampersand</td> <td><tt class="docutils literal">"ampersand"< /tt></td> <td><tt class="docutils literal">"&"</tt> </td> </tr> <tr class="row-even"><td>Asterisk</td> <td><tt class="docutils literal">"asterisk"</ tt></td> <td><tt class="docutils literal">"*"</tt></td > </tr> <tr class="row-odd"><td>Left Parenthesis</td> <td><tt class="docutils literal">"parenthesis_left"</tt></td> <td><tt class="docutils literal">"("</tt></td > </tr> <tr class="row-even"><td>Right Parenthesis</td> <td><tt class="docutils literal">"parenthesis_right" </tt></td> <td><tt class="docutils literal">")"</tt></td > </tr> <tr class="row-odd"><td>Hyphen</td> <td><tt class="docutils literal">"hyphen"</tt ></td> <td><tt class="docutils literal">"-"</tt></td > </tr> <tr class="row-even"><td>Underscore</td> <td><tt class="docutils literal">"underscore" </tt></td> <td><tt class="docutils literal">"_"</tt></td > </tr> <tr class="row-odd"><td>Plus Sign</td> <td><tt class="docutils literal">"plus"</tt>< /td> <td><tt class="docutils literal">"+"</tt></td > </tr> <tr class="row-even"><td>Equals Sign</td> <td><tt class="docutils literal">"equals"</tt
></td> <td><tt class="docutils literal">"="</tt></td > </tr> <tr class="row-odd"><td>Left Bracket</td> <td><tt class="docutils literal">"bracket_left"</spa n></tt></td> <td><tt class="docutils literal">"["</tt></td > </tr> <tr class="row-even"><td>Right Bracket</td> <td><tt class="docutils literal">"bracket_right"</sp an></tt></td> <td><tt class="docutils literal">"]"</tt></td > </tr> <tr class="row-odd"><td>Backslash</td> <td><tt class="docutils literal">"backslash"< /tt></td> <td><tt class="docutils literal">"\\"</tt></t d> </tr> <tr class="row-even"><td>Backtick</td> <td><tt class="docutils literal">"backtick"</ tt></td> <td><tt class="docutils literal">"`"</tt></td > </tr> <tr class="row-odd"><td>Keypad 0</td> <td><tt class="docutils literal">"kp_0"</tt>< /td> <td><tt class="docutils literal">"0"</tt></td > </tr> <tr class="row-even"><td>Keypad 1</td> <td><tt class="docutils literal">"kp_1"</tt>< /td> <td><tt class="docutils literal">"1"</tt></td > </tr> <tr class="row-odd"><td>Keypad 2</td> <td><tt class="docutils literal">"kp_2"</tt>< /td> <td><tt class="docutils literal">"2"</tt></td > </tr> <tr class="row-even"><td>Keypad 3</td> <td><tt class="docutils literal">"kp_3"</tt>< /td> <td><tt class="docutils literal">"3"</tt></td > </tr> <tr class="row-odd"><td>Keypad 4</td> <td><tt class="docutils literal">"kp_4"</tt>< /td> <td><tt class="docutils literal">"4"</tt></td > </tr> <tr class="row-even"><td>Keypad 5</td> <td><tt class="docutils literal">"kp_5"</tt><
/td> <td><tt class="docutils literal">"5"</tt></td > </tr> <tr class="row-odd"><td>Keypad 6</td> <td><tt class="docutils literal">"kp_6"</tt>< /td> <td><tt class="docutils literal">"6"</tt></td > </tr> <tr class="row-even"><td>Keypad 7</td> <td><tt class="docutils literal">"kp_7"</tt>< /td> <td><tt class="docutils literal">"7"</tt></td > </tr> <tr class="row-odd"><td>Keypad 8</td> <td><tt class="docutils literal">"kp_8"</tt>< /td> <td><tt class="docutils literal">"8"</tt></td > </tr> <tr class="row-even"><td>Keypad 9</td> <td><tt class="docutils literal">"kp_9"</tt>< /td> <td><tt class="docutils literal">"9"</tt></td > </tr> <tr class="row-odd"><td>Keypad Decimal Point</td> <td><tt class="docutils literal">"kp_point"</ tt></td> <td><tt class="docutils literal">"."</tt></td > </tr> <tr class="row-even"><td>Keypad Plus</td> <td><tt class="docutils literal">"kp_plus"</t t></td> <td><tt class="docutils literal">"+"</tt></td > </tr> <tr class="row-odd"><td>Keypad Minus</td> <td><tt class="docutils literal">"kp_minus"</ tt></td> <td><tt class="docutils literal">"-"</tt></td > </tr> <tr class="row-even"><td>Keypad Multiply</td> <td><tt class="docutils literal">"kp_multiply"</tt></td> <td><tt class="docutils literal">"*"</tt></td > </tr> <tr class="row-odd"><td>Keypad Divide</td> <td><tt class="docutils literal">"kp_divide"< /tt></td> <td><tt class="docutils literal">"/"</tt></td > </tr> <tr class="row-even"><td>Keypad Equals</td> <td><tt class="docutils literal">"kp_equals"<
/tt></td> <td><tt class="docutils literal">"="</tt></td > </tr> <tr class="row-odd"><td>Keypad Enter</td> <td><tt class="docutils literal">"kp_enter"</ tt></td> <td> </td> </tr> <tr class="row-even"><td>Left Arrow</td> <td><tt class="docutils literal">"left"</tt>< /td> <td> </td> </tr> <tr class="row-odd"><td>Right Arrow</td> <td><tt class="docutils literal">"right"</tt> </td> <td> </td> </tr> <tr class="row-even"><td>Up Arrow</td> <td><tt class="docutils literal">"up"</tt></t d> <td> </td> </tr> <tr class="row-odd"><td>Down Arrow</td> <td><tt class="docutils literal">"down"</tt>< /td> <td> </td> </tr> <tr class="row-even"><td>Tab</td> <td><tt class="docutils literal">"tab"</tt></ td> <td><tt class="docutils literal">"\t"</tt></t d> </tr> <tr class="row-odd"><td>Space Bar</td> <td><tt class="docutils literal">"space"</tt> </td> <td><tt class="docutils literal">" "</tt></td> </tr> <tr class="row-even"><td>Enter/Return</td> <td><tt class="docutils literal">"enter"</tt> </td> <td><tt class="docutils literal">"\n"</tt></t d> </tr> <tr class="row-odd"><td>Backspace</td> <td><tt class="docutils literal">"backspace"< /tt></td> <td><tt class="docutils literal">"\b"</tt></t d> </tr> <tr class="row-even"><td>Delete</td> <td><tt class="docutils literal">"delete"</tt ></td> <td> </td> </tr> <tr class="row-odd"><td>Insert</td> <td><tt class="docutils literal">"insert"</tt
></td> <td> </td> </tr> <tr class="row-even"><td>Left Shift</td> <td><tt class="docutils literal">"shift_left" </tt></td> <td> </td> </tr> <tr class="row-odd"><td>Right Shift</td> <td><tt class="docutils literal">"shift_right"</tt></td> <td> </td> </tr> <tr class="row-even"><td>Left Ctrl</td> <td><tt class="docutils literal">"ctrl_left"< /tt></td> <td> </td> </tr> <tr class="row-odd"><td>Right Ctrl</td> <td><tt class="docutils literal">"ctrl_right" </tt></td> <td> </td> </tr> <tr class="row-even"><td>Left Alt</td> <td><tt class="docutils literal">"alt_left"</ tt></td> <td> </td> </tr> <tr class="row-odd"><td>Right Alt</td> <td><tt class="docutils literal">"alt_right"< /tt></td> <td> </td> </tr> <tr class="row-even"><td>Left Super</td> <td><tt class="docutils literal">"super_left" </tt></td> <td> </td> </tr> <tr class="row-odd"><td>Right Super</td> <td><tt class="docutils literal">"super_right"</tt></td> <td> </td> </tr> <tr class="row-even"><td>Caps Lock</td> <td><tt class="docutils literal">"caps_lock"< /tt></td> <td> </td> </tr> <tr class="row-odd"><td>Home</td> <td><tt class="docutils literal">"home"</tt>< /td> <td> </td> </tr> <tr class="row-even"><td>End</td> <td><tt class="docutils literal">"end"</tt></ td> <td> </td> </tr> <tr class="row-odd"><td>Page Up</td> <td><tt class="docutils literal">"pageup"</tt
></td> <td> </td> </tr> <tr class="row-even"><td>Page Down</td> <td><tt class="docutils literal">"pagedown"</ tt></td> <td> </td> </tr> <tr class="row-odd"><td>Pause</td> <td><tt class="docutils literal">"pause"</tt> </td> <td> </td> </tr> <tr class="row-even"><td>Break</td> <td><tt class="docutils literal">"break"</tt> </td> <td> </td> </tr> <tr class="row-odd"><td>Print Screen</td> <td><tt class="docutils literal">"print_screen"</spa n></tt></td> <td> </td> </tr> <tr class="row-even"><td>SysRq</td> <td><tt class="docutils literal">"sysrq"</tt> </td> <td> </td> </tr> <tr class="row-odd"><td>Clear</td> <td><tt class="docutils literal">"clear"</tt> </td> <td> </td> </tr> <tr class="row-even"><td>Menu</td> <td><tt class="docutils literal">"menu"</tt>< /td> <td> </td> </tr> <tr class="row-odd"><td>Mode</td> <td><tt class="docutils literal">"mode"</tt>< /td> <td> </td> </tr> <tr class="row-even"><td>Power</td> <td><tt class="docutils literal">"power"</tt> </td> <td> </td> </tr> <tr class="row-odd"><td>Scroll Lock</td> <td><tt class="docutils literal">"scroll_lock"</tt></td> <td> </td> </tr> <tr class="row-even"><td>Esc</td> <td><tt class="docutils literal">"escape"</tt ></td> <td> </td> </tr> <tr class="row-odd"><td>F1</td> <td><tt class="docutils literal">"f1"</tt></t
d> <td> </td> </tr> <tr class="row-even"><td>F2</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-odd"><td>F3</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-even"><td>F4</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-odd"><td>F5</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-even"><td>F6</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-odd"><td>F7</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-even"><td>F8</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-odd"><td>F9</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-even"><td>F10</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-odd"><td>F11</td> <td><tt class="docutils literal"> <td> </td> </tr> <tr class="row-even"><td>F12</td> <td><tt class="docutils literal"> <td> </td> </tr> </tbody> </table>
class="pre">"f2"</tt></t
class="pre">"f10"</tt></
</dd></dl> <dl class="function"> <dt id="sge.get_mouse_button_pressed"> <tt class="descclassname">sge.</tt><tt class="descname">get_mouse_button_pressed </tt><big>(</big>button<big>)</big><a class="headerlink" href="#sge.get _mouse_button_pressed" title="Permalink to this definition"></a></dt> <dd>Return whether or not a mouse button is pressed. Arguments: <ul class="simple"> <li><tt class="docutils literal">button</tt> – Th e identifier string of the mouse button to check; see below for a table of the identifier strings.</li> </ul> <table border="1" class="docutils"> <colgroup> <col width="56%" /> <col width="44%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Mouse Button Name</th> <th class="head">Identifier String</th> </tr> </thead> <tbody valign="top"> <tr class="row-even"><td>Left mouse button</td> <td><tt class="docutils literal">"left"</tt>< /td> </tr> <tr class="row-odd"><td>Right mouse button</td> <td><tt class="docutils literal">"right"</tt> </td> </tr> <tr class="row-even"><td>Middle mouse button</td> <td><tt class="docutils literal">"middle"</tt ></td> </tr> <tr class="row-odd"><td>Mouse wheel up</td> <td><tt class="docutils literal">"wheel_up"</ tt></td> </tr> <tr class="row-even"><td>Mouse wheel down</td> <td><tt class="docutils literal">"wheel_down" </tt></td> </tr> <tr class="row-odd"><td>Mouse wheel tilt left</td> <td><tt class="docutils literal">"wheel_left" </tt></td> </tr> <tr class="row-even"><td>Mouse wheel tilt right</td> <td><tt class="docutils literal">"wheel_right"</tt></td> </tr> </tbody> </table> </dd></dl> <dl class="function"> <dt id="sge.get_joystick_axis"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_axis</tt>(</big>joystick, axis<big>)</big><a class="headerlink" href ="#sge.get_joystick_axis" title="Permalink to this definition"></a></dt> <dd>Return the position of a joystick axis. Arguments: <ul class="simple"> <li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> <li><tt class="docutils literal">axis</tt> – The number of the axis to check, where <tt class="docutils literal">0</tt> is the first axis of the joystick.</li> </ul> Return a float from <tt class="docutils literal">-1< /tt> to <tt class="docutils literal">1</tt>, where <tt class="docutils literal">0</tt> is centered, <tt class= "docutils literal">-1</tt> is all the way to the left or up, and <tt class="docutils literal">1</tt> is all the way to the right or down. Return <tt class="docutils literal">0</ tt> if the requested joystick or axis does not exist. </dd></dl> <dl class="function"> <dt id="sge.get_joystick_hat"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_hat</tt><bi g>(</big>joystick, hat<big>)</big><a class="headerlink" href=" #sge.get_joystick_hat" title="Permalink to this definition"></a></dt> <dd>Return the position of a joystick HAT. Arguments: <ul class="simple"> <li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> <li><tt class="docutils literal">hat</tt> – The n umber of the HAT to check, where <tt class="docutils literal"> 0</tt> is the first HAT of the joystick.</li> </ul> Return a two-part tuple in the form <tt class="docutils literal">(x, y)</tt>. <tt class="docutils literal" >x</tt> can be <tt class="docutils literal">-1</tt> (left), <tt class="docutils literal">0</tt> (horizontal ly centered), or <tt class="docutils literal">1</tt> (r ight). <tt class="docutils literal">y</tt> can be <tt class="docutils literal">-1</tt> (up), <tt class ="docutils literal">0</tt> (vertically centered), or <t t class="docutils literal">1</tt> (down). Return <tt class="docutils literal">(0, 0)</tt> if the requested joystick or axis does not exist. </dd></dl> <dl class="function"> <dt id="sge.get_joystick_button_pressed"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_button_pres sed</tt><big>(</big>joystick, button<big>)</big><a class="head
erlink" href="#sge.get_joystick_button_pressed" title="Permalink to this definit ion"></a></dt> <dd>Return whether or not a joystick button is pressed. Arguments: <ul class="simple"> <li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> <li><tt class="docutils literal">button</tt> – Th e number of the button to check, where <tt class="docutils literal">0</tt> is the first button of the joystick.</li> </ul> <tt class="docutils literal">joystick</tt> is the nu mber of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick. <tt class="docutils literal">button</tt> is the number of the button to check, where <tt class="docutils literal">0</tt> is the first button of the joystick. Return <tt class="xref py py-const docutils literal">False</tt> if the requested joystick or button does not exist. </dd></dl> <dl class="function"> <dt id="sge.get_joysticks"> <tt class="descclassname">sge.</tt><tt class="descname">get_joysticks</tt><big>( </big><big>)</big><a class="headerlink" href="#sge.get_joysticks" title="Permali nk to this definition"></a></dt> <dd>Return the number of joysticks available. </dd></dl> <dl class="function"> <dt id="sge.get_joystick_name"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_name</tt>(</big>joystick<big>)</big><a class="headerlink" href="#sge.get_joys tick_name" title="Permalink to this definition"></a></dt> <dd>Return the name of a joystick. Arguments: <ul class="simple"> <li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> </ul> Return <tt class="xref py py-const docutils literal">None</tt> if the requested joystick does not exist. </dd></dl> <dl class="function"> <dt id="sge.get_joystick_id"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_id</tt><big >(</big>joystick<big>)</big><a class="headerlink" href="#sge.get_joysti ck_id" title="Permalink to this definition"></a></dt> <dd>Return the number of a joystick, where <tt class="docutils literal">0</tt> is the first joystick. Arguments: <ul class="simple">
<li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> </ul> Return <tt class="xref py py-const docutils literal">None</tt> if the requested joystick does not exist. </dd></dl> <dl class="function"> <dt id="sge.get_joystick_axes"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_axes</tt>(</big>joystick<big>)</big><a class="headerlink" href="#sge.get_joys tick_axes" title="Permalink to this definition"></a></dt> <dd>Return the number of axes available on a joystick. Arguments: <ul class="simple"> <li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> </ul> Return <tt class="docutils literal">0</tt> if the re quested joystick does not exist. </dd></dl> <dl class="function"> <dt id="sge.get_joystick_hats"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_hats</tt>(</big>joystick<big>)</big><a class="headerlink" href="#sge.get_joys tick_hats" title="Permalink to this definition"></a></dt> <dd>Return the number of HATs available on a joystick. Arguments: <ul class="simple"> <li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> </ul> Return <tt class="docutils literal">0</tt> if the re quested joystick does not exist. </dd></dl> <dl class="function"> <dt id="sge.get_joystick_trackballs"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_trackballs< /tt><big>(</big>joystick<big>)</big><a class="headerlink" href="#sge.ge t_joystick_trackballs" title="Permalink to this definition"></a></dt> <dd>Return the number of trackballs available on a joystick. Arguments: <ul class="simple"> <li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> </ul> Return <tt class="docutils literal">0</tt> if the re quested joystick does not exist. </dd></dl>
<dl class="function"> <dt id="sge.get_joystick_buttons"> <tt class="descclassname">sge.</tt><tt class="descname">get_joystick_buttons</tt ><big>(</big>joystick<big>)</big><a class="headerlink" href="#sge.get_j oystick_buttons" title="Permalink to this definition"></a></dt> <dd>Return the number of buttons available on a joystick. Arguments: <ul class="simple"> <li><tt class="docutils literal">joystick</tt> – The number of the joystick to check, where <tt class="docutils literal">0</tt> is the first joystick, or the name of the joystick to check.</li> </ul> Return <tt class="docutils literal">0</tt> if the re quested joystick does not exist. </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <a href="index.html"> <img class="logo" src="_static/sge_logo_alpha_black.png" alt="Logo "/> </a> <h4>Previous topic</h4> <a href="View.html" title="previous chapter">sge.View</a> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/functions.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> Enter search terms or a module, class or function name. </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="View.html" title="sge.View" >previous</a> |</li> <li><a href="index.html">The Pygame SGE 0.8.0 documentation</a> »< /li> </ul> </div> <div class="footer"> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>

Functions

Enviado por

Dados do documento

Descrição original:

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Functions

Enviado por

Direitos autorais:

Formatos disponíveis

<!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.

Você também pode gostar