Class FlowOptions

Namespace

FriedSynapse.FlowEnt

Provides options for flows.

public class FlowOptions : AbstractAnimationOptions

Inheritance

object

AbstractAnimationOptions

FlowOptions

Inherited Members

AbstractAnimationOptions.DefaultLoopCount

AbstractAnimationOptions.DefaultTimeScale

AbstractAnimationOptions.Name

AbstractAnimationOptions.UpdateType

AbstractAnimationOptions.AutoStart

AbstractAnimationOptions.SkipFrames

AbstractAnimationOptions.Delay

AbstractAnimationOptions.DelayUntil

AbstractAnimationOptions.TimeScale

AbstractAnimationOptions.LoopCount

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

CommonExtensions.Echo<TItem>(TItem, EchoOptions)

CommonExtensions.Echo<TItem>(TItem, float?, bool)

CommonExtensions.Tween<TItem>(TItem, TweenOptions)

CommonExtensions.Tween<TItem>(TItem, float, bool)

Constructors

FlowOptions()

Initialises a new instance of the FlowOptions class.

public FlowOptions()

Methods

SetAutoStart(bool)

Sets whether this animation should auto-start or not.

public FlowOptions SetAutoStart(bool autoStart)

Parameters

autoStart bool

Returns

FlowOptions

Remarks

Auto-start will be slower than a true-start. See more at https://flowent.friedsynapse.com/tips#h.s5cucrg5qyjc

SetDelay(float)

Sets the amount of time in seconds that you want to delay when this animation is started.

public FlowOptions SetDelay(float time)

Parameters

time float

Returns

FlowOptions

SetDelayUntil(Func<bool>)

Sets the callback that holds the starting of the animation.

public FlowOptions SetDelayUntil(Func<bool> callback)

Parameters

callback Func<bool>

Returns

FlowOptions

SetLoopCount(int?)

Sets the amount of loops you want this animation to have. If you want infinite loops pass a null value.

public FlowOptions SetLoopCount(int? loopCount)

Parameters

loopCount int?

Returns

FlowOptions

Remarks

Flows only have reset loop types.

SetName(string)

Sets the name of the animation.

public FlowOptions SetName(string name)

Parameters

name string

Returns

FlowOptions

SetSkipFrames(int)

Sets the amount of frames you want to skip at when this animation is started.

public FlowOptions SetSkipFrames(int frames)

Parameters

frames int

Returns

FlowOptions

SetTimeScale(float)

Sets the time scale for the current animation.

public FlowOptions SetTimeScale(float timeScale)

Parameters

timeScale float

Returns

FlowOptions

SetUpdateType(UpdateType)

Sets the update type for the animation.

public FlowOptions SetUpdateType(UpdateType updateType)

Parameters

updateType UpdateType

Returns

FlowOptions