SpriteAnim Struct Reference

One animation of a 2D effect (FIGHTSTG_createSpriteAnim), drawn by a layer callback. More...

#include <battle/battle_mode/effect.h>

Collaboration diagram for SpriteAnim:

Data Fields
s32	id
s32	key1
s32	key2
s32	state
s32	substate
s32	step
s32	counter
s32	paused
s32	childCount
void *	children
void(*	setState )(struct SpriteAnim *task, s32 state)
void(*	setSubstate )(struct SpriteAnim *task, s32 substate)
void(*	setStep )(struct SpriteAnim *task, s32 step)
void(*	setCounter )(struct SpriteAnim *task, s32 counter)
void(*	nextState )(struct SpriteAnim *task)
void(*	nextSubstate )(struct SpriteAnim *task)
void(*	nextStep )(struct SpriteAnim *task)
void(*	tickCounter )(struct SpriteAnim *task)
void(*	update )()
void(*	destroy )(struct SpriteAnim *task)
s16 *	data
SVECTOR	pos
	vz 0x7FFF: on screen in front, -1: on screen
s32	sheet
Vec2	texPos
s32	layerId
s32	time
s32	flags
s32	stride
	of a frame's values
s32	duration
s16	frame
s16	clutRow
s16	x
s16	y
union {
s16   v [2]
	x, y; 0x1000 = 1.0 More...
s32   both
	to test the two at once More...
}	scale
union {
s16   v [2]
	x, y More...
s32   both
}	rot
s16	rotZ

Detailed Description

One animation of a 2D effect (FIGHTSTG_createSpriteAnim), drawn by a layer callback.

Its data: flags, stride and duration, the 9 values of the first frame, then per frame the values whose bit is set in flags.

Definition at line 64 of file effect.h.

Field Documentation

id

s32 SpriteAnim::id

Definition at line 65 of file effect.h.

key1

s32 SpriteAnim::key1

Definition at line 65 of file effect.h.

key2

s32 SpriteAnim::key2

Definition at line 65 of file effect.h.

state

s32 SpriteAnim::state

Definition at line 65 of file effect.h.

Referenced by FIGHTSTG_updateSpriteAnim().

substate

s32 SpriteAnim::substate

Definition at line 65 of file effect.h.

step

s32 SpriteAnim::step

Definition at line 65 of file effect.h.

counter

s32 SpriteAnim::counter

Definition at line 65 of file effect.h.

paused

s32 SpriteAnim::paused

Definition at line 65 of file effect.h.

childCount

s32 SpriteAnim::childCount

Definition at line 65 of file effect.h.

children

void* SpriteAnim::children

Definition at line 65 of file effect.h.

setState

void(* SpriteAnim::setState) (struct SpriteAnim *task, s32 state)

Definition at line 65 of file effect.h.

Referenced by FIGHTSTG_updateSpriteAnim().

setSubstate

void(* SpriteAnim::setSubstate) (struct SpriteAnim *task, s32 substate)

Definition at line 65 of file effect.h.

setStep

void(* SpriteAnim::setStep) (struct SpriteAnim *task, s32 step)

Definition at line 65 of file effect.h.

setCounter

void(* SpriteAnim::setCounter) (struct SpriteAnim *task, s32 counter)

Definition at line 65 of file effect.h.

nextState

void(* SpriteAnim::nextState) (struct SpriteAnim *task)

Definition at line 65 of file effect.h.

Referenced by FIGHTSTG_updateSpriteAnim().

nextSubstate

void(* SpriteAnim::nextSubstate) (struct SpriteAnim *task)

Definition at line 65 of file effect.h.

nextStep

void(* SpriteAnim::nextStep) (struct SpriteAnim *task)

Definition at line 65 of file effect.h.

tickCounter

void(* SpriteAnim::tickCounter) (struct SpriteAnim *task)

Definition at line 65 of file effect.h.

update

void(* SpriteAnim::update) ()

Definition at line 65 of file effect.h.

destroy

void(* SpriteAnim::destroy) (struct SpriteAnim *task)

Definition at line 65 of file effect.h.

data

s16* SpriteAnim::data

Definition at line 66 of file effect.h.

Referenced by FIGHTSTG_createSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

pos

SVECTOR SpriteAnim::pos

vz 0x7FFF: on screen in front, -1: on screen

Definition at line 67 of file effect.h.

Referenced by FIGHTSTG_createSpriteAnim(), and FIGHTSTG_drawSpriteAnim().

sheet

s32 SpriteAnim::sheet

Definition at line 68 of file effect.h.

Referenced by FIGHTSTG_createSpriteAnim(), and FIGHTSTG_drawSpriteAnim().

texPos

Vec2 SpriteAnim::texPos

Definition at line 69 of file effect.h.

Referenced by FIGHTSTG_createSpriteAnim(), and FIGHTSTG_drawSpriteAnim().

layerId

s32 SpriteAnim::layerId

Definition at line 70 of file effect.h.

Referenced by FIGHTSTG_createSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

time

s32 SpriteAnim::time

Definition at line 71 of file effect.h.

Referenced by FIGHTSTG_updateSpriteAnim().

flags

s32 SpriteAnim::flags

Definition at line 72 of file effect.h.

Referenced by FIGHTSTG_updateSpriteAnim().

stride

s32 SpriteAnim::stride

of a frame's values

Definition at line 73 of file effect.h.

Referenced by FIGHTSTG_updateSpriteAnim().

duration

s32 SpriteAnim::duration

Definition at line 74 of file effect.h.

Referenced by FIGHTSTG_updateSpriteAnim().

frame

s16 SpriteAnim::frame

Definition at line 75 of file effect.h.

Referenced by FIGHTSTG_drawSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

clutRow

s16 SpriteAnim::clutRow

Definition at line 76 of file effect.h.

Referenced by FIGHTSTG_drawSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

x

s16 SpriteAnim::x

Definition at line 77 of file effect.h.

Referenced by FIGHTSTG_drawSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

y

s16 SpriteAnim::y

Definition at line 78 of file effect.h.

Referenced by FIGHTSTG_drawSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

v

s16 SpriteAnim::v[2]

x, y; 0x1000 = 1.0

x, y

Definition at line 80 of file effect.h.

Referenced by FIGHTSTG_drawSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

both

s32 SpriteAnim::both

to test the two at once

Definition at line 81 of file effect.h.

Referenced by FIGHTSTG_drawSpriteAnim().

[union]

union { ... } SpriteAnim::scale

Referenced by FIGHTSTG_drawSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

[union]

union { ... } SpriteAnim::rot

Referenced by FIGHTSTG_drawSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

rotZ

s16 SpriteAnim::rotZ

Definition at line 87 of file effect.h.

Referenced by FIGHTSTG_drawSpriteAnim(), and FIGHTSTG_updateSpriteAnim().

---

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

• include/battle/battle_mode/effect.h