Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AnimationNodeDefinition

A single node within an animation graph, connected to other nodes through named input pins.

Memory categoryInstances

Member index 8

HistoryMember
702NodeId: string
697NodeType: AnimationNodeType
735AddInputPin(pin: string): null
735GetOrderedInputPinNames(): Array
735RemoveInputPin(pin: string): null
735SetOrderedInputPinNames(pins: Array): null
735InputPinsChanged()
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 5

HistoryMember
706GetConnectedWires(pin: string): Instances
706GetInputPinNames(): Array
706GetInputPins(): Array
706GetOutputPins(): Array
706SetInputPinNames(pins: Array): null

Description

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.

History 27

Members 8

AddInputPin

Parameters (1)
pinstring
Returns (1)
null

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.

Thread safetyUnsafe

History 2

GetOrderedInputPinNames

Parameters (0)
No parameters.
Returns (1)
Array

Returns the current ordered list of input pin names.

Thread safetyUnsafe

History 2

InputPinsChanged

Parameters (0)
No parameters.

Fires whenever the ordered input pin list is modified.

Thread safetyUnsafe

History 2

NodeId

TypeDefault
string

A unique identifier used to reference this node among the other nodes in its graph. Defaults to an empty string.

SecurityRobloxScriptSecurity
Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

NodeType

TypeDefault
AnimationNodeTypeInvalidNode

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.

Thread safetyReadSafe
CategoryAnimation
Loaded/Savedtrue

History 1

RemoveInputPin

Parameters (1)
pinstring
Returns (1)
null

Removes the first input pin matching the given name from the ordered pin list.

Thread safetyUnsafe

History 2

SetOrderedInputPinNames

Parameters (1)
pinsArray
Returns (1)
null

Bulk-replaces the entire ordered input pin list. Use this to reorder pins or apply batch updates in a single call.

Thread safetyUnsafe

History 2

Removed members 5

GetConnectedWires

Parameters (1)
pinstring
Returns (1)
Instances
Thread safetyUnsafe

History 2

GetInputPinNames

Parameters (0)
No parameters.
Returns (1)
Array
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

GetInputPins

Parameters (0)
No parameters.
Returns (1)
Array
Thread safetyUnsafe

History 2

GetOutputPins

Parameters (0)
No parameters.
Returns (1)
Array
Thread safetyUnsafe

History 2

SetInputPinNames

Parameters (1)
pinsArray
Returns (1)
null
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

Settings