Engine

(NOTE) Mouse object for Display System.

Methods	Properties	Base Classes	Derived Classes
IsButtonDown	ClientPosition	eventobject
ToggleTrapped	Cursor
	CursorMovement
	RawMovement
	Trapped

Properties

---

ClientPosition : real2

read-only

The position of the mouse cursor relative to the application's top-left corner in pixels.

var ClientPosition : Real2

---

Cursor : Cursor

Set the cursor of the mouse.

var Cursor : Cursor

---

CursorMovement : real2

read-only

The movement of the mouse in pixels.

var CursorMovement : Real2

---

RawMovement : real2

High precision raw movement of the mouse.

var RawMovement : Real2

---

Trapped : boolean

Trap the mouse preventing it from moving.

var Trapped : Boolean

---

Methods

---

IsButtonDown : boolean

Is a mouse button currently down? |Name|Type|Description| |---|---|---| |button|MouseButtons| |

function IsButtonDown(button : MouseButtons) : Boolean

---

ToggleTrapped : Void

Toggles if the mouse is currently trapped. |Name|Type|Description| |---|---|---|

function ToggleTrapped()

---