ControllerState.

ControllerState.Parameter Struct

Summary

A wrapper for the name and hash of an UnityEngine.AnimatorControllerParameter to allow easy access.
Assembly
Animancer.dll
Namespace
Animancer
Base Types
  • ValueType
graph BT Type-->Base0["ValueType"] Type["ControllerState.Parameter"] class Type type-node

Syntax

public struct ControllerState.Parameter : ValueType

Constructors

Name Summary
Parameter(int) Constructs a new Animancer.ControllerState.Parameter with the specified Animancer.ControllerState.Parameter.Hash and leaves the Animancer.ControllerState.Parameter.Name null.
Parameter(string) Constructs a new Animancer.ControllerState.Parameter with the specified Animancer.ControllerState.Parameter.Name and uses UnityEngine.Animator.StringToHash(System.String) to calculate the Animancer.ControllerState.Parameter.Hash.

Properties

Name Value Summary
Hash int
The name hash of the wrapped parameter.
Name string
The name of the wrapped parameter. This will be null if the Animancer.ControllerState.Parameter.Hash was assigned directly.

Methods

Name Value Summary
ToString() string
Returns a string containing the Animancer.ControllerState.Parameter.Name and Animancer.ControllerState.Parameter.Hash.
ValidateHasParameter(RuntimeAnimatorController, AnimatorControllerParameterType) void
[Editor-Conditional] Throws if the `controller` doesn't have a parameter with the specified Animancer.ControllerState.Parameter.Hash and `type`.

Operators

Name Value Summary
implicit operator ControllerState.Parameter(int) ControllerState.Parameter
implicit operator ControllerState.Parameter(string) ControllerState.Parameter
implicit operator int(ControllerState.Parameter) int