FGGE  v0.7
Fabiogiopla HTML5 Game Engine
 All Classes Namespaces Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
GameEngine.Mouse.MouseEvent Class Reference

Describes a Mouse event. More...

Public Member Functions

var getButtonNumber ()
 Get mouse button number.
 
var getWheelValue ()
 Get wheel rotation value.
 
var getEventType ()
 Detect mouse events.
 

Public Attributes

const EVENT_PRESS
 Mouse button pressed.
 
const EVENT_RELEASE
 Mouse button released.
 
const EVENT_MOVE
 Mouse moved.
 
const EVENT_WHEEL
 Wheel rotated.
 
const MOUSE_LEFT
 Left mouse button.
 
const MOUSE_RIGHT
 Right mouse button.
 
const MOUSE_MIDDLE
 Middle mouse button.
 

Detailed Description

Describes a Mouse event.

Describes a Mouse event like button pressing or releasing, mouse move or wheel rotation.

Member Function Documentation

var GameEngine.Mouse.MouseEvent.getButtonNumber ( )

Get mouse button number.

Returns the number of the button intercepted with the event.

function mouseListener(event) {
if(event.getEventType() == GameEngine.Mouse.MouseEvent.EVENT_RELEASE) {
if(event.getButtonNumber() == GameEngine.Mouse.MouseEvent.MOUSE_LEFT) {
alert("Left mouse button released!");
}
}
}
GameEngine.Mouse.addMouseListener(mouseListener);
Returns
The ID of the intercepted mouse button, can be MOUSE_LEFT, MOUSE_RIGHT, MOUSE_MIDDLE or a number (one for every mouse button).
var GameEngine.Mouse.MouseEvent.getEventType ( )

Detect mouse events.

May return EVENT_PRESS, EVENT_RELEASE, EVENT_MOVE or EVENT_WHEEL.

function mouseListener(event) {
if(event.getEventType() == GameEngine.Mouse.MouseEvent.EVENT_RELEASE) {
if(event.getButtonNumber() == GameEngine.Mouse.MouseEvent.MOUSE_LEFT) {
alert("Left mouse button released!");
}
}
}
GameEngine.Mouse.addMouseListener(mouseListener);
Returns
Mouse event, can be EVENT_PRESS, EVENT_RELEASE, EVENT_MOVE or EVENT_WHEEL.
var GameEngine.Mouse.MouseEvent.getWheelValue ( )

Get wheel rotation value.

Get wheel rotation value for EVENT_WHEEL events.

Returns
The wheel rotation value.