Returns a sequence of two keypoints with `c` for both the start and end
values.

```lua
local cs = ColorSequence.new(c)
-- is equivalent to
local cs = ColorSequence.new{
    ColorSequenceKeypoint.new(0, c),
    ColorSequenceKeypoint.new(1, c)
}
```

ColorSequence.new

Returns a new `Datatype.ColorSequence` that is entirely the specified color.

Returns a new `Datatype.ColorSequence` with `c0` as the start value and `c1` as the
end value.

```lua
local cs = ColorSequence.new(c0, c1)
-- is equivalent to
local cs = ColorSequence.new{
    ColorSequenceKeypoint.new(0, c0),
    ColorSequenceKeypoint.new(1, c1)
}
```

Returns a new `Datatype.ColorSequence` with `c0` as the start value and `c1` as the
end value.

Returns a sequence given an array of `ColorSequenceKeypoints`. The
keypoints must be in a non-descending time value order. At least
two keypoints must be provided, and they must have a time value of `0`
(first) and `1` (last).

```lua
local white = Color3.new(1, 1, 1)
local lightBlue = Color3.new(0, 2/3, 1)
local yellow = Color3.new(1, 1, 0)
local cs = ColorSequence.new{
    ColorSequenceKeypoint.new(0, white),
    ColorSequenceKeypoint.new(0.25, lightBlue),
    ColorSequenceKeypoint.new(0.5, white),
    ColorSequenceKeypoint.new(0.75, yellow),
    ColorSequenceKeypoint.new(1, white)
}
```

keypoints

Returns a new `Datatype.ColorSequence` comprised of the provided
`ColorSequenceKeypoints`.

The `Datatype.ColorSequence` data type represents a gradient of color values
from `0` to `1`. The color values are expressed using the
`Datatype.ColorSequenceKeypoint` type. This type is used in various properties
of `Class.ParticleEmitter`, `Class.Trail`, and `Class.Beam`. In Studio, this
data type is edited using a gradient editor:

![Editing the Color property of a ParticleEmitter within Studio. The gradient
shows 5 `Datatype.ColorSequenceKeypoint` at times 0, 0.25, 0.5, 0.75 and 1. The 2nd and
4th are blue and yellow, respectively.](/assets/legacy/ParticleEmitter.Color.jpg)

The above gradient can be set using a script using the following call to
`Datatype.ColorSequence.new()`:

```lua
local white = Color3.new(1, 1, 1)
local lightBlue = Color3.new(0, 2/3, 1)
local yellow = Color3.new(1, 1, 0)
particleEmitter.Color = ColorSequence.new{
    ColorSequenceKeypoint.new(0, white),
    ColorSequenceKeypoint.new(0.25, lightBlue),
    ColorSequenceKeypoint.new(0.5, white),
    ColorSequenceKeypoint.new(0.75, yellow),
    ColorSequenceKeypoint.new(1, white)
}
```

## Equality

Two `Datatype.ColorSequence` objects are equivalent if and only if the values
of their `Datatype.ColorSequenceKeypoint` are equivalent, even if the two
`Datatype.ColorSequence` would result in similar gradients.

## Evaluation

The `Datatype.ColorSequence` type does not have a built-in method for getting
the value at a certain time/point. However, you can use the following function
to evaluate at a specific time.

```lua
function evalCS(cs, time)
	-- If we are at 0 or 1, return the first or last value respectively
	if time == 0 then return cs.Keypoints[1].Value end
	if time == 1 then return cs.Keypoints[#cs.Keypoints].Value end
	-- Step through each sequential pair of keypoints and see if alpha
	-- lies between the points' time values.
	for i = 1, #cs.Keypoints - 1 do
		local this = cs.Keypoints[i]
		local next = cs.Keypoints[i + 1]
		if time >= this.Time and time < next.Time then
			-- Calculate how far alpha lies between the points
			local alpha = (time - this.Time) / (next.Time - this.Time)
			-- Evaluate the real value between the points using alpha
			return Color3.new(
				(next.Value.R - this.Value.R) * alpha + this.Value.R,
				(next.Value.G - this.Value.G) * alpha + this.Value.G,
				(next.Value.B - this.Value.B) * alpha + this.Value.B
			)
		end
	end
end
```

You can use the function above like this:

```lua
local cs = ColorSequence.new{
    ColorSequenceKeypoint.new(0, BrickColor.new("Really red").Color),
    ColorSequenceKeypoint.new(1, BrickColor.new("Really blue").Color)
}
print(evalCS(cs, 0.5))
-- 0.5, 0, 0.5 (purple, since it's halfway between red and blue)
```


ColorSequence

An array containing `Datatype.ColorSequenceKeypoint` values for the
`Datatype.ColorSequence`.


ColorSequence.Keypoints

An array of `Datatype.ColorSequenceKeypoint` values in ascending order.


A gradient of color values comprised of `Datatype.ColorSequenceKeypoint`s.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

ColorSequence

Summary

Constructors

Properties

Constructors

new

Parameters

new

Parameters

new

Parameters

Properties

Keypoints