Class TMPAnimation
- Namespace
- TMPEffects.TMPAnimations
Base class for animations.
public abstract class TMPAnimation : ScriptableObject, ITMPAnimation, ITMPParameterValidator, INotifyObjectChanged
- Inheritance
-
TMPAnimation
- Implements
- Derived
Methods
Animate(CharData, IAnimationContext)
Animate the given character.
public abstract void Animate(CharData cData, IAnimationContext context)
Parameters
cData
CharDataData about the character.
context
IAnimationContextData about the animator.
GetNewCustomData()
Get a new custom data object for this animation.
public abstract object GetNewCustomData()
Returns
- object
The custom data object for this animation.
OnDestroy()
protected virtual void OnDestroy()
OnValidate()
protected virtual void OnValidate()
RaiseObjectChanged()
protected void RaiseObjectChanged()
SetParameters(object, IDictionary<string, string>, ITMPKeywordDatabase)
Set the parameters for the animation.
public abstract void SetParameters(object customData, IDictionary<string, string> parameters, ITMPKeywordDatabase keywordDatabase)
Parameters
customData
objectThe custom data for this animation.
parameters
IDictionary<string, string>Parameters as key-value-pairs.
keywordDatabase
ITMPKeywordDatabaseThe keyword database used for parsing the parameter values.
ValidateParameters(IDictionary<string, string>, ITMPKeywordDatabase)
Validate the given parameters.
public abstract bool ValidateParameters(IDictionary<string, string> parameters, ITMPKeywordDatabase keywordDatabase)
Parameters
parameters
IDictionary<string, string>The parameters as key-value pairs
keywordDatabase
ITMPKeywordDatabaseThe keyword database used for parsing the parameter values
Returns
- bool
true if the parameters were successfully validated; false otherwise.
Events
ObjectChanged
Raised when the object is changed.
public event ObjectChangedEventHandler ObjectChanged