LuaControl

This type represents the base for a control. It is used to create custom controls that perform any user-defined functionalities.

This is just a control type, to learn how to create custom controls, see LuaControlProto documentation. A proper example on how to use both types can be found here.

__call

Constructor

Constructs the custom control.

Arguments

Name	Type	Description
id	ControlID|string	ID.
proto	LuaControlProto	Prototype for this control
position	Vec2	Custom offset
size	Vec2	Custom size

Returns

Type	Description
Control	Custom control instance.

Example

local proto = gui.LuaControlProto()

function proto:onRender(contents, _, mins, maxs)
    contents:AddRectFilled(draw.Rect(mins, maxs), draw.color.White())
end

local my_custom_control = gui.LuaControl('my_control', proto, draw.Vec2(), draw.Vec2(24, 24))

---

data

Field

Type: table<any>

This control's internal data, specified by initialData in LuaControlProto . Can be modified.

---

IsOutOfRect

Method

Checks if control is outside of a rectangle.

Arguments

Name	Type	Description
rect	Rect	The desired rectangle

Returns

Type	Description
boolean	Whether or not it is outside

Example

if control:IsOutOfRect(gui.GetMainWindow():GetArea()) then
    error('You probably messed something up')
end

---

IsOutOfClip

Method

Checks if control is outside of a rectangle, with some tolerance.

Arguments

Name	Type	Description
rect	Rect	The desired rectangle
tolerance	number	The tolerance, in pixels

Returns

Type	Description
boolean	Whether or not it is outside

Example

if control:IsOutOfClip(draw.Rect(gui.input:Cursor()):Size(control.size), 5) then
    print('Not hovering')
end

---

Highlight

Method

Highlights the control temporarily and switches to that tab, if applicable.

Arguments

None.

Returns

Nothing.

Example

control:Highlight()

---

LockInput

Method

Locks all input, making sure you can't access other controls. Useful for controls you click or drag on.

Make sure to call UnlockInput after you're done.

Arguments

None.

Returns

Nothing.

Example

control:LockInput()

---

UnlockInput

Method

Unlocks all input.

Arguments

None.

Returns

Nothing.

Example

control:UnlockInput()

---

IsLockedByMe

Method

Checks if the window input is locked by this control.

Arguments

None.

Returns

Type	Description
boolean	Whether or not the window is locked by this control

Example

if control:IsLockedByMe() then
    print('Input is exclusive to this control')
end

---

IsLockedByOther

Method

Checks if the window input is locked by another control.

Arguments

None.

Returns

Type	Description
boolean	Whether or not the window is locked by another control

Example

if control:IsLockedByOther() then
    print('Need to wait for input.')
end

---

IsInputLocked

Method

Checks if the window input is locked.

Arguments

None.

Returns

Type	Description
boolean	Whether or not the window is locked

Example

if control:IsInputLocked() then
    print('Locked!')
end