boomflame library

Classes

Anim

Anim represents a single animation state with a name.

AnimationComponent

Document

Document represents a fully-parsed .anim file.

DocumentReader

DocumentReader reads generated boomsheets anim docs and parses them.

ElementInfo

ElementInfo has the lineNumber which it was parsed from and the result element.

ErrorInfo

ErrorInfo has the offending line and reason message.

IndexedKeyframe

IndexedKeyframe associates a Keyframe with its element index.

Keyframe

A Keyframe represents a rect on a spritesheet.

LabeledPoint

Point

Tickrate

Tickrate provides fractional Frametime values over time via digest.

Enums

CaseSensitivity

Anim state objects can be accessed by the case-(in)sensitive name.

Extension Types

Attribute

Attribute extension type wraps Element to distinguish them.

Frametime

An extension over int storing the value in count.

Mode

Play Mode types can be combined. Default is Mode.forward.

Extensions

BoomflameAttrsListExtension on List<Attribute>

Extends List over Attribute types only.

BoomflameListExtension on List<T>

This extension enables circular element iteration over List. For a similar extension for Map, see BoomflameMapExtension.

BoomflameMapExtension on Map<T, Y>

This extension enables circular element iteration over Map. For a similar extension for List, see BoomflameListExtension.

BoomflamePointToVector2 on Point<T>

This extension adds toVector2 on dart's Point class.

BoomflameRectToVect2 on Rectangle<T>

This extension adds size on dart's Rectangle.

Typedefs

KeyframeRect = ({Point<int> pos, Point<int> size})

ParserErrorHandler = void Function(List<ErrorInfo> errors)

ParserErrorHandler receives the errors and line numbers in ErrorInfo.