Now I’m no expert but I’ll try making one. Please note that this is probably filled with errors.
Documentation (For the Renderer-ModuleScript)
(tags: docs, document, doc, info, functions, module, usage, how to, load, already existing)
Loading Animations
There are 2 ways you can load an animation:
-
Renderer.new(data, origin, ParentContainer)
Returns an animation instance holding a rig cloned from the given data after parenting it to ParentContainer and placing it at origin.
data: Required module script of a saved animation
origin (optional): CFrame describing the animated rigs position
ParentContainer: Where the cloned rig should be located
-
Renderer.loadAnimation(data, origin, rigDependencies)
Returns animation instance connected to an already existing rig.
data: Required module script of a saved animation
origin: CFrame describing the animated rigs position
rigDependencies: Reference to the already existing rig.
Renderer.getActiveAnimation(Instance)
Returns all animations that are currently active on
instance
Documentation (For animation instances)
(tags: playing, play, run, show, load, pause, reposition, origin)
animation:Play()
Metamethod that plays the animation.
animation:Destroy(keepRig?)
Metamethod that destroys the animation instance.
keepRig: Decides wether or not the rig should be destroyed with the animation.
animation:Pause()
Metamethod that pauses the animation if it is running.
animation:Resume()
Metamethod that resumes the animation if it is paused.
animation:GetRigDependencies()
Returns the rig connected to the animation.
animation:SetTime(time)
Metamethod that sets the animation’s time.
time: frame of the animation to skip to?
animation:SetOrigin(newOrigin)
Metamethod that sets the animation’s position.
newOrigin: New CFrame / “Pivot” of the animation
animation:GetInstance()
Returns itself?
animation:PlayThenDestroy()
Plays the animation and destroys it once it is completed.
animation:GetEventReachedSignal(eventName)
Returns an RBXScriptConnection / “Signal” of the provided name.
eventName: The name of the event that you set and which to get a reference to.