Zum Hauptinhalt springen
Version: bleeding-edge 🩸

🎨 Color

A color composed of components (R, G, B, A) with floating point precision


🎒 Examples​

local grey_color = Color(0.5, 0.5, 0.5, 1)

🛠 Constructors​

Default Constructor​

No description provided

local my_color = Color(R?, G?, B?, A?)
Parameters
NameTypeDescription
R?floatRed color percentage (0-1) Default 0
G?floatGreen color percentage (0-1) Default X
B?floatBlue color percentage (0-1) Default X
A?floatAlpha transparency percentage (0-1) Default 1

🧽 Properties​

TypeNameDescription
floatRRed color percentage (0-1)
floatGGreen color percentage (0-1)
floatBBlue color percentage (0-1)
floatAAlpha transparency percentage (0-1)

🦠 Functions​

info

This structure supports +, -, *, /, ==, and tostring operations.

ToHex: stringGets the Hexadecimal representation of this Color

ToHexOptimal​

Gets the Hexadecimal representation of this Color

local ret = my_color:ToHex(appends_transparency?)
Parameters
NameTypeDescription
appends_transparency?booleanAppends transparency part Default true
Returns
TypeDescription
stringHexadecimal representation of this Color

🗼 Static Properties​

ValueName
Color(1, 1, 1)Color.WHITE
Color(0, 0, 0)Color.BLACK
Color(0, 0, 0, 0)Color.TRANSPARENT
Color(1, 0, 0)Color.RED
Color(0, 1, 0)Color.GREEN
Color(0, 0, 1)Color.BLUE
Color(1, 1, 0)Color.YELLOW
Color(0, 1, 1)Color.CYAN
Color(1, 0, 1)Color.MAGENTA
Color(1, 0.5, 0)Color.ORANGE
Color(0.5, 1, 1)Color.CHARTREUSE
Color(0, 1, 0.5)Color.AQUAMARINE
Color(0, 0.5, 1)Color.AZURE
Color(0.5, 0, 1)Color.VIOLET
Color(1, 0, 0.5)Color.ROSE

🗿 Static Functions​

RandomPalette: ColorReturns a random color from Color Palette
Random: ColorReturns a random color from all color scope
FromRGBA: ColorReturns the color from 0-255 range values
FromCYMK: ColorReturns a color from the CYMK format
FromHSL: ColorReturns a color from the HSL format
FromHSV: ColorReturns a color from the HSV format
FromHEX: ColorReturns a color from the Hexadecimal format

RandomPaletteOptimal​

Returns a random color from Color Palette

local ret = Color.RandomPalette(includes_black?)
Parameters
NameTypeDescription
includes_black?booleanIncludes blacks in the scope Default true
Returns
TypeDescription
ColorRandom color from Color Palette

RandomOptimal​

Returns a random color from all color scope

local ret = Color.Random()
Returns
TypeDescription
ColorRandom color from all color scope

FromRGBAOptimal​

Returns the color from 0-255 range values

local ret = Color.FromRGBA(r?, g?, b?, a?)
Parameters
NameTypeDescription
r?floatRed Default 0
g?floatGreen Default 0
b?floatBlue Default 0
a?floatAlpha Default 0
Returns
TypeDescription
ColorFinal Color

FromCYMKOptimal​

Returns a color from the CYMK format

local ret = Color.FromCYMK(c?, y?, m?, k?, a?)
Parameters
NameTypeDescription
c?floatCyan Default 0
y?floatYellow Default 0
m?floatMagenta Default 0
k?floatBlack Default 0
a?floatAlpha Default 0
Returns
TypeDescription
ColorFinal Color

FromHSLOptimal​

Returns a color from the HSL format

local ret = Color.FromHSL(h?, s?, l?)
Parameters
NameTypeDescription
h?floatHue Default 0
s?floatSaturation Default 0
l?floatLightness Default 0
Returns
TypeDescription
ColorFinal Color

FromHSVOptimal​

Returns a color from the HSV format

local ret = Color.FromHSV(h?, s?, v?)
Parameters
NameTypeDescription
h?floatHue Default 0
s?floatSaturation Default 0
v?floatValue Default 0
Returns
TypeDescription
ColorFinal Color

FromHEXOptimal​

Returns a color from the Hexadecimal format

local ret = Color.FromHEX(hex)
Parameters
NameTypeDescription
hexstringHexadecimal
Returns
TypeDescription
ColorFinal Color