Class ReadOnlyAnimationContext

Namespace

TMPEffects.TMPAnimations

A read-only wrapper around AnimationContext.

public class ReadOnlyAnimationContext : IAnimationContext, IAnimationData, IAnimationFinished, IAnimationFinisher

Inheritance

object

ReadOnlyAnimationContext

Implements

IAnimationContext

IAnimationData

IAnimationFinished

IAnimationFinisher

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ReadOnlyAnimationContext(IAnimatorContext, CharDataModifiers, SegmentData, object)

public ReadOnlyAnimationContext(IAnimatorContext animatorContext, CharDataModifiers state, SegmentData segmentData, object customData)

Parameters

animatorContext IAnimatorContext

state CharDataModifiers

segmentData SegmentData

customData object

ReadOnlyAnimationContext(IAnimationContext)

public ReadOnlyAnimationContext(IAnimationContext context)

Parameters

context IAnimationContext

Properties

AnimatorContext

The context of the animating TMPAnimator.

public IAnimatorContext AnimatorContext { get; }

Property Value

IAnimatorContext

CustomData

The custom data object.

public object CustomData { get; }

Property Value

object

SegmentData

Data about the animation segment.

public SegmentData SegmentData { get; }

Property Value

SegmentData

Methods

FinishAnimation(CharData)

Set the animation to be considered finished for the given character.

public void FinishAnimation(CharData cData)

Parameters

cData CharData

Finished(int)

Check if the animation is considered finished for the character at the given index.

public bool Finished(int index)

Parameters

index int

Returns

bool

Finished(CharData)

Check if the animation is considered finished for the given character.

public bool Finished(CharData cData)

Parameters

cData CharData

Returns

bool