Log inGet started
World

Builtin Library

Branchmain
Branchesmainpublish
Commitdf78e4f826

README.md

anim

Top-level entry point for the animation graph library. Re-exports the AnimGraph DAG container plus its Node hierarchy (Node, Clip, Mixer, BlendSpace2D) so callers can require a single module instead of four.

Exports

  • M.AnimGraph — DAG container for animation nodes (see AnimGraph.module).
  • M.Node — base class for animation nodes (see AnimGraph.Node.module).
  • M.Clip — single-clip Node subclass (see AnimGraph.Node.Clip.module).
  • M.Mixer — N-input weighted-blend Node subclass (see AnimGraph.Node.Mixer.module).
  • M.BlendSpace2D — 2D-coordinate-driven blend Node subclass (see AnimGraph.Node.BlendSpace2D.module).

Usage

local anim  = require("@builtin::systems.anim.anim")
local graph = anim.AnimGraph.new(layout)
local clip  = anim.Clip.new(asset, layout, true, 1.0)
local id    = graph:addNode(clip)
graph:setOutput(id)

Notes

  • No state of its own — pure re-export module. Hot-reloading just re-binds the same submodule tables.
  • Each submodule can also be required directly under @builtin::systems.anim.AnimGraph.* when you only need one of them.