Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

registerClip

registerClip(name, url, registerClipOptions?): Disposer

Names a VRMA clip every avatar loads beside her pose clips, for playClip to play over them, such as a cast or a hit. url is the file, a ?url import. Register it before the first character draws: a character already drawn loads it when she draws again. A model’s clips come from its own file and need no registering.

Under a pose’s name, such as PoseState.Run or StrafeClip.Left, the clip is the one every avatar plays for that pose, in place of the engine’s, as Roblox’s Animate script and Unity’s override controller swap a clip by name. A land clip starts at its touch mark, where her feet meet the ground, and plays whole without one. A mark before the clip’s start throws. The return forgets the clip: a character drawn after it plays the engine’s clip again, and one already drawn keeps her clips until she draws again.

Parameter Type
name string
url string
registerClipOptions RegisterClipOptions

Disposer