Show / Hide Table of Contents

Class FadeTextSurfaceTint

Animates a color change to Tint.

Inheritance
object
UpdateComponent
InstructionBase
Wait
AnimatedValue
FadeTextSurfaceTint
Implements
IComponent
Inherited Members
AnimatedValue.EasingFunction
AnimatedValue.Reset(TimeSpan, double, double, EasingBase)
AnimatedValue.Reset()
AnimatedValue.Value
AnimatedValue.StartingValue
AnimatedValue.EndingValue
AnimatedValue.ValueChanged
Wait.CountedTime
Wait.Duration
InstructionBase.Repeat()
InstructionBase.OnFinished(IScreenObject)
InstructionBase.OnRepeating()
InstructionBase.OnStarted()
InstructionBase.RemoveOnFinished
InstructionBase.IsFinished
InstructionBase.RepeatCount
InstructionBase.Started
InstructionBase.Finished
InstructionBase.Repeating
UpdateComponent.OnAdded(IScreenObject)
UpdateComponent.OnRemoved(IScreenObject)
UpdateComponent.SortOrder
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: SadConsole.Instructions
Assembly: SadConsole.dll
Syntax
public class FadeTextSurfaceTint : AnimatedValue, IComponent

Constructors

FadeTextSurfaceTint()

Creates a new tint fade instruction with default settings that uses the console passed to Update(IScreenObject, TimeSpan).

Declaration
public FadeTextSurfaceTint()
Remarks

The default settings are:

  • Colors: White to Black
  • Duration: 1 second

FadeTextSurfaceTint(IScreenSurface, Gradient, TimeSpan)

Creates a new tint fade instruction that targets the specified console.

Declaration
public FadeTextSurfaceTint(IScreenSurface objectSurface, Gradient colors, TimeSpan duration)
Parameters
Type Name Description
IScreenSurface objectSurface

The Tint to fade.

Gradient colors

The gradient pattern to fade through.

TimeSpan duration

How long the fade takes.

FadeTextSurfaceTint(Gradient, TimeSpan)

Creates a new tint fade instruction that uses the console passed to Update(IScreenObject, TimeSpan).

Declaration
public FadeTextSurfaceTint(Gradient colors, TimeSpan duration)
Parameters
Type Name Description
Gradient colors

The gradient pattern to fade through.

TimeSpan duration

How long the fade takes.

Properties

Colors

The color to fade the tint to.

Declaration
public Gradient Colors { get; set; }
Property Value
Type Description
Gradient

Methods

Update(IScreenObject, TimeSpan)

Updates the timer with the time since the last call.

Declaration
public override void Update(IScreenObject componentHost, TimeSpan delta)
Parameters
Type Name Description
IScreenObject componentHost
TimeSpan delta

The time since the last frame update.

Overrides
AnimatedValue.Update(IScreenObject, TimeSpan)

Implements

IComponent

Extension Methods

ExtensionsSystem.GetDebuggerDisplayValue(object)
In this article

Back to top

Back to top Generated by DocFX