LuaControlProto

This type represents the prototype for controls, encapsulating all of its fields and methods.

This is just a prototype and must be constructed into a LuaControl. You may use self inside any overridden methods to access the underlying LuaControl.

__call

Constructor

Constructs the control prototype.

Arguments

None

Returns

Type	Description
LuaControlProto	The prototype

Example

local proto = gui.LuaControlProto()

---

initialData

Field

Type: table<any>

This table contains all the initial values held by this prototype. Is propagated to all controls created with this prototype.

---

onRender

MethodOverridable

Called every time the control is rendered.

Arguments

Name	Type	Description
contents	Layer	The main drawing layer
scrollbar	Layer	The secondary drawing layer
mins	Vec2	The top left corner of the control
maxs	Vec2	The bottom right corner of the control

Returns

Nothing.

Example

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

---

onReset

MethodOverridable

Called every time the control is reset.

Arguments

None.

Returns

Nothing.

Example

function proto:onReset()
    print('Reset!')
end

---

onFirstRenderCall

MethodOverridable

Called on the first time the control is rendered.

Arguments

None.

Returns

Nothing.

Example

function proto:onFirstRenderCall()
    print('Rendered for the first time!')
end

---

onMouseDown

MethodOverridable

Called whenever the user clicks a mouse button inside the control.

Arguments

Name	Type	Description
key	MouseButton	The pressed key

Returns

Nothing.

Example

function proto:onMouseDown(key)
    if key == gui.MouseButton.LEFT then
        print('Clicked!')
    end
end

---

onMouseUp

MethodOverridable

Called whenever the user releases a mouse button inside the control.

Arguments

Name	Type	Description
key	MouseButton	The pressed key

Returns

Nothing.

Example

function proto:onMouseUp(key)
    if key == gui.MouseButton.RIGHT then
        print('Released!')
    end
end

---

onMouseMove

MethodOverridable

Called whenever the user moves their mouse inside the control.

Arguments

Name	Type	Description
absolutePosition	Vec2	The absolute cursor position
delta	Vec2	The difference between current and last cursor position
relativePosition	Vec2	The relative cursor position (to control's mins)

Returns

Nothing.

Example

function proto:onMouseMove(absolutePos)
    mousePos = absolutePos
end

---

onMouseEnter

MethodOverridable

Called once when the user moves their mouse into the control.

Arguments

None.

Returns

Nothing.

Example

function proto:onMouseEnter()
    isInside = true
end

---

onMouseLeave

MethodOverridable

Called once when the user moves their mouse out the control.

Arguments

None.

Returns

Nothing.

Example

function proto:onMouseLeave()
    isInside = false
end

---

onMouseWheel

MethodOverridable

Called once when the user scrolls inside the control.

Arguments

Name	Type	Description
delta	number	The scroll wheel delta and direction

Returns

Nothing.

Example

function proto:onMouseWheel(delta)
    internalValue = internalValue + delta
end

---

onKeyDown

MethodOverridable

Called once when the user presses a key inside this control.

Requires LuaControl field isTakingKeys to be set to true.

Arguments

Name	Type	Description
key	number	The pressed key

Returns

Nothing.

Example

function proto:onKeyDown(key)
    if key == 0x20 then
        print('Space is pressed')
    end
end

---

onKeyUp

MethodOverridable

Called once when the user releases a key inside this control.

Requires LuaControl field isTakingKeys to be set to true.

Arguments

Name	Type	Description
key	number	The pressed key

Returns

Nothing.

Example

function proto:onKeyUp(key)
    if key == 0x10 then
        print('Shift is released')
    end
end

---

onTextInput

MethodOverridable

Called once when the user types text inside this control.

Requires LuaControl field isTakingText to be set to true.

Arguments

Name	Type	Description
keys	table<number>	The pressed characters list, in unicode

Returns

Nothing.

Example

function proto:onTextInput(keys)
    print(string.char(unpack(keys)))
end