NCheckBox

The checkbox widget allows you to display a toggled state of 'unchecked' and 'checked'.

This class shares methods and events from Panel Widget.

🦠 Functions

SetIsChecked

NCheckBox:SetIsChecked(IsChecked)

Type	Parameter	Description
boolean	IsChecked

GetIsChecked

— Returns boolean.

local ret = NCheckBox:GetIsChecked()

SetBrush

NCheckBox:SetBrush(NormalBrush, HoveredBrush, PressedBrush)

Type	Parameter	Description
Brush	NormalImage
Brush	HoveredImage
Brush	PressedImage

GetBrush

— Returns table of Brush.

local ret = NCheckBox:GetBrush()

SetUncheckedBrush

NCheckBox:SetUncheckedBrush(NormalImage, HoveredImage, PressedImage)

Type	Parameter	Description
Brush	NormalImage
Brush	HoveredImage
Brush	PressedImage

GetUncheckedBrush

— Returns table of Brush.

local ret = NCheckBox:GetUncheckedBrush()

SetCheckedBrush

NCheckBox:SetCheckedBrush(NormalImage, HoveredImage, PressedImage)

Type	Parameter	Description
Brush	NormalImage
Brush	HoveredImage
Brush	PressedImage

GetCheckedBrush

— Returns table of Brush.

local ret = NCheckBox:GetCheckedBrush()

🚀 Events

On Checked

Triggered when the checked state changes

NCheckBox.OnChecked = function(IsChecked)
    -- On Checked was called
end)