Interface ITMPOffsetProvider

Namespace

TMPEffects.Parameters

Provides timing offsets for characters (to be used with e.g. Wave).

public interface ITMPOffsetProvider

Methods

GetMinMaxOffset(out float, out float, ITMPSegmentData, IAnimatorDataProvider, bool)

Get the minimum / maximum offset for the given segment.

void GetMinMaxOffset(out float min, out float max, ITMPSegmentData segmentData, IAnimatorDataProvider animatorData, bool ignoreAnimatorScaling = false)

Parameters

min float

The output parameter that will contain the minimum offset.

max float

The output parameter that will contain the maximum offset.

segmentData ITMPSegmentData

The relevant segment data.

animatorData IAnimatorDataProvider

The relevant animator data.

ignoreAnimatorScaling bool

Whether to ignore the animator's scaling.

GetOffset(CharData, ITMPSegmentData, IAnimatorDataProvider, bool)

Get a timing offset for the given character.

float GetOffset(CharData cData, ITMPSegmentData segmentData, IAnimatorDataProvider animatorData, bool ignoreAnimatorScaling = false)

Parameters

cData CharData

The character to get an offset for.

segmentData ITMPSegmentData

The relevant segment data.

animatorData IAnimatorDataProvider

The relevant animator data.

ignoreAnimatorScaling bool

Whether to ignore the animator's scaling.

Returns

float

A timing offset (to be used, for example, with Wave).

StringToOffsetProvider(string, out ITMPOffsetProvider, ITMPKeywordDatabase)

public static bool StringToOffsetProvider(string str, out ITMPOffsetProvider result, ITMPKeywordDatabase keywords)

Parameters

str string

result ITMPOffsetProvider

keywords ITMPKeywordDatabase

Returns

bool