🎨 Color

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

👐Open Source🧑‍💻API Source

---

🎒 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

Type	Name	Default	Description
float	R	0	Red color percentage (0-1)
float	G	X	Green color percentage (0-1)
float	B	X	Blue color percentage (0-1)
float	A	1	Alpha transparency percentage (0-1)

🧽 Properties

Type	Name	Description
float	R	Red color percentage (0-1)
float	G	Green color percentage (0-1)
float	B	Blue color percentage (0-1)
float	A	Alpha transparency percentage (0-1)

🦠 Functions

info

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

	Returns	Name	Description
	string	ToHex	Gets the Hexadecimal representation of this Color

---

Optimal

ToHex

Gets the Hexadecimal representation of this Color

local ret = my_color:ToHex(appends_transparency?)

Parameters

Type	Parameter	Default	Description
boolean	appends_transparency?	true	Appends transparency part

Returns

Type	Description
string	Hexadecimal representation of this Color

🗼 Static Properties

Value	Name
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

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

---

Optimal

RandomPalette

Returns a random color from Color Palette

local ret = Color.RandomPalette(includes_black?)

Parameters

Type	Parameter	Default	Description
boolean	includes_black?	true	Includes blacks in the scope

Returns

Type	Description
Color	Random color from Color Palette

---

Optimal

Random

Returns a random color from all color scope

local ret = Color.Random()

Returns

Type	Description
Color	Random color from all color scope

---

Optimal

FromRGBA

Returns the color from 0-255 range values

local ret = Color.FromRGBA(r?, g?, b?, a?)

Parameters

Type	Parameter	Default	Description
float	r?	0	Red
float	g?	0	Green
float	b?	0	Blue
float	a?	0	Alpha

Returns

Type	Description
Color	Final Color

---

Optimal

FromCYMK

Returns a color from the CYMK format

local ret = Color.FromCYMK(c?, y?, m?, k?, a?)

Parameters

Type	Parameter	Default	Description
float	c?	0	Cyan
float	y?	0	Yellow
float	m?	0	Magenta
float	k?	0	Black
float	a?	0	Alpha

Returns

Type	Description
Color	Final Color

---

Optimal

FromHSL

Returns a color from the HSL format

local ret = Color.FromHSL(h?, s?, l?)

Parameters

Type	Parameter	Default	Description
float	h?	0	Hue
float	s?	0	Saturation
float	l?	0	Lightness

Returns

Type	Description
Color	Final Color

---

Optimal

FromHSV

Returns a color from the HSV format

local ret = Color.FromHSV(h?, s?, v?)

Parameters

Type	Parameter	Default	Description
float	h?	0	Hue
float	s?	0	Saturation
float	v?	0	Value

Returns

Type	Description
Color	Final Color

---

Optimal

FromHEX

Returns a color from the Hexadecimal format

local ret = Color.FromHEX(hex)

Parameters

Type	Parameter	Default	Description
string	hex	Required parameter	Hexadecimal

Returns

Type	Description
Color	Final Color