NSpinBox

A numerical entry box that allows for direct entry of the number or allows the user to click and slide the number.

This class shares methods and events from Base Widget.

🦠 Functions

SetBackgroundBrush

NSpinBox:SetBackgroundBrush(NormalBrush, ActiveBrush, HoveredBrush)

Type	Parameter	Description
Brush	NormalBrush
Brush	ActiveBrush
Brush	HoveredBrush

SetFillBrush

NSpinBox:SetFillBrush(ActiveBrush, HoveredBrush, InactiveBrush)

Type	Parameter	Description
Brush	ActiveBrush
Brush	HoveredBrush
Brush	InactiveBrush

SetArrowBrush

NSpinBox:SetArrowBrush(Brush)

Type	Parameter	Description
Brush	Brush

SetSpinValue

NSpinBox:SetSpinValue(NewValue)

Type	Parameter	Description
number	NewValue

GetSpinValue

— Returns number.

local ret = NSpinBox:GetSpinValue()

SetMinValue

NSpinBox:SetMinValue(NewMinValue)

Type	Parameter	Description
number	NewMinValue

GetMinValue

— Returns number.

local ret = NSpinBox:GetMinValue()

SetMaxValue

NSpinBox:SetMaxValue(NewMaxValue)

Type	Parameter	Description
number	NewMaxValue

GetMaxValue

— Returns number.

local ret = NSpinBox:GetMaxValue()

SetMinSliderValue

NSpinBox:SetMinSliderValue(NewMinSliderValue)

Type	Parameter	Description
number	NewMinSliderValue

GetMinSliderValue

— Returns number.

local ret = NSpinBox:GetMinSliderValue()

SetMaxSliderValue

NSpinBox:SetMaxSliderValue(NewMaxSliderValue)

Type	Parameter	Description
number	NewMaxSliderValue

GetMaxSliderValue

— Returns number.

local ret = NSpinBox:GetMaxSliderValue()

SetDelta

NSpinBox:SetDelta(NewDelta)

Type	Parameter	Description
number	NewDelta

GetDelta

— Returns number.

local ret = NSpinBox:GetDelta()

SetTextColor

NSpinBox:SetTextColor(Color)

Type	Parameter	Description
Color	Color

SetEnableSlider

NSpinBox:SetEnableSlider(EnableSlider?)

Type	Parameter	Description
boolean	EnableSlider?

SetAlwaysUsesDeltaSnap

NSpinBox:SetAlwaysUsesDeltaSnap(AlwaysUse?)

Type	Parameter	Description
boolean	AlwaysUse?

SetMinFractionalDigits

NSpinBox:SetMinFractionaLDigits(MinFractionalDigits)

Type	Parameter	Description
number	MinFractionalDigits

SetMaxFractionalDigits

NSpinBox:SetMaxFractionaLDigits(MaxFractionalDigits)

Type	Parameter	Description
number	MaxFractionalDigits

SetFont

NSpinBox:SetFont(Font, Typeface)

Type	Parameter	Description
Special Path	Font	.TTF Special Path
string	Typeface

SetFontMaterial

NSpinBox:SetFontMaterial(InMaterial)

Type	Parameter	Description
MaterialInstanceDynamic	InMaterial

SetFontMaterial

NSpinBox:SetFontMaterial(InMaterial)

Type	Parameter	Description
MaterialInstanceDynamic	InMaterial

SetFontSize

NSpinBox:SetFontSize(Size)

Type	Parameter	Description
number	Size

SetLetterSpacing

NSpinBox:SetLetterSpacing(InLetterSpacing)

Type	Parameter	Description
number	InLetterSpacing

SetSkew

NSpinBox:SetSkew(InSkewAmount)

Type	Parameter	Description
number	InSkewAmount

SetOutlineSettings

NSpinBox:SetOutlineSettings(Settings)

Type	Parameter	Description
FontOutlineSettings	Settings

SetJustification

NSpinBox:SetJustification(InJustification)

Type	Parameter	Description
WGui.TextJustify	InJustification

🚀 Events

On Value Changed

Triggered when the value is changed interactively by the user

NSpinBox.OnValueChanged = function(NewValue)
    -- On Value Changed was called
end)

On Value Committed

Triggered when the value is committed. Occurs when the user presses Enter or the text box loses focus.

NSpinBox.OnValueCommitted = function(NewValue)
    -- On Value Committed was called
end)

On Begin Slider Movement

Triggered right before the slider begins to move

NSpinBox.OnBeginSliderMovement = function()
    -- On Begin Slider Movement was called
end)

On End Slider Movement

Triggered right after the slider is released by the user.

NSpinBox.OnEndSliderMovement = function(NewValue)
    -- On End Slider Movement was called
end)