Skip to content

Color

Generic typessource

-- make a semi transparent red color and print it in different formats
local color = Color:red()
color.a = 0.5
local r, g, b, a = color:get_rgba()
prinspect(r, g, b, a) -- 255, 0, 0, 128
prinspect(color.r, color.g, color.b, color.a) -- 1.0, 0.0, 0.0, 0.5
prinspect(string.format("%x"), color:get_ucolor()) -- 800000ff

Constructors

function Color.new(): Color

Returns Color

function Color.new(other: Color): Color
other: Color

Returns Color

function Color.new(r_: number, g_: number, b_: number, a_: number): Color
r_: number
g_: number
b_: number
a_: number

Returns Color

function Color.new(color_name: string, alpha?: integer): Color
color_name: string
alpha?: integeroptional

Returns Color

Fields

a

number

source

b

number

source

g

number

source

r

number

source

Methods

aqua

function Color.aqua(): Color

Returns Color

source

black

function Color.black(): Color

Returns Color

source

blue

function Color.blue(): Color

Returns Color

source

fuchsia

function Color.fuchsia(): Color

Returns Color

source

get_rgba

function Color:get_rgba(): integer, integer, integer, integer

Returns integer, integer, integer, integer

source

get_ucolor

function Color:get_ucolor(): uColor

Returns uColor

source

gray

function Color.gray(): Color

Returns Color

source

green

function Color.green(): Color

Returns Color

source

lime

function Color.lime(): Color

Returns Color

source

maroon

function Color.maroon(): Color

Returns Color

source
function Color.navy(): Color

Returns Color

source

olive

function Color.olive(): Color

Returns Color

source

purple

function Color.purple(): Color

Returns Color

source

red

function Color.red(): Color

Returns Color

source

set

function Color:set(other: Color): Color
other: Color

Returns Color

Copies the values of different Color to this one

source

set_rgba

function Color:set_rgba(red: integer, green: integer, blue: integer, alpha: integer): Color
red: integer
green: integer
blue: integer
alpha: integer

Returns Color

Changes color based on given RGBA colors in 0..255 range

source

set_ucolor

function Color:set_ucolor(color: integer): Color
color: integer

Returns Color

Changes color based on given uColor

source

silver

function Color.silver(): Color

Returns Color

source

teal

function Color.teal(): Color

Returns Color

source

white

function Color.white(): Color

Returns Color

source

yellow

function Color.yellow(): Color

Returns Color

source

Operators

equal_to

function Color:equal_to(col: Color): boolean
col: Color

Returns boolean

metamethodsource