Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commit44fd9e59bd

README.md

ClipPlayer

Plays one .animation clip on the skinned body it is attached to, through the canonical AnimGraph. The graph retargets the clip from its source rig onto the body's rig and drives the body's bone entities each frame, so any humanoid clip plays on any humanoid body. It is the single-clip case of the animation contract: build a one-clip graph on start, then advance and apply it each frame.

Attach it to the same entity as the skinned mesh. The body's rig comes from its Skeleton; the clip's source rig from the clip itself (or sourceRig). All the retarget and pose machinery lives in the graph — this component only configures the clip and ticks it.

entity.find("hero").component.add("ClipPlayer", { clip = "A_Walk_F_Masc" })

Public fields: clip (the .animation to play), sourceRig (the clip's source rig; empty resolves from the clip), looping, speed and playing.