Color3

Show Deprecated

The Color3 data type describes a color using red, green, and blue components in the range of 0 to 1. Unlike the BrickColor data type which describes named colors, Color3 is used for precise coloring of objects on screen through properties like BasePart.Color and GuiObject.BackgroundColor3.

Summary

Constructors

Properties

  • R:number

    The red value of the color.

  • G:number

    The green value of the color.

  • B:number

    The blue value of the color.

Methods

Constructors

new

Returns a Color3 with the given red, green, and blue values. The parameters should be within the range of 0 to 1.

local red = Color3.new(1, 0, 0)

local green = Color3.new(0, 1, 0)

local blue = Color3.new(0, 0, 1)

Parameters

red: number
Default Value: 0
green: number
Default Value: 0
blue: number
Default Value: 0

fromRGB

Creates a Color3 with the given red, green, and blue components. Unlike most other Color3 functions, the parameters for this function should be within the range of 0 to 255.

local red = Color3.fromRGB(255, 0, 0)

local green = Color3.fromRGB(0, 255, 0)

local blue = Color3.fromRGB(0, 0, 255)

Parameters

red: number
Default Value: 0
green: number
Default Value: 0
blue: number
Default Value: 0

fromHSV

Creates a Color3 with the given hue, saturation, and value. The parameters should be within the range of 0 to 1.

local red = Color3.fromHSV(1, 1, 1)

local green = Color3.fromHSV(0.3333333, 1, 1)

local white = Color3.fromHSV(0, 0, 1)

Parameters

hue: number
saturation: number
value: number

fromHex

Returns a new Color3 from a six- or three-character hexadecimal format, case insensitive. A preceding hashtag (#) is ignored, if present. This function interprets the given string as a typical web hex color in the format RRGGBB or RGB (shorthand for RRGGBB). For example, #FFAA00 produces an orange color and is the same as #FA0.

local red = Color3.fromHex("FF0000")

local magenta = Color3.fromHex("ec008c")

local black = Color3.fromHex("000")

local white = Color3.fromHex("#FFF")

Parameters

hex: string

Properties

R

number

The red value of the color.

G

number

The green value of the color.

B

number

The blue value of the color.

Methods

Lerp

Color3

Returns a Color3 interpolated between two colors. The alpha value should be within the range of 0 to 1.

local white = Color3.new(1, 1, 1)

local black = Color3.new(0, 0, 0)



local gray10 = white:Lerp(black, 0.1)

print(gray10)  --> 0.9, 0.9, 0.9



local gray50 = white:Lerp(black, 0.5)

print(gray50)  --> 0.5, 0.5, 0.5



local gray85 = white:Lerp(black, 0.85)

print(gray85)  --> 0.15, 0.15, 0.15

Parameters

color: Color3
alpha: number

Returns

Color3

ToHSV

number

Returns the hue, saturation, and value of a Color3. This function is the inverse operation of the Color3.fromHSV() constructor.

local red = Color3.fromRGB(255, 0, 0)

local green = Color3.fromRGB(0, 255, 0)



local redH, redS, redV = red:ToHSV()

print(redH, redS, redV)  --> 1 1 1



local greenH, greenS, greenV = green:ToHSV()

print(greenH, greenS, greenV)  --> 0.3333333 1 1

Returns

number
number
number

ToHex

string

Converts the color to a six-character hexadecimal string representing the color in the format RRGGBB. It is not prefixed with an octothorpe (#).

The returned string can be provided to Color3.fromHex() to produce the original color.

local red = Color3.fromRGB(255, 0, 0)

local magenta = Color3.fromRGB(236, 0, 140)



local redHex = red:ToHex()

print(redHex)  --> ff0000



local magentaHex = magenta:ToHex()

print(magentaHex)  --> ec008c

Returns

string