NdsForge.NdsBannerAnimationStep(byte Duration, byte TileFrame, byte PaletteFrame, bool FlipHorizontal=false, bool FlipVertical=false) Class Reference

Describes one timed DSi menu-icon pose. Tile and palette frames are selected independently so an animation can recolor existing artwork without duplicating its 512-byte tile data; a zero packed word is reserved as the hardware sequence terminator and therefore cannot represent a step. More...

Public Member Functions
ushort	Pack ()
	Converts the typed pose to the bit layout stored in a DSi banner sequence entry.

Static Public Member Functions
static NdsBannerAnimationStep	FromPacked (ushort value)
	Interprets one nonzero on-disk sequence word without needing a containing banner.

Detailed Description

Describes one timed DSi menu-icon pose. Tile and palette frames are selected independently so an animation can recolor existing artwork without duplicating its 512-byte tile data; a zero packed word is reserved as the hardware sequence terminator and therefore cannot represent a step.

Parameters

Duration	Display time in 60 Hz ticks, from 1 through 255.
TileFrame	Animated tile slot from zero through seven.
PaletteFrame	Animated palette slot from zero through seven.
FlipHorizontal	Mirrors the selected tile frame around its vertical axis.
FlipVertical	Mirrors the selected tile frame around its horizontal axis.

Definition at line 14 of file NdsBannerAnimationStep.cs.

Member Function Documentation

FromPacked()

NdsBannerAnimationStep NdsForge.NdsBannerAnimationStep.FromPacked ( ushort value )

inlinestatic

Interprets one nonzero on-disk sequence word without needing a containing banner.

Parameters

value

Packed duration, frame selectors, and flip flags.

Returns

The equivalent strongly typed pose.

Exceptions

InvalidDataException

The word is zero, which denotes the end of the sequence rather than a pose.

Definition at line 42 of file NdsBannerAnimationStep.cs.

Pack()

ushort NdsForge.NdsBannerAnimationStep.Pack ( )

inline

Converts the typed pose to the bit layout stored in a DSi banner sequence entry.

Returns

A nonzero little-endian word suitable for the sequence table.

Exceptions

InvalidDataException

The duration is zero or either frame index is outside zero through seven.

Definition at line 27 of file NdsBannerAnimationStep.cs.

---

The documentation for this class was generated from the following file:

• src/NdsForge/Banners/NdsBannerAnimationStep.cs