Class
AnimationNodeDefinition
A single node within an animation graph, connected to other nodes through named input pins.
Represents one node in an animation graph, the node-based system that combines
animation clips and poses at runtime. Its
NodeType determines how the node
processes animation, such as playing a clip, blending or overlaying two
inputs, masking, or adjusting playback speed, while its
NodeId uniquely identifies it within
the graph. Nodes connect to one another through named input pins; changing a
node's type resets its input pins to the default set for that type.
Properties 2#
NodeIdstring | A string that uniquely identifies this node within its animation graph.Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe |
NodeTypeAnimationNodeType | The kind of node this definition represents within its animation graph.ReadSafe |
NodeId: string#
Read: RobloxScriptSecurityWrite: RobloxScriptSecurityReadSafe
A unique identifier used to reference this node among the other nodes in its graph. Defaults to an empty string.
NodeType: AnimationNodeType#
ReadSafe
Determines how the node processes animation within the graph, for example
a clip source, an additive or overlay blend, a mask, or a speed adjustment
(see AnimationNodeType). Defaults to
InvalidNode. Changing this value resets the
node's input pins to the default set defined for the new type.
Methods 4#
| AddInputPin | Appends a named input pin to the end of the ordered input pin list. |
| GetOrderedInputPinNames | Returns the current ordered list of input pin names. |
| RemoveInputPin | Removes the first input pin matching the given name from the ordered pin list. |
| SetOrderedInputPinNames | Bulk-replaces the entire ordered input pin list. |
AddInputPin(pin: string): ()#
Appends a named input pin to the end of the ordered input pin list. The
order in which pins are added is significant for nodes such as
AnimationNodeType.SequenceNode,
AnimationNodeType.RandomSequenceNode, and
AnimationNodeType.PrioritySelectNode.
| Name | Type | Default | Description |
|---|---|---|---|
pin | string | Name of the input pin to append. Should match the
Name of the corresponding ObjectValue
wiring child. |
Returns
()
GetOrderedInputPinNames(): Array#
Returns the current ordered list of input pin names.
Returns
Array— The ordered list of input pin names.
RemoveInputPin(pin: string): ()#
Removes the first input pin matching the given name from the ordered pin list.
| Name | Type | Default | Description |
|---|---|---|---|
pin | string | Name of the input pin to remove. Only the first pin matching this name is removed. |
Returns
()
SetOrderedInputPinNames(pins: Array): ()#
Bulk-replaces the entire ordered input pin list. Use this to reorder pins or apply batch updates in a single call.
| Name | Type | Default | Description |
|---|---|---|---|
pins | Array | The new ordered list of input pin names, replacing the existing list. |
Returns
()
Events 1#
| InputPinsChanged | Fires whenever the ordered input pin list is modified. |
InputPinsChanged()#
Fires whenever the ordered input pin list is modified.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild