TrainSprite Struct Reference

Draws an animated sprite, maybe rotated and scaled (STGTRAIN_createSprite) More...

#include <menus/gym.h>

Collaboration diagram for TrainSprite:

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 TrainSprite *task, s32 state)
void(*	setSubstate )(struct TrainSprite *task, s32 substate)
void(*	setStep )(struct TrainSprite *task, s32 step)
void(*	setCounter )(struct TrainSprite *task, s32 counter)
void(*	nextState )(struct TrainSprite *task)
void(*	nextSubstate )(struct TrainSprite *task)
void(*	nextStep )(struct TrainSprite *task)
void(*	tickCounter )(struct TrainSprite *task)
void(*	update )()
void(*	destroy )(struct TrainSprite *task)
Layer *	layer
u_long *	ot
s32	layerId
s32	depth
s32	x
s32	y
s32	imageX
s32	imageY
s32	clutX
s32	clutY
s32	flags
	bit 31: paused; the rest, ended
s32	pad
	never read or written
TrainSpriteBank *	bank
u16	unk84
	the bank's unk2 and spriteCount: nothing reads them
u16	spriteCount
s32	bankOffset
TrainAnim *	anim
s32	frame
s32	frameCount
s32	frameTime
s32	transformed
s32	pivotX
s32	pivotY
VECTOR	scale
SVECTOR	rotation
MATRIX	matrix
void(*	setBank )(struct TrainSprite *sprite, TrainSpriteBank *bank, s32 offset)
void(*	setAnim )(struct TrainSprite *sprite, TrainAnim *anim)
void(*	setPos )(struct TrainSprite *sprite, s32 x, s32 y)
void(*	setImagePos )(struct TrainSprite *sprite, s32 x, s32 y)
void(*	setLayer )(struct TrainSprite *sprite, s32 layerId, s32 depth)
void(*	setClutPos )(struct TrainSprite *sprite, s32 x, s32 y)
void(*	setScale )(struct TrainSprite *sprite, s32 x, s32 y, s32 z)
void(*	setPivot )(struct TrainSprite *sprite, s32 x, s32 y)
void(*	setRotation )(struct TrainSprite *sprite, s16 x, s16 y, s16 z)
s32(*	getFlags )(struct TrainSprite *sprite)
void(*	setPaused )(struct TrainSprite *sprite, s32 paused)

Detailed Description

Draws an animated sprite, maybe rotated and scaled (STGTRAIN_createSprite)

Definition at line 64 of file gym.h.

Field Documentation

id

s32 TrainSprite::id

Definition at line 65 of file gym.h.

key1

s32 TrainSprite::key1

Definition at line 65 of file gym.h.

key2

s32 TrainSprite::key2

Definition at line 65 of file gym.h.

state

s32 TrainSprite::state

Definition at line 65 of file gym.h.

Referenced by STGTRAIN_updateSprite().

substate

s32 TrainSprite::substate

Definition at line 65 of file gym.h.

step

s32 TrainSprite::step

Definition at line 65 of file gym.h.

counter

s32 TrainSprite::counter

Definition at line 65 of file gym.h.

paused

s32 TrainSprite::paused

Definition at line 65 of file gym.h.

childCount

s32 TrainSprite::childCount

Definition at line 65 of file gym.h.

children

void* TrainSprite::children

Definition at line 65 of file gym.h.

setState

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

Definition at line 65 of file gym.h.

Referenced by STGTRAIN_setUpActor().

setSubstate

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

Definition at line 65 of file gym.h.

setStep

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

Definition at line 65 of file gym.h.

setCounter

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

Definition at line 65 of file gym.h.

nextState

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

Definition at line 65 of file gym.h.

Referenced by STGTRAIN_updateSprite().

nextSubstate

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

Definition at line 65 of file gym.h.

nextStep

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

Definition at line 65 of file gym.h.

tickCounter

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

Definition at line 65 of file gym.h.

update

void(* TrainSprite::update) ()

Definition at line 65 of file gym.h.

destroy

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

Definition at line 65 of file gym.h.

layer

Layer* TrainSprite::layer

Definition at line 66 of file gym.h.

Referenced by STGTRAIN_updateSprite().

ot

u_long* TrainSprite::ot

Definition at line 67 of file gym.h.

Referenced by STGTRAIN_addSpriteQuad(), STGTRAIN_addSpriteSprt(), and STGTRAIN_updateSprite().

layerId

s32 TrainSprite::layerId

Definition at line 68 of file gym.h.

Referenced by STGTRAIN_setSpriteLayer(), and STGTRAIN_updateSprite().

depth

s32 TrainSprite::depth

Definition at line 69 of file gym.h.

Referenced by STGTRAIN_setSpriteLayer(), and STGTRAIN_updateSprite().

x

s32 TrainSprite::x

Definition at line 70 of file gym.h.

Referenced by STGTRAIN_addSpriteQuad(), STGTRAIN_addSpriteSprt(), and STGTRAIN_setSpritePos().

y

s32 TrainSprite::y

Definition at line 71 of file gym.h.

Referenced by STGTRAIN_addSpriteQuad(), STGTRAIN_addSpriteSprt(), and STGTRAIN_setSpritePos().

imageX

s32 TrainSprite::imageX

Definition at line 72 of file gym.h.

Referenced by STGTRAIN_setSpriteImagePos(), and STGTRAIN_updateSprite().

imageY

s32 TrainSprite::imageY

Definition at line 73 of file gym.h.

Referenced by STGTRAIN_setSpriteImagePos(), and STGTRAIN_updateSprite().

clutX

s32 TrainSprite::clutX

Definition at line 74 of file gym.h.

Referenced by STGTRAIN_setSpriteClutPos(), and STGTRAIN_updateSprite().

clutY

s32 TrainSprite::clutY

Definition at line 75 of file gym.h.

Referenced by STGTRAIN_setSpriteClutPos(), and STGTRAIN_updateSprite().

flags

s32 TrainSprite::flags

bit 31: paused; the rest, ended

Definition at line 76 of file gym.h.

Referenced by STGTRAIN_getSpriteFlags(), STGTRAIN_setSpriteAnim(), STGTRAIN_setSpritePaused(), and STGTRAIN_updateSprite().

pad

s32 TrainSprite::pad

never read or written

Definition at line 77 of file gym.h.

bank

TrainSpriteBank* TrainSprite::bank

Definition at line 78 of file gym.h.

Referenced by STGTRAIN_setSpriteBank(), and STGTRAIN_updateSprite().

unk84

u16 TrainSprite::unk84

the bank's unk2 and spriteCount: nothing reads them

Definition at line 79 of file gym.h.

Referenced by STGTRAIN_setSpriteBank().

spriteCount

u16 TrainSprite::spriteCount

Definition at line 80 of file gym.h.

Referenced by STGTRAIN_setSpriteBank().

bankOffset

s32 TrainSprite::bankOffset

Definition at line 81 of file gym.h.

Referenced by STGTRAIN_setSpriteBank(), and STGTRAIN_updateSprite().

anim

TrainAnim* TrainSprite::anim

Definition at line 82 of file gym.h.

Referenced by STGTRAIN_setSpriteAnim(), and STGTRAIN_updateSprite().

frame

s32 TrainSprite::frame

Definition at line 83 of file gym.h.

Referenced by STGTRAIN_setSpriteAnim(), and STGTRAIN_updateSprite().

frameCount

s32 TrainSprite::frameCount

Definition at line 84 of file gym.h.

Referenced by STGTRAIN_setSpriteAnim(), and STGTRAIN_updateSprite().

frameTime

s32 TrainSprite::frameTime

Definition at line 85 of file gym.h.

Referenced by STGTRAIN_setSpriteAnim(), and STGTRAIN_updateSprite().

transformed

s32 TrainSprite::transformed

Definition at line 86 of file gym.h.

Referenced by STGTRAIN_setSpriteRotation(), STGTRAIN_setSpriteScale(), and STGTRAIN_updateSprite().

pivotX

s32 TrainSprite::pivotX

Definition at line 87 of file gym.h.

Referenced by STGTRAIN_addSpriteQuad(), and STGTRAIN_setSpritePivot().

pivotY

s32 TrainSprite::pivotY

Definition at line 88 of file gym.h.

Referenced by STGTRAIN_addSpriteQuad(), and STGTRAIN_setSpritePivot().

scale

VECTOR TrainSprite::scale

Definition at line 89 of file gym.h.

Referenced by STGTRAIN_setSpriteScale(), and STGTRAIN_updateSprite().

rotation

SVECTOR TrainSprite::rotation

Definition at line 90 of file gym.h.

Referenced by STGTRAIN_setSpriteRotation(), and STGTRAIN_updateSprite().

matrix

MATRIX TrainSprite::matrix

Definition at line 91 of file gym.h.

Referenced by STGTRAIN_addSpriteQuad(), and STGTRAIN_updateSprite().

setBank

void(* TrainSprite::setBank) (struct TrainSprite *sprite, TrainSpriteBank *bank, s32 offset)

Definition at line 92 of file gym.h.

Referenced by STGTRAIN_createSprite(), and STGTRAIN_setUpActor().

setAnim

void(* TrainSprite::setAnim) (struct TrainSprite *sprite, TrainAnim *anim)

Definition at line 93 of file gym.h.

Referenced by STGTRAIN_createSprite(), STGTRAIN_playTraining(), STGTRAIN_playTrainingEnd(), and STGTRAIN_setUpActor().

setPos

void(* TrainSprite::setPos) (struct TrainSprite *sprite, s32 x, s32 y)

Definition at line 94 of file gym.h.

Referenced by STGTRAIN_createSprite(), and STGTRAIN_setUpActor().

setImagePos

void(* TrainSprite::setImagePos) (struct TrainSprite *sprite, s32 x, s32 y)

Definition at line 95 of file gym.h.

Referenced by STGTRAIN_createSprite(), and STGTRAIN_setUpActor().

setLayer

void(* TrainSprite::setLayer) (struct TrainSprite *sprite, s32 layerId, s32 depth)

Definition at line 96 of file gym.h.

Referenced by STGTRAIN_createSprite(), and STGTRAIN_setUpActor().

setClutPos

void(* TrainSprite::setClutPos) (struct TrainSprite *sprite, s32 x, s32 y)

Definition at line 97 of file gym.h.

Referenced by STGTRAIN_createSprite(), and STGTRAIN_setUpActor().

setScale

void(* TrainSprite::setScale) (struct TrainSprite *sprite, s32 x, s32 y, s32 z)

Definition at line 98 of file gym.h.

Referenced by STGTRAIN_createSprite(), STGTRAIN_scaleActor(), and STGTRAIN_updateActor().

setPivot

void(* TrainSprite::setPivot) (struct TrainSprite *sprite, s32 x, s32 y)

Definition at line 99 of file gym.h.

Referenced by STGTRAIN_createSprite(), and STGTRAIN_scaleActor().

setRotation

void(* TrainSprite::setRotation) (struct TrainSprite *sprite, s16 x, s16 y, s16 z)

Definition at line 100 of file gym.h.

Referenced by STGTRAIN_createSprite().

getFlags

s32(* TrainSprite::getFlags) (struct TrainSprite *sprite)

Definition at line 101 of file gym.h.

Referenced by STGTRAIN_actorAnimDone(), and STGTRAIN_createSprite().

setPaused

void(* TrainSprite::setPaused) (struct TrainSprite *sprite, s32 paused)

Definition at line 102 of file gym.h.

Referenced by STGTRAIN_createSprite(), STGTRAIN_pauseActor(), STGTRAIN_playActor(), and STGTRAIN_stopActor().

---

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

• include/menus/gym.h