Table of Contents

Class AnimationContext

Namespace
TMPEffects.TMPAnimations
Assembly
TMPEffects.dll
public class AnimationContext : IAnimationContext
Inheritance
AnimationContext
Implements
Inherited Members

Constructors

AnimationContext(ReadOnlyAnimatorContext, ReadOnlyCharDataState, SegmentData, object)

public AnimationContext(ReadOnlyAnimatorContext animatorContext, ReadOnlyCharDataState state, SegmentData segmentData, object customData)

Parameters

animatorContext ReadOnlyAnimatorContext
state ReadOnlyCharDataState
segmentData SegmentData
customData object

Fields

finishedDict

public Dictionary<int, bool> finishedDict

Field Value

Dictionary<int, bool>

Properties

AnimatorContext

The context of the animating TMPAnimator.

public IAnimatorContext AnimatorContext { get; set; }

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; set; }

Property Value

SegmentData

State

The current state of the CharData, with the previous animations applied.

public ICharDataState State { get; }

Property Value

ICharDataState

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

ResetFinishAnimation()

public void ResetFinishAnimation()

ResetFinishAnimation(int)

public void ResetFinishAnimation(int index)

Parameters

index int

ResetFinishAnimation(CharData)

public void ResetFinishAnimation(CharData cData)

Parameters

cData CharData