Utility Functions

Location: addon_suite/util

Color

Location: addon_suite/util/color

There are two types of color used, RGBColor and ColorTable. The former is preferred, as ColorTable is deprecated.

RGBColor

Example: Create Laser violet as an RGBColor

local laserViolet = {
    r = 204,
    g = 153,
    b = 255
}

to_rgb

Converts a color to RGBColor

Arguments

Example: Create Laser violet as an RGBColor

local laserViolet = to_rgb(0xcc99ff)

hue_to_rgb

Arguments:

Converts a hue to an RGBColor. This is currently not exact, and is subject to change the internal math.

color_lerp

color_to_srgb

Converts a RGBColor to be interpreted in srgb. Useful for displaying in linear color gammas - such as LEDs.

hex_to_srgb

Same as color_to_srgb, except it takes in a hex value

Example: Make the sign laser violet

local laserViolet = hex_to_srgb(0xcc99ff)
sign:add(0, set(laserViolet.r, laserViolet.g, laserViolet.g))

local laserViolet = {
    204,
    153,
    255
}

local laserViolet = rgb_color_to_rgb_table({
    r = 204,
    g = 153,
    b = 255
})

Strings

Location: addon_suite/util/strings

pad_number_to_string_length

Pads a string or number to be at least the specified length

Arguments