Jazz2::Scripting::Legacy::jjANIMSET class

A set of related sprite animations.

Reference-counted handle to one animation set (e.g. an original JJ2 sprite set) within the global table, grouping a contiguous run of jjANIMATION starting at firstAnim. Scripts can allocate empty animations or load them from a file into the set. Obtained via jjAnimSets[index].

Public static functions

static auto get_jjAnimSets(std::uint32_t index) -> jjANIMSET*
Returns the animation set at the specified global index.

Constructors, destructors, conversion operators

jjANIMSET(std::uint32_t index)
Creates a new instance wrapping the animation set at the given index.
~jjANIMSET()

Public functions

void AddRef()
Increments the reference count.
void Release()
Decrements the reference count.
auto convertAnimSetToUint() -> std::uint32_t
Returns the index of this animation set as an unsigned integer.
auto load(std::uint32_t fileSetID, const String& filename, int32_t firstAnimToOverwrite, int32_t firstFrameToOverwrite) -> jjANIMSET*
Loads animations from a file into this set, overwriting starting at the given animation.
auto allocate(const CScriptArray& frameCounts) -> jjANIMSET*
Allocates animations in this set with the given per-animation frame counts.

Public variables

std::uint32_t firstAnim