Module SCA_MouseSensor :: Class SCA_MouseSensor
[frames | no frames]

Class SCA_MouseSensor

SCA_ILogicBrick --+    
                  |    
        SCA_ISensor --+
                      |
                     SCA_MouseSensor

Known Subclasses:
KX_MouseFocusSensor

Mouse Sensor logic brick.
Method Summary
integer getXPosition()
Gets the x coordinate of the mouse.
integer getYPosition()
Gets the y coordinate of the mouse.
    Inherited from SCA_ISensor
integer getFrequency()
The frequency for pulse mode sensors.
  getInvert()
True if this sensor activates on negative events.
  getUseNegPulseMode()
True if the sensor is in negative pulse mode.
  getUsePosPulseMode()
True if the sensor is in positive pulse mode.
  isPositive()
True if this sensor brick has been activated.
  setFrequency(freq)
Sets the frequency for pulse mode sensors.
  setInvert(invert)
Sets if this sensor activates on positive or negative events.
  setUseNegPulseMode(pulse)
Sets negative pulse mode.
  setUsePosPulseMode(pulse)
Sets positive pulse mode.
    Inherited from SCA_ILogicBrick
integer getExecutePriority()
Gets the execution priority of this logic brick.
KX_GameObject getOwner()
Gets the game object associated with this logic brick.
  setExecutePriority(priority)
Sets the priority of this logic brick.

Method Details

getXPosition()

Gets the x coordinate of the mouse.
Returns:
the current x coordinate of the mouse, in frame coordinates (pixels)
           (type=integer)

getYPosition()

Gets the y coordinate of the mouse.
Returns:
the current y coordinate of the mouse, in frame coordinates (pixels).
           (type=integer)

Generated by Epydoc 2.1 on Thu Feb 1 00:12:33 2007 http://epydoc.sf.net