NodeParameter<T> Struct

Summary

A wrapper for managing a Animancer.Parameter`1 in an Animancer.AnimancerNode.
Assembly
Animancer.dll
Namespace
Animancer
Base Types
  • ValueType
graph BT Type-->Base0["ValueType"] Type["NodeParameter<T>"] class Type type-node

Syntax

public struct NodeParameter<T> : ValueType

Remarks

This type is mostly intended for internal use within Mixers.

Type Parameters

Name Description
T

Events

Name Type Summary
OnParameterChanged Action<T>
The callback to invoke when the parameter changes.

Properties

Name Value Summary
IsInitialized bool
Has this Animancer.NodeParameter`1 been constructed properly?
Key StringReference
This will be used as a key in the Animancer.ParameterDictionary so any changes to that parameter will invoke Animancer.NodeParameter`1.OnParameterChanged.
Node AnimancerNode
The node that owns this parameter.

Methods

Name Value Summary
Bind() void
Registers to the Animancer.AnimancerGraph.Parameters.
BindIfInitialized() void
Registers to the Animancer.AnimancerGraph.Parameters if Animancer.NodeParameter`1.IsInitialized.
Initialize(AnimancerNode, Action<T>) void
Initializes and binds the parameter.
SetKeyCheckNeedsInitialize(StringReference) bool
Sets the Animancer.NodeParameter`1.Key and returns true if Animancer.NodeParameter`1.Initialize(Animancer.AnimancerNode,System.Action{`0}) needs to be called.
UnBind() void
Unregisters from the Animancer.AnimancerGraph.Parameters.
UnBindIfInitialized() void
Unregisters from the Animancer.AnimancerGraph.Parameters if Animancer.NodeParameter`1.IsInitialized.