NiceTouch v2.1
MoreMountains.Tools.MMAnimatorExtensions Class Reference

Animator extensions More...

Static Public Member Functions

static bool MMHasParameterOfType (this Animator self, string name, AnimatorControllerParameterType type)
 Determines if an animator contains a certain parameter, based on a type and a name More...
 
static void AddAnimatorParameterIfExists (Animator animator, string parameterName, out int parameter, AnimatorControllerParameterType type, HashSet< int > parameterList)
 Adds an animator parameter name to a parameter list if that parameter exists. More...
 
static void AddAnimatorParameterIfExists (Animator animator, string parameterName, AnimatorControllerParameterType type, HashSet< string > parameterList)
 Adds an animator parameter name to a parameter list if that parameter exists. More...
 
static void UpdateAnimatorBool (Animator animator, string parameterName, bool value)
 Updates the animator bool. More...
 
static void UpdateAnimatorInteger (Animator animator, string parameterName, int value)
 Updates the animator integer. More...
 
static void UpdateAnimatorFloat (Animator animator, string parameterName, float value, bool performSanityCheck=true)
 Updates the animator's float More...
 
static bool UpdateAnimatorBool (Animator animator, int parameter, bool value, HashSet< int > parameterList, bool performSanityCheck=true)
 Updates the animator bool. More...
 
static bool UpdateAnimatorTrigger (Animator animator, int parameter, HashSet< int > parameterList, bool performSanityCheck=true)
 Sets an animator's trigger of the int parameter specified More...
 
static bool SetAnimatorTrigger (Animator animator, int parameter, HashSet< int > parameterList, bool performSanityCheck=true)
 Triggers an animator trigger. More...
 
static bool UpdateAnimatorFloat (Animator animator, int parameter, float value, HashSet< int > parameterList, bool performSanityCheck=true)
 Updates the animator float. More...
 
static bool UpdateAnimatorInteger (Animator animator, int parameter, int value, HashSet< int > parameterList, bool performSanityCheck=true)
 Updates the animator integer. More...
 
static void UpdateAnimatorBool (Animator animator, string parameterName, bool value, HashSet< string > parameterList, bool performSanityCheck=true)
 Updates the animator bool. More...
 
static void UpdateAnimatorTrigger (Animator animator, string parameterName, HashSet< string > parameterList, bool performSanityCheck=true)
 Sets an animator's trigger of the string parameter name specified More...
 
static void SetAnimatorTrigger (Animator animator, string parameterName, HashSet< string > parameterList, bool performSanityCheck=true)
 Triggers an animator trigger. More...
 
static void UpdateAnimatorFloat (Animator animator, string parameterName, float value, HashSet< string > parameterList, bool performSanityCheck=true)
 Updates the animator float. More...
 
static void UpdateAnimatorInteger (Animator animator, string parameterName, int value, HashSet< string > parameterList, bool performSanityCheck=true)
 Updates the animator integer. More...
 
static void UpdateAnimatorBoolIfExists (Animator animator, string parameterName, bool value, bool performSanityCheck=true)
 Updates the animator bool after checking the parameter's existence. More...
 
static void UpdateAnimatorTriggerIfExists (Animator animator, string parameterName, bool performSanityCheck=true)
 Updates an animator trigger if it exists More...
 
static void SetAnimatorTriggerIfExists (Animator animator, string parameterName, bool performSanityCheck=true)
 Triggers an animator trigger after checking for the parameter's existence. More...
 
static void UpdateAnimatorFloatIfExists (Animator animator, string parameterName, float value, bool performSanityCheck=true)
 Updates the animator float after checking for the parameter's existence. More...
 
static void UpdateAnimatorIntegerIfExists (Animator animator, string parameterName, int value, bool performSanityCheck=true)
 Updates the animator integer after checking for the parameter's existence. More...
 

Detailed Description

Animator extensions

Member Function Documentation

◆ AddAnimatorParameterIfExists() [1/2]

static void MoreMountains.Tools.MMAnimatorExtensions.AddAnimatorParameterIfExists ( Animator  animator,
string  parameterName,
AnimatorControllerParameterType  type,
HashSet< string >  parameterList 
)
static

Adds an animator parameter name to a parameter list if that parameter exists.

Parameters
animator
parameterName
type
parameterList

◆ AddAnimatorParameterIfExists() [2/2]

static void MoreMountains.Tools.MMAnimatorExtensions.AddAnimatorParameterIfExists ( Animator  animator,
string  parameterName,
out int  parameter,
AnimatorControllerParameterType  type,
HashSet< int >  parameterList 
)
static

Adds an animator parameter name to a parameter list if that parameter exists.

Parameters
animator
parameterName
parameter
type
parameterList

◆ MMHasParameterOfType()

static bool MoreMountains.Tools.MMAnimatorExtensions.MMHasParameterOfType ( this Animator  self,
string  name,
AnimatorControllerParameterType  type 
)
static

Determines if an animator contains a certain parameter, based on a type and a name

Returns
true if has parameter of type the specified self name type; otherwise, false.
Parameters
selfSelf.
nameName.
typeType.

◆ SetAnimatorTrigger() [1/2]

static bool MoreMountains.Tools.MMAnimatorExtensions.SetAnimatorTrigger ( Animator  animator,
int  parameter,
HashSet< int >  parameterList,
bool  performSanityCheck = true 
)
static

Triggers an animator trigger.

Parameters
animatorAnimator.
parameterParameter name.
valueIf set to true value.

◆ SetAnimatorTrigger() [2/2]

static void MoreMountains.Tools.MMAnimatorExtensions.SetAnimatorTrigger ( Animator  animator,
string  parameterName,
HashSet< string >  parameterList,
bool  performSanityCheck = true 
)
static

Triggers an animator trigger.

Parameters
animatorAnimator.
parameterNameParameter name.
valueIf set to true value.

◆ SetAnimatorTriggerIfExists()

static void MoreMountains.Tools.MMAnimatorExtensions.SetAnimatorTriggerIfExists ( Animator  animator,
string  parameterName,
bool  performSanityCheck = true 
)
static

Triggers an animator trigger after checking for the parameter's existence.

Parameters
animatorAnimator.
parameterNameParameter name.
valueIf set to true value.

◆ UpdateAnimatorBool() [1/3]

static bool MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorBool ( Animator  animator,
int  parameter,
bool  value,
HashSet< int >  parameterList,
bool  performSanityCheck = true 
)
static

Updates the animator bool.

Parameters
animatorAnimator.
parameterNameParameter name.
valueIf set to true value.

◆ UpdateAnimatorBool() [2/3]

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorBool ( Animator  animator,
string  parameterName,
bool  value 
)
static

Updates the animator bool.

Parameters
animatorAnimator.
parameterNameParameter name.
valueIf set to true value.

◆ UpdateAnimatorBool() [3/3]

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorBool ( Animator  animator,
string  parameterName,
bool  value,
HashSet< string >  parameterList,
bool  performSanityCheck = true 
)
static

Updates the animator bool.

Parameters
animatorAnimator.
parameterNameParameter name.
valueIf set to true value.

◆ UpdateAnimatorBoolIfExists()

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorBoolIfExists ( Animator  animator,
string  parameterName,
bool  value,
bool  performSanityCheck = true 
)
static

Updates the animator bool after checking the parameter's existence.

Parameters
animatorAnimator.
parameterNameParameter name.
valueIf set to true value.

◆ UpdateAnimatorFloat() [1/3]

static bool MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorFloat ( Animator  animator,
int  parameter,
float  value,
HashSet< int >  parameterList,
bool  performSanityCheck = true 
)
static

Updates the animator float.

Parameters
animatorAnimator.
parameterParameter name.
valueValue.

◆ UpdateAnimatorFloat() [2/3]

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorFloat ( Animator  animator,
string  parameterName,
float  value,
bool  performSanityCheck = true 
)
static

Updates the animator's float

Parameters
animator
parameterName
value

◆ UpdateAnimatorFloat() [3/3]

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorFloat ( Animator  animator,
string  parameterName,
float  value,
HashSet< string >  parameterList,
bool  performSanityCheck = true 
)
static

Updates the animator float.

Parameters
animatorAnimator.
parameterNameParameter name.
valueValue.

◆ UpdateAnimatorFloatIfExists()

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorFloatIfExists ( Animator  animator,
string  parameterName,
float  value,
bool  performSanityCheck = true 
)
static

Updates the animator float after checking for the parameter's existence.

Parameters
animatorAnimator.
parameterNameParameter name.
valueValue.

◆ UpdateAnimatorInteger() [1/3]

static bool MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorInteger ( Animator  animator,
int  parameter,
int  value,
HashSet< int >  parameterList,
bool  performSanityCheck = true 
)
static

Updates the animator integer.

Parameters
animatorAnimator.
parameterParameter name.
valueValue.

◆ UpdateAnimatorInteger() [2/3]

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorInteger ( Animator  animator,
string  parameterName,
int  value 
)
static

Updates the animator integer.

Parameters
animatorAnimator.
parameterParameter name.
valueValue.

◆ UpdateAnimatorInteger() [3/3]

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorInteger ( Animator  animator,
string  parameterName,
int  value,
HashSet< string >  parameterList,
bool  performSanityCheck = true 
)
static

Updates the animator integer.

Parameters
animatorAnimator.
parameterNameParameter name.
valueValue.

◆ UpdateAnimatorIntegerIfExists()

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorIntegerIfExists ( Animator  animator,
string  parameterName,
int  value,
bool  performSanityCheck = true 
)
static

Updates the animator integer after checking for the parameter's existence.

Parameters
animatorAnimator.
parameterNameParameter name.
valueValue.

◆ UpdateAnimatorTrigger() [1/2]

static bool MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorTrigger ( Animator  animator,
int  parameter,
HashSet< int >  parameterList,
bool  performSanityCheck = true 
)
static

Sets an animator's trigger of the int parameter specified

Parameters
animator
parameter
parameterList

◆ UpdateAnimatorTrigger() [2/2]

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorTrigger ( Animator  animator,
string  parameterName,
HashSet< string >  parameterList,
bool  performSanityCheck = true 
)
static

Sets an animator's trigger of the string parameter name specified

Parameters
animator
parameterName
parameterList

◆ UpdateAnimatorTriggerIfExists()

static void MoreMountains.Tools.MMAnimatorExtensions.UpdateAnimatorTriggerIfExists ( Animator  animator,
string  parameterName,
bool  performSanityCheck = true 
)
static

Updates an animator trigger if it exists

Parameters
animator
parameterName

The documentation for this class was generated from the following file: