Summary
Interface for components that manage an
Animancer.AnimancerGraph.- Assembly
- Animancer
.dll - Namespace
- Animancer
- Implementing Types
graph BT
Type["IAnimancerComponent"]
class Type type-node
Implementing0["AnimancerComponent"]-.->Type
click Implementing0 "/animancer/api/Animancer/AnimancerComponent"
Implementing1["DummyAnimancerComponent"]-.->Type
click Implementing1 "/animancer/api/Animancer.Editor.Previews/DummyAnimancerComponent"
Implementing2["HybridAnimancerComponent"]-.->Type
click Implementing2 "/animancer/api/Animancer/HybridAnimancerComponent"
Implementing3["NamedAnimancerComponent"]-.->Type
click Implementing3 "/animancer/api/Animancer/NamedAnimancerComponent"
Syntax
public interface IAnimancerComponentRemarks
Despite the name, this interface is not necessarily limited to only
UnityEngine.Components.
This interface allows Animancer Lite to reference an Animancer.AnimancerComponent inside the pre-compiled
DLL while allowing that component to remain outside as a regular script. Otherwise everything would need to be
in the DLL which would cause Unity to lose all the script references when upgrading from Animancer Lite to Pro.
Documentation:
Component Types
Properties
| Name | Value | Summary |
|---|---|---|
| Action |
string |
[Editor-Only]
The name of the serialized backing field for the
Animancer.AnimancerComponent.ActionOnDisable property.
|
| Animator | Animator |
The
UnityEngine.Animator component which this script controls. |
| AnimatorFieldName | string |
[Editor-Only] The name of the serialized backing field for the
Animancer.IAnimancerComponent.Animator property. |
| enabled | bool |
Will this component be updated?
|
| gameObject | GameObject |
The
UnityEngine.GameObject this component is attached to. |
| Graph | AnimancerGraph |
The internal system which manages the playing animations.
|
| InitialUpdateMode | Nullable |
[Editor-Only] The
Animancer.IAnimancerComponent.UpdateMode that was first used when this script initialized. |
| IsGraphInitialized | bool |
Has the
Animancer.IAnimancerComponent.Graph been initialized? |
| ResetOnDisable | bool |
Will the object be reset to its original values when disabled?
|
| UpdateMode | AnimatorUpdateMode |
Determines when animations are updated and which time source is used. This property is mainly a wrapper
around the
UnityEngine.Animator.updateMode.
|
Methods
| Name | Value | Summary |
|---|---|---|
| GetKey |
Object |
Returns the dictionary key to use for the `clip`.
|