archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
148cca898b76e18d1338f6d7efb51a4b08438026
blender-archive/source/gameengine/PyDoc/bge.events.rst
Luca Bonavita 0cae214a78 == 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

3.9 KiB
Raw Blame History

Game Engine bge.events module

Intro

This module holds key constants for the SCA_KeyboardSensor.

# Set a connected keyboard sensor to accept F1
import bge

co = bge.logic.getCurrentController()
# 'Keyboard' is a keyboard sensor
sensor = co.sensors["Keyboard"]
sensor.key = bge.keys.F1KEY

# Do the all keys thing
import bge

co = bge.logic.getCurrentController()
# 'Keyboard' is a keyboard sensor
sensor = co.sensors["Keyboard"]

for key,status in sensor.events:
        # key[0] == bge.keys.keycode, key[1] = status
        if status == bge.logic.KX_INPUT_JUST_ACTIVATED:
                if key == bge.keys.WKEY:
                        # Activate Forward!
                if key == bge.keys.SKEY:
                        # Activate Backward!
                if key == bge.keys.AKEY:
                        # Activate Left!
                if key == bge.keys.DKEY:
                        # Activate Right!

Functions

bge.events.EventToString(event)

Return the string name of a key event. Will raise a ValueError error if its invalid.

Parameters:

event (int) – key event from bge.keys or the keyboard sensor.

Return type:

string

bge.events.EventToCharacter(event, shift)

Return the string name of a key event. Returns an empty string if the event cant be represented as a character.

Parameters:

  • event (int) – key event from bge.keys or the keyboard sensor.

  • shift (bool) – set to true if shift is held.

Return type:

string

Keys (Constants)

Mouse Keys

bge.events.LEFTMOUSE
bge.events.MIDDLEMOUSE
bge.events.RIGHTMOUSE
bge.events.WHEELUPMOUSE
bge.events.WHEELDOWNMOUSE
bge.events.MOUSEX
bge.events.MOUSEY

Keyboard Keys

Alphabet keys

bge.events.AKEY
bge.events.BKEY
bge.events.CKEY
bge.events.DKEY
bge.events.EKEY
bge.events.FKEY
bge.events.GKEY
bge.events.HKEY
bge.events.IKEY
bge.events.JKEY
bge.events.KKEY
bge.events.LKEY
bge.events.MKEY
bge.events.NKEY
bge.events.OKEY
bge.events.PKEY
bge.events.QKEY
bge.events.RKEY
bge.events.SKEY
bge.events.TKEY
bge.events.UKEY
bge.events.VKEY
bge.events.WKEY
bge.events.XKEY
bge.events.YKEY
bge.events.ZKEY

Number keys

bge.events.ZEROKEY
bge.events.ONEKEY
bge.events.TWOKEY
bge.events.THREEKEY
bge.events.FOURKEY
bge.events.FIVEKEY
bge.events.SIXKEY
bge.events.SEVENKEY
bge.events.EIGHTKEY
bge.events.NINEKEY

Modifiers Keys

bge.events.CAPSLOCKKEY
bge.events.LEFTCTRLKEY
bge.events.LEFTALTKEY
bge.events.RIGHTALTKEY
bge.events.RIGHTCTRLKEY
bge.events.RIGHTSHIFTKEY
bge.events.LEFTSHIFTKEY

Arrow Keys

bge.events.LEFTARROWKEY
bge.events.DOWNARROWKEY
bge.events.RIGHTARROWKEY
bge.events.UPARROWKEY

Numberpad Keys

bge.events.PAD0
bge.events.PAD1
bge.events.PAD2
bge.events.PAD3
bge.events.PAD4
bge.events.PAD5
bge.events.PAD6
bge.events.PAD7
bge.events.PAD8
bge.events.PAD9
bge.events.PADPERIOD
bge.events.PADSLASHKEY
bge.events.PADASTERKEY
bge.events.PADMINUS
bge.events.PADENTER
bge.events.PADPLUSKEY

Function Keys

bge.events.F1KEY
bge.events.F2KEY
bge.events.F3KEY
bge.events.F4KEY
bge.events.F5KEY
bge.events.F6KEY
bge.events.F7KEY
bge.events.F8KEY
bge.events.F9KEY
bge.events.F10KEY
bge.events.F11KEY
bge.events.F12KEY
bge.events.F13KEY
bge.events.F14KEY
bge.events.F15KEY
bge.events.F16KEY
bge.events.F17KEY
bge.events.F18KEY
bge.events.F19KEY

Other Keys

bge.events.ACCENTGRAVEKEY
bge.events.BACKSLASHKEY
bge.events.BACKSPACEKEY
bge.events.COMMAKEY
bge.events.DELKEY
bge.events.ENDKEY
bge.events.EQUALKEY
bge.events.ESCKEY
bge.events.HOMEKEY
bge.events.INSERTKEY
bge.events.LEFTBRACKETKEY
bge.events.LINEFEEDKEY
bge.events.MINUSKEY
bge.events.PAGEDOWNKEY
bge.events.PAGEUPKEY
bge.events.PAUSEKEY
bge.events.PERIODKEY
bge.events.QUOTEKEY
bge.events.RIGHTBRACKETKEY
bge.events.RETKEY
bge.events.SEMICOLONKEY
bge.events.SLASHKEY
bge.events.SPACEKEY
bge.events.TABKEY
View Git Blame Copy Permalink