sandey/blender
1
0
Fork 0
forked from bartvdbraak/blender
Code Pull Requests Activity
8b6759a4a9
blender/doc/python_api/rst/bge.events.rst

251 lines
4.6 KiB
ReStructuredText
Raw Normal View History

epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
patch [#27909] Added constants in bge.constraints by Solano Felicio (solano) + some changes in rst I named all the BGE modules with their actual names (e.g. Rasterizer, Video Texture, ...). so in the API index.html page they look more like the other Blender modules. I did the same for the bgl module. For bge.constraints this patch exposes the constants values for debug mode and createConstraints (they were hardcoded innts before). + making all the "todo" and #comments into rst comments (.. comments) Thanks Solano, it's great to get help to those tasks :)
2011-07-30 23:16:22 +00:00
Game Keys (bge.events)
py api: sphinx doc corrections, pep8 cleanup and style edits, also added __all__ to some modules which were missing it.
2011-07-31 03:15:37 +00:00
======================
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
*****
Intro
*****
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
This module holds key constants for the SCA_KeyboardSensor.
.. module:: bge.events
.. code-block:: python
# Set a connected keyboard sensor to accept F1
import bge
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
co = bge.logic.getCurrentController()
# 'Keyboard' is a keyboard sensor
sensor = co.sensors["Keyboard"]
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
sensor.key = bge.events.F1KEY
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. code-block:: python
# Do the all keys thing
import bge
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
co = bge.logic.getCurrentController()
# 'Keyboard' is a keyboard sensor
sensor = co.sensors["Keyboard"]
for key,status in sensor.events:
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
# key[0] == bge.events.keycode, key[1] = status
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
if key == bge.events.WKEY:
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
# Activate Forward!
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
if key == bge.events.SKEY:
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
# Activate Backward!
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
if key == bge.events.AKEY:
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
# Activate Left!
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
if key == bge.events.DKEY:
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
# Activate Right!
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
.. code-block:: python
# The all keys thing without a keyboard sensor (but you will
# need an always sensor with pulse mode on)
import bge
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
# Just shortening names here
keyboard = bge.logic.keyboard
JUST_ACTIVATED = bge.logic.KX_INPUT_JUST_ACTIVATED
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
if keyboard.events[bge.events.WKEY] == JUST_ACTIVATED:
print("Activate Forward!")
if keyboard.events[bge.events.SKEY] == JUST_ACTIVATED:
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
print("Activate Backward!")
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
if keyboard.events[bge.events.AKEY] == JUST_ACTIVATED:
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
print("Activate Left!")
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
if keyboard.events[bge.events.DKEY] == JUST_ACTIVATED:
print("Activate Right!")
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
*********
Functions
*********
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. function:: EventToString(event)
Return the string name of a key event. Will raise a ValueError error if its invalid.
BGE Py API docs: correct references to bge.keys
2013-01-28 06:39:23 +00:00
:arg event: key event constant from :mod:`bge.events` or the keyboard sensor.
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
:type event: int
:rtype: string
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. function:: EventToCharacter(event, shift)
Return the string name of a key event. Returns an empty string if the event cant be represented as a character.
BGE doc cleanup: Some small cleanups in the BGE docs: * Fixing trailing whitespace in some files * Fixing some indentation * SCA_PythonController.owner is now documented * SCA_PythonKeyboard members now use the member directive instead of function
2014-04-01 05:20:03 +00:00
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
:type event: int
BGE Py API docs: correct references to bge.keys
2013-01-28 06:39:23 +00:00
:arg event: key event constant from :mod:`bge.events` or the keyboard sensor.
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
:type shift: bool
:arg shift: set to true if shift is held.
:rtype: string
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
****************
Keys (Constants)
****************
.. _mouse-keys:
==========
Mouse Keys
==========
.. data:: LEFTMOUSE
.. data:: MIDDLEMOUSE
.. data:: RIGHTMOUSE
.. data:: WHEELUPMOUSE
.. data:: WHEELDOWNMOUSE
.. data:: MOUSEX
.. data:: MOUSEY
== python api docs == bge.types --------- - removed lists if they were already available in bge.logic and crosslinked where the list contained description, moved the descriptions in bge.logic so we have useful thing in one place only - fixed a lot of bad formatting, like bad indentation and usage of TAB - changed from literal to codeblocks that smerch for the useful suggestion :) - whered appropriate I've moved code examples to the end, after notes and all it is blocking to have a big black block before actually see a method parameters or return type - have doubt about the list at bge.types.html#bge.types.SCA_MouseSensor.mode possibly tomorrow will ask Dalai bge.logic --------- - added sensor status list - cross linked with bge.types where needed - added a section "ShapeAction Actuator" because in bge.types these constants are docuemented, but in 2.5 I don't see the ShapeAction Actuator (anymore, or for now) I'll ask Dalai tomorrow or when possible (check bge.logic.html#shape-action-actuator once cambo rebuilds the docs) - moved descriptions from bge.types lists to logic page where appropriate - where possible, added custom directive :value: so we have a consistent way to show the value of constants
2010-06-07 23:50:43 +00:00
.. _keyboard-keys:
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
=============
Keyboard Keys
=============
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
-------------
Alphabet keys
-------------
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. data:: AKEY
.. data:: BKEY
.. data:: CKEY
.. data:: DKEY
.. data:: EKEY
.. data:: FKEY
.. data:: GKEY
.. data:: HKEY
.. data:: IKEY
.. data:: JKEY
.. data:: KKEY
.. data:: LKEY
.. data:: MKEY
.. data:: NKEY
.. data:: OKEY
.. data:: PKEY
.. data:: QKEY
.. data:: RKEY
.. data:: SKEY
.. data:: TKEY
.. data:: UKEY
.. data:: VKEY
.. data:: WKEY
.. data:: XKEY
.. data:: YKEY
.. data:: ZKEY
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
-----------
Number keys
-----------
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. data:: ZEROKEY
.. data:: ONEKEY
.. data:: TWOKEY
.. data:: THREEKEY
.. data:: FOURKEY
.. data:: FIVEKEY
.. data:: SIXKEY
.. data:: SEVENKEY
.. data:: EIGHTKEY
.. data:: NINEKEY
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
--------------
Modifiers Keys
--------------
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. data:: CAPSLOCKKEY
.. data:: LEFTCTRLKEY
.. data:: LEFTALTKEY
.. data:: RIGHTALTKEY
.. data:: RIGHTCTRLKEY
.. data:: RIGHTSHIFTKEY
.. data:: LEFTSHIFTKEY
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
----------
Arrow Keys
----------
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. data:: LEFTARROWKEY
.. data:: DOWNARROWKEY
.. data:: RIGHTARROWKEY
.. data:: UPARROWKEY
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
--------------
Numberpad Keys
--------------
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. data:: PAD0
.. data:: PAD1
.. data:: PAD2
.. data:: PAD3
.. data:: PAD4
.. data:: PAD5
.. data:: PAD6
.. data:: PAD7
.. data:: PAD8
.. data:: PAD9
.. data:: PADPERIOD
.. data:: PADSLASHKEY
.. data:: PADASTERKEY
.. data:: PADMINUS
.. data:: PADENTER
.. data:: PADPLUSKEY
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
-------------
Function Keys
-------------
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. data:: F1KEY
.. data:: F2KEY
.. data:: F3KEY
.. data:: F4KEY
.. data:: F5KEY
.. data:: F6KEY
.. data:: F7KEY
.. data:: F8KEY
.. data:: F9KEY
.. data:: F10KEY
.. data:: F11KEY
.. data:: F12KEY
.. data:: F13KEY
.. data:: F14KEY
.. data:: F15KEY
.. data:: F16KEY
.. data:: F17KEY
.. data:: F18KEY
.. data:: F19KEY
== python api docs == some more cleanup: - made structure in source/gameengine/PyDoc/bge.events.rst to be able to crosslink properly - cleaned notes and warnings syntax, and also now they are always the last elements after all the other tags - substituted some lists of possible values of a parameter with links to lists of values (not finished) like in bge.types.html#bge.types.SCA_PythonKeyboard - uncertain about some values, like in http://www.blender.org/documentation/250PythonDoc/bge.types.html#bge.types.SCA_ISensor.status (list of KX_SENSOR_INACTIVE,... etc aren't documented or non-existant, will investigate)
2010-06-03 14:26:38 +00:00
----------
Other Keys
----------
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. data:: ACCENTGRAVEKEY
.. data:: BACKSLASHKEY
.. data:: BACKSPACEKEY
.. data:: COMMAKEY
.. data:: DELKEY
.. data:: ENDKEY
.. data:: EQUALKEY
.. data:: ESCKEY
.. data:: HOMEKEY
.. data:: INSERTKEY
.. data:: LEFTBRACKETKEY
.. data:: LINEFEEDKEY
.. data:: MINUSKEY
.. data:: PAGEDOWNKEY
.. data:: PAGEUPKEY
.. data:: PAUSEKEY
.. data:: PERIODKEY
.. data:: QUOTEKEY
.. data:: RIGHTBRACKETKEY
Campbell requested that I remove one of the bge.events.RETKEY aliases, so I'm removing bge.events.RETURNKEY.
2010-10-06 00:36:12 +00:00
.. data:: RETKEY (Deprecated: use bge.events.ENTERKEY)
A bit of bge.events work: * A few places in the bge.events docs mentioned bge.keys, when it should have been bge.events * Created two aliases to bge.events.RETKEY: ENTERKEY and RETURNKEY * ENTERKEY and RETURNKEY have been added to the docs and RETKEY marked as deprecated * Added an example of using bge.logic.keyboard to the bge.events docs
2010-10-05 05:44:15 +00:00
.. data:: ENTERKEY
epydoc to sphinx markup for GameLogic module
2010-05-17 19:52:25 +00:00
.. data:: SEMICOLONKEY
.. data:: SLASHKEY
.. data:: SPACEKEY
.. data:: TABKEY
Copy Permalink