Engine

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

  • The red value of the color.

  • The green value of the color.

  • The blue value of the color.

Methods

Constructors

new

Parameters

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

fromRGB

Parameters

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

fromHSV

Parameters

hue: number
saturation: number
value: number

fromHex

Parameters

hex: string

Properties

The red value of the color.

The green value of the color.

The blue value of the color.

Methods

Lerp

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

ToHSV

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

ToHex

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