Murl Engine Lua Addon API  Version 1.0 beta
Murl.Input.IMouseDevice

The IMouseDevice interface.


Table members

Inherited


Murl.Input.IDevice
Murl.Input.IMouseButtons

Methods


WasMoved()

Check if the mouse device was moved in the most recent tick.

Boolean WasMoved()

Returns
Boolean true if the mouse device was moved in the most recent tick.

GetPositionX()

Get the mouse x-position on the display surface.

Number GetPositionX()

Returns
Number The x-position in range [-1.0 left .. 1.0 right].

GetPositionY()

Get the mouse y-position on the display surface.

Number GetPositionY()

Returns
Number The y-position in range [-1.0 bottom .. 1.0 top].

IsPositionXInRange()

Check if the mouse x-position is in range of the display surface. If the mouse cursor is moved out of the display surface (e.g. the window), the mouse positions are clipped to range [-1.0, 1.0]. This method can be used to detect this case.

Boolean IsPositionXInRange()

Returns
Boolean true if the mouse x-position is in range.

IsPositionYInRange()

Check if the mouse y-position is in range of the display surface. If the mouse cursor is moved out of the display surface (e.g. the window), the mouse positions are clipped to range [-1.0, 1.0]. This method can be used to detect this case.

Boolean IsPositionYInRange()

Returns
Boolean true if the mouse y-position is in range.