Input.MouseHandler

Description: Defines a handler that will monitor mouse events over a specified area and will execute appropriate functions based on the events.

Implements: EndGate.IDisposable

Constructors

MouseHandler (target)
Creates a new instance of the MouseHandler object.

target: HTMLElement
The object to monitor mouse events for.

Fields

LeftIsDown: boolean
Indicates if the left mouse button is down

MiddleIsDown: boolean
Indicates if the middle mouse button is down

RightIsDown: boolean
Indicates if the right mouse button is down

IsDown: boolean
Indicates if any mouse button is down.

OnClick: EndGate.EventHandler1 <Input.IMouseClickEvent>
Gets an event that is triggered when a mouse click occurs. Functions can be bound or unbound to this event to be executed when the event triggers.

OnDoubleClick: EndGate.EventHandler1 <Input.IMouseClickEvent>
Gets an event that is triggered when a mouse double click occurs. Functions can be bound or unbound to this event to be executed when the event triggers.

OnDown: EndGate.EventHandler1 <Input.IMouseClickEvent>
Gets an event that is triggered when a mouse down event occurs. Functions can be bound or unbound to this event to be executed when the event triggers.

OnUp: EndGate.EventHandler1 <Input.IMouseClickEvent>
Gets an event that is triggered when a mouse up event occurs. Functions can be bound or unbound to this event to be executed when the event triggers.

OnMove: EndGate.EventHandler1 <Input.IMouseEvent>
Gets an event that is triggered when a mouse move event occurs. Functions can be bound or unbound to this event to be executed when the event triggers.

OnScroll: EndGate.EventHandler1 <Input.IMouseScrollEvent>
Gets an event that is triggered when a mouse scroll event occurs. Functions can be bound or unbound to this event to be executed when the event triggers.

Methods

Dispose()
Disposes the MouseHandler and unbinds all bound events.

Examples

There's currently no example available for this page. If you'd like to suggest one send me an containing a description, code, and link to the page for the suggested example. As a thanks I'll associate the code snippet with your name directly below the example if approved.