source/gameengine/PyDoc/SCA_MouseSensor.py

   1 # $Id$
   2 # Documentation for SCA_MouseSensor
   3 from SCA_ISensor import *
   4
   5 class SCA_MouseSensor(SCA_ISensor):
   6         """
   7         Mouse Sensor logic brick.
   8
   9         Properties:
  10
  11         @ivar position: current [x,y] coordinates of the mouse, in frame coordinates (pixels)
  12         @type position: [integer,interger]
  13         @ivar mode: sensor mode: 1=KX_MOUSESENSORMODE_LEFTBUTTON  2=KX_MOUSESENSORMODE_MIDDLEBUTTON
  14                                  3=KX_MOUSESENSORMODE_RIGHTBUTTON 4=KX_MOUSESENSORMODE_WHEELUP
  15                                  5=KX_MOUSESENSORMODE_WHEELDOWN   9=KX_MOUSESENSORMODE_MOVEMENT
  16         @type mode: integer
  17         """
  18
  19         def getXPosition():
  20                 """
  21                 DEPRECATED: use the position property
  22                 Gets the x coordinate of the mouse.
  23
  24                 @rtype: integer
  25                 @return: the current x coordinate of the mouse, in frame coordinates (pixels)
  26                 """
  27         def getYPosition():
  28                 """
  29                 DEPRECATED: use the position property
  30                 Gets the y coordinate of the mouse.
  31
  32                 @rtype: integer
  33                 @return: the current y coordinate of the mouse, in frame coordinates (pixels).
  34                 """
  35         def getButtonStatus(button):
  36                 """
  37                 Get the mouse button status.
  38
  39                 @type button: int
  40                 @param button: value in GameLogic members KX_MOUSE_BUT_LEFT, KX_MOUSE_BUT_MIDDLE, KX_MOUSE_BUT_RIGHT
  41
  42                 @rtype: integer
  43                 @return: value in GameLogic members KX_INPUT_NONE, KX_INPUT_NONE, KX_INPUT_JUST_ACTIVATED, KX_INPUT_ACTIVE, KX_INPUT_JUST_RELEASED
  44                 """