ContextInput

This type represents the GUI input context.

You can use Cursor, IsMouseUp, IsMouseDown, IsKeyUp and IsKeyDown methods outside input context. Using other methods will not make any sense, as the information will be outdated.

Cursor

Method

Returns current cursor position.

Arguments

None.

Returns

Type	Description
Vec2	Cursor position.

Example

local cur = gui.input:Cursor();

---

CursorPrev

Method

Returns previous cursor position.

Arguments

None.

Returns

Type	Description
Vec2	Previous cursor position.

Example

local prev = gui.input:CursorPrev();

---

CursorDelta

Method

Delta value between previous and current cursor positions.

Arguments

None.

Returns

Type	Description
Vec2	Cursor delta.

Example

local delta = gui.input:CursorDelta();

---

DidCursorMove

Method

Returns true if the cursor did move since the last input.

Arguments

None.

Returns

Type	Description
bool	true if moved.

Example

if gui.input:DidCursorMove() then
    -- ...
end

---

DidWheelMove

Method

Returns true if mouse scroll wheel did move since the last input.

Arguments

None.

Returns

Type	Description
bool	true if moved.

Example

if gui.input:DidWheelMove() then
    -- ...
end

---

---

DidProcessMouse

Method

Returns true if any mouse key's state had changed.

Arguments

None.

Returns

Type	Description
bool	true if processed.

Example

if gui.input:DidProcessMouse() then
    -- ...
end

---

---

ButtonReleased

Method

Returns true if any key was released since the last input.

Arguments

None.

Returns

Type	Description
bool	true if released.

Example

if gui.input:button_released() then
    -- ...
end

---

---

WheelDelta

Method

Returns the amount of rows scrolled this input.

Arguments

None.

Returns

Type	Description
float	Rows scrolled.

Example

local scroll = gui.input:WheelDelta();

---

IsMouseUp

Method

Returns true if the mouse key is up (depressed).

Arguments

Name	Type	Description
mb	MouseButton	Mouse button.

Returns

Type	Description
bool	true if depressed.

Example

if gui.input:IsMouseUp(gui.MouseButton.LEFT) then
    -- ...
end

---

IsMouseDown

Method

Returns true if the mouse key is down (pressed).

Arguments

Name	Type	Description
mb	MouseButton	Mouse button.

Returns

Type	Description
bool	true if pressed.

Example

if gui.input:IsMouseDown(gui.MouseButton.LEFT) then
    -- ...
end

---

IsMouseClicked

Method

Returns true if the mouse key is clicked (switched from depressed to pressed state).

Arguments

Name	Type	Description
mb	MouseButton	Mouse button.

Returns

Type	Description
bool	true if clicked.

Example

if gui.input:IsMouseClicked(gui.MouseButton.LEFT) then
    -- ...
end

---

IsMouseReleased

Method

Returns true if the mouse key is released (switched from pressed to depressed state).

Arguments

Name	Type	Description
mb	MouseButton	Mouse button.

Returns

Type	Description
bool	true if released.

Example

if gui.input:IsMouseReleased(gui.MouseButton.LEFT) then
    -- ...
end

---

DidProcessKey

Method

Returns true if any key's state had changed.

Arguments

None.

Returns

Type	Description
bool	true if state changed.

Example

if gui.input:DidProcessKey() then
    -- ...
end

---

IsKeyUp

Method

Returns true if a key is up (depressed).

Arguments

Name	Type	Description
k	int	Virtual key.

Returns

Type	Description
bool	true if depressed.

Example

if gui.input:IsKeyUp(0x41) then -- 0x41 = "A"
    -- ...
end

---

IsKeyDown

Method

Returns true if a key is down (pressed).

Arguments

Name	Type	Description
k	int	Virtual key.

Returns

Type	Description
bool	true if pressed.

Example

if gui.input:IsKeyDown(0x41) then -- 0x41 = "A"
    -- ...
end

---

IsKeyClicked

Method

Returns true if a key is clicked (switched from depressed to pressed state).

Arguments

Name	Type	Description
k	int	Virtual key.

Returns

Type	Description
bool	true if clicked.

Example

if gui.input:IsKeyClicked(0x41) then -- 0x41 = "A"
    -- ...
end

---

IsKeyReleased

Method

Returns true if a key is released (switched from pressed to depressed state).

Arguments

Name	Type	Description
k	int	Virtual key.

Returns

Type	Description
bool	true if released.

Example

if gui.input:IsKeyReleased(0x41) then -- 0x41 = "A"
    -- ...
end