Struct AnimationPlayer 

pub struct AnimationPlayer { /* private fields */ }

Plays a move animation, stepping through its command sequence.

The player is a state machine:

1. start(move_id) loads the move’s command list.
2. tick() advances one step and returns what happened.
3. After each tick, oam_entries() has the current sprite data.

The caller is responsible for:

• Rendering OAM entries to the screen each frame.
• Applying AnimEffect actions (palette changes, screen shake, etc.).
• Counting down WaitDelay frames before calling tick again.

Implementations

impl AnimationPlayer

pub fn new() -> Self

Create a new idle animation player.

pub fn start(&mut self, move_id: usize, player_is_attacker: bool)

Start playing the animation for the given move. move_id is 0-based index into MOVE_ANIM_DATA. player_is_attacker determines Enemy transform resolution.

pub fn is_finished(&self) -> bool

Whether the animation has finished playing.

pub fn oam_entries(&self) -> &[SpriteOamEntry]

Get the current OAM buffer for rendering.

pub fn current_tileset(&self) -> Option<u8>

Current move-animation tileset index (0/1/2) while a subanimation is active.

pub fn decode_command(raw: &(u8, u8, u8, u8)) -> AnimCommand

Decode a raw command tuple from MOVE_ANIM_DATA into an AnimCommand.

pub fn resolve_transform( &self, raw_transform: SubAnimTransform, ) -> SubAnimTransform

Resolve the effective transform for a subanimation, accounting for Enemy type and whose turn it is.

impl AnimationPlayer

pub fn render_frame_block( frame_block_id: usize, base_coord_id: usize, transform: SubAnimTransform, dest: &mut Vec<SpriteOamEntry>, )

Render a frame block into OAM entries, applying the given transform.

frame_block_id: index into FRAME_BLOCK_DATA. base_coord_id: index into BASE_COORDS. transform: the resolved SubAnimTransform to apply. dest: output buffer to append OAM entries to.

impl AnimationPlayer

pub fn tick(&mut self) -> AnimTickResult

Advance the animation by one step.

Returns what happened this tick. The caller should:

• Playing → render oam_entries() to screen.
• WaitDelay → wait frames frames, then call tick again.
• Effect → apply the special effect, then call tick again.
• Done → animation is finished. Playing/WaitDelay also carry a hook when the current animation id has an entry in ANIMATION_ID_HOOKS (the original’s DoSpecialEffectByAnimationId, run after every DrawFrameBlock).

impl AnimationPlayer

pub fn apply_effect(effect: SpecialEffect) -> AnimEffect

Map a SpecialEffect to a high-level AnimEffect the caller should apply.

This translates the original ASM effect handlers into abstract operations. The caller’s rendering layer is responsible for executing these.

Trait Implementations

impl Clone for AnimationPlayer

fn clone(&self) -> AnimationPlayer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AnimationPlayer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AnimationPlayer

fn default() -> Self

Returns the “default value” for a type.