FGGE  v0.7
Fabiogiopla HTML5 Game Engine
 All Classes Namespaces Functions Variables Pages
Classes | Functions | Variables
Package GameEngine.Mouse

Manage input from mouse. More...

Classes

class  MouseEvent
 Describes a Mouse event. More...
 

Functions

 addMouseListener (var listener)
 Add a Mouse listener.
 
 removeMouseListener (var listener)
 Remove a Mouse listener.
 

Variables

var x
 Position X of the cursor.
 
var y
 Position Y of the cursor.
 

Detailed Description

Manage input from mouse.

Mouse-related tools are inside this package.

Function Documentation

GameEngine.Mouse.addMouseListener ( var  listener)

Add a Mouse listener.

Start listening for mouse events.

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);
Parameters
listenerThe listener function.
GameEngine.Mouse.removeMouseListener ( var  listener)

Remove a Mouse listener.

Remove a previously added Mouse listener, if the listener doesn't exist, nothing happens.

Parameters
listenerThe listener function to remove.

Variable Documentation

var GameEngine.Mouse.x

Position X of the cursor.

Updated automatically every frame, may produce wrong results if used in a strangely formatted page.

var GameEngine.Mouse.y

Position Y of the cursor.

Updated automatically every frame, may produce wrong results if used in a strangely formatted page.