Color

Inherits: Class

Methods

ColorText

function Color:ColorText(text)
  -> string

Colors a text string with the color.

Parameters:

Name	Type	Description
text	string | number	The text string to color

Returns:

Type	Description
string

GetFractionalRGBA

function Color:GetFractionalRGBA()
  -> number, number, number, number

Gets the RGBA values of the color as values from 0 to 1.

Returns:

Name	Type	Description
r	number
g	number
b	number
a	number

GetHex

function Color:GetHex()
  -> string

Gets the hex string representation of the color.

Returns:

Type	Description
string

GetHexNoAlpha

function Color:GetHexNoAlpha()
  -> string

Gets the hex string representation of the color without the alpha channel.

Returns:

Type	Description
string

GetOpacity

function Color:GetOpacity(opacityPct)
  -> self

Gets a version of the color with a different opacity.

Parameters:

Name	Type	Description
opacityPct	number	The opacity percentage

Returns:

Type	Description
self

GetRGBA

function Color:GetRGBA()
  -> number, number, number, number

Gets the RGBA values of the color as values from 0 to 255.

Returns:

Name	Type	Description
r	number
g	number
b	number
a	number

GetTextColorPrefix

function Color:GetTextColorPrefix()
  -> string

Gets the prefix used to color a text string.

Returns:

Type	Description
string

GetTint

function Color:GetTint(tintPct)
  -> self

Gets a tinted version of the color.

Parameters:

Name	Type	Description
tintPct	number	The tint percent

Returns:

Type	Description
self

IsLight

function Color:IsLight()
  -> boolean

Returns whether or not the color is considered light.

Returns:

Type	Description
boolean

SetRGBA

function Color:SetRGBA(r, g, b, a)

Sets the RGBA values of the color as values from 0 to 255.

Parameters:

Name	Type	Description
r	number
g	number
b	number
a	number

__equals

function Color:__equals(other)

Parameters:

Name	Type	Description
other	``

__init

function Color:__init(r, g, b, a)

Parameters:

Name	Type	Description
r	``
g	``
b	``
a	``

__tostring

function Color:__tostring()

Functions

HexToRGBA

function Color.HexToRGBA(hex)
  -> number, number, number, number

Converts a hex string into an RGB value.

Parameters:

Name	Type	Description
hex	string	The hex string

Returns:

Name	Type	Description
r	number
g	number
b	number
a	number

IsColorValue

function Color.IsColorValue(arg)
  -> boolean

Returns whether or not the argument is a color value object.

Parameters:

Name	Type	Description
arg	any	The argument to check

Returns:

Type	Description
boolean

IsValidHexRGB

function Color.IsValidHexRGB(str)
  -> boolean

Returns whether or not the passed string is a valid hex RGB string.

Parameters:

Name	Type	Description
str	string	The value to check

Returns:

Type	Description
boolean

NewFromHex

function Color.NewFromHex(hex)
  -> Color

Create a new color value object from a hex string.

Parameters:

Name	Type	Description
hex	string	The hex string which represents the color (in either "#AARRGGBB" or "#RRGGBB" format)

Returns:

Type	Description
Color