s&box docs
API ReferenceSandbox

Gradientclass

Describes a gradient between multiple colors

object→Gradient
Namespace
Sandbox
Assembly
Sandbox.System
Declaration
public sealed struct Sandbox.Gradient

Constructors2

Showing 2 constructors

Methods8

Showing 8 methods

public Color Evaluate(float time)PUBLIC

Evaluate the blend using the time, which is generally between 0 and 1

ParameterTypeDescription
timefloat—
Returns:Color—

public void FixOrder()PUBLIC

If the lists aren't in time order for some reason, this will fix them. This should really just be called when serializing, and in every other situation we should assume they're okay.

Returns:void—

public static Sandbox.Gradient FromColors(Color[] colors)PUBLICSTATIC

Create a gradient from colors spaced out evenly

ParameterTypeDescription
colorsColor[]—
Returns:Gradient—

Properties4

Showing 4 properties

public System.Collections.Immutable.ImmutableList`1<Sandbox.Gradient.AlphaFrame> Sandbox.Gradient.Alphas { get; set; }PUBLICGETSET

A list of color stops, which should be ordered by time

Returns:ImmutableList<AlphaFrame>—

public System.Collections.Immutable.ImmutableList`1<Sandbox.Gradient.ColorFrame> Sandbox.Gradient.Colors { get; set; }PUBLICGETSET

A list of color stops, which should be ordered by time

Returns:ImmutableList<ColorFrame>—

Related Guides

→Custom Editors→Fog→Style Properties→Texture Generators

SetData()

Previous Page

Alphas

Next Page

On this page

Constructorspublic Gradient()public Gradient(Sandbox.Gradient.ColorFrame[] frames)Methodspublic System.Int32 AddAlpha(Sandbox.Gradient.AlphaFrame keyframe)public System.Int32 AddAlpha(System.Single x, System.Single alpha)public System.Int32 AddColor(Sandbox.Gradient.ColorFrame keyframe)public System.Int32 AddColor(System.Single x, Color color)public Color Evaluate(System.Single time)public System.Void FixOrder()public static Sandbox.Gradient FromColors(Color[] colors)public Sandbox.Gradient WithFrames(System.Collections.Immutable.ImmutableList`1<Sandbox.Gradient.ColorFrame> frames)Propertiespublic System.Collections.Immutable.ImmutableList`1<Sandbox.Gradient.AlphaFrame> Sandbox.Gradient.Alphas { get; set; }public Sandbox.Gradient.BlendMode Sandbox.Gradient.Blending { get; set; }public System.Collections.Immutable.ImmutableList`1<Sandbox.Gradient.ColorFrame> Sandbox.Gradient.Colors { get; set; }public Sandbox.Gradient.ColorFrame Sandbox.Gradient.Item { get; set; }Metadata