Moonlite is a light-weight, runtime player for sequences created in Moon Animator 2, a plugin developed by @xsixx.
This project is actively developed and maintained by @MaximumADHD.

Installation

If you use Wally for managing packages, you can install it using the following line:

Moonlite = "maximumadhd/moonlite@0.9.0"

If you don't use Wally, you can install it from Moonlite.rbxm file.

Basic Usage

Create a LocalScript in StarterPlayerScripts with the following code:

local Moonlite = require(game.ReplicatedStorage.Moonlite)

local save = game.ReplicatedStorage.MoonliteSaves.my_save
local MoonTrack = Moonlite.CreatePlayer(save)

MoonTrack:Play()

The save is a StringValue normally stored in game.ServerStorage.MoonAnimator2Saves, but you'll want to use it on the client, so it's moved to game.ReplicatedStorage.MoonliteSaves for example.

Contribution

When syncing by default with rojo, the module can be found directly in the ReplicatedStorage service.

APIs

CreatePlayer

Moonlite.CreatePlayer(save: StringValue, root: Instance?) -> MoonTrack

Loads the provided save file to be played back. The save is a StringValue normally stored in game.ServerStorage.MoonAnimator2Saves, but you'll need to store it elsewhere to play the sequence back on the client.

MoonTrack

type MoonTrack = Moonlite.MoonTrack

MoonTrack is the main type exported when requiring the Moonlite module. It represents a loaded animation sequence.

Play

MoonTrack:Play() -> ()

Starts playing the track's elements.

Note: Has no effect if the track is already playing.

Stop

MoonTrack:Stop() -> ()

Stops all playing track elements.

Note: Has no effect if the track is already stopped.

Reset

MoonTrack:Reset() -> boolean

Manually resets all element's properties to their expected defaults. Returns true if the reset was successful.

Note: This will only work if the track is not playing.

IsPlaying

MoonTrack:IsPlaying() -> boolean

Returns true if the track has any elements playing.

GetElements

MoonTrack:GetElements() -> { Instance }

Returns an array of instances that can be modified by this track during playback.

LockElement

MoonTrack:LockElement(inst: Instance?, lock: any? = "Default") -> boolean

Adds a mutex lock to the provided element, disabling it from being modified by the track's playback. Returns true if the element is valid and successfully locked.

Note: If provided, the value of lock must be a truthy type (i.e. not false or nil), otherwise it will fallback to "Default". Warning: Calling this while the track is playing won't take effect until the track plays again.

UnlockElement

MoonTrack:UnlockElement(inst: Instance?, lock: any? = "Default") -> boolean

Removes a mutex lock from the provided element, enabling it to be modified again if there are no other locks on it. Returns true if the element is valid and no longer has the provided lock.

Note: If provided, the value of lock must be a truthy type (i.e. not false or nil), otherwise it will fallback to "Default". Warning: Calling this while the track is playing won't take effect until the track plays again.

IsElementLocked

MoonTrack:IsElementLocked(inst: Instance?) -> boolean

Returns true if there are any locks on the provided element.

FindElement

MoonTrack:FindElement(name: string) -> Instance?

Returns the first element in this track whose name matches the provided name, if one can be found. Otherwise returns nil.

Warning: The result of this function depends on the order of elements in the authored sequence. If there are multiple elements with the same name, this may produce unexpected behavior.

FindElementOfType

MoonTrack:FindElementOfType(typeName: string): Instance?

Returns the first element in this track which satisfies element:IsA(typeName), or nil if no such element can be found.

Warning: The result of this function depends on the order of elements in the authored sequence. If there are multiple elements that satisfy element:IsA(typeName), this may produce unexpected behavior.

ReplaceElementByPath

MoonTrack:ReplaceElementByPath(path: string, replacement: Instance)

Attempts to replace an element by its defined absolute path with a specific Instance.

Looped

MoonTrack.Looped: boolean

If set to true, this track's playback will loop on completion. This defaults to the value specified by the author of this sequence, and should be set explicitly if expected to behave one way or the other.

---

Completed

MoonTrack.Completed: RBXScriptSignal

Fires upon all of the track's elements completing their playback.

---