BattleMessageBox Struct Reference

A battle message box (FIGHTSTG_createMessage): shows its messages a line at a time, each until cross, then ends. More...

#include <battle/battle_mode/menu.h>

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 BattleMessageBox *task, s32 state)
void(*	setSubstate )(struct BattleMessageBox *task, s32 substate)
void(*	setStep )(struct BattleMessageBox *task, s32 step)
void(*	setCounter )(struct BattleMessageBox *task, s32 counter)
void(*	nextState )(struct BattleMessageBox *task)
void(*	nextSubstate )(struct BattleMessageBox *task)
void(*	nextStep )(struct BattleMessageBox *task)
void(*	tickCounter )(struct BattleMessageBox *task)
void(*	update )()
void(*	destroy )(struct BattleMessageBox *task)
s32	queue [9]
	message types for show, some with args after them; 0 ends them
s32	started
	set by show
s32	shown
	the window being shown
s32	count
	how many
s32	interval
	the time between them
s32	shownTime
s32	next
	in queue
s32	pad
	never read or written
s32	arrowPalette
	the arrow's palette, 0-4
s32	arrowTime
	when it last changed
s32	showArrow
	show the arrow
s32	found [3]
	the fighters FIGHTSTG_findFighters found
s32	foundCount
void(*	show )()
	FIGHTSTG_showMessage: (task, type, data)
void(*	finish )(struct BattleMessageBox *task)
	FIGHTSTG_finishMessage: closes after 0x14 ticks or Cross.

Detailed Description

A battle message box (FIGHTSTG_createMessage): shows its messages a line at a time, each until cross, then ends.

Definition at line 167 of file menu.h.

Field Documentation

id

s32 BattleMessageBox::id

Definition at line 168 of file menu.h.

key1

s32 BattleMessageBox::key1

Definition at line 168 of file menu.h.

key2

s32 BattleMessageBox::key2

Definition at line 168 of file menu.h.

state

s32 BattleMessageBox::state

Definition at line 168 of file menu.h.

Referenced by FIGHTSTG_stepMessage(), and FIGHTSTG_updateMessage().

substate

s32 BattleMessageBox::substate

Definition at line 168 of file menu.h.

Referenced by FIGHTSTG_finishMessage(), and FIGHTSTG_stepMessage().

step

s32 BattleMessageBox::step

Definition at line 168 of file menu.h.

Referenced by FIGHTSTG_finishMessage(), and FIGHTSTG_stepMessage().

counter

s32 BattleMessageBox::counter

Definition at line 168 of file menu.h.

paused

s32 BattleMessageBox::paused

Definition at line 168 of file menu.h.

childCount

s32 BattleMessageBox::childCount

Definition at line 168 of file menu.h.

children

void* BattleMessageBox::children

Definition at line 168 of file menu.h.

Referenced by FIGHTSTG_showMessage().

setState

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

Definition at line 168 of file menu.h.

setSubstate

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

Definition at line 168 of file menu.h.

Referenced by FIGHTSTG_stepMessage().

setStep

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

Definition at line 168 of file menu.h.

setCounter

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

Definition at line 168 of file menu.h.

nextState

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

Definition at line 168 of file menu.h.

Referenced by FIGHTSTG_updateMessage().

nextSubstate

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

Definition at line 168 of file menu.h.

nextStep

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

Definition at line 168 of file menu.h.

tickCounter

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

Definition at line 168 of file menu.h.

update

void(* BattleMessageBox::update) ()

Definition at line 168 of file menu.h.

destroy

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

Definition at line 168 of file menu.h.

queue

s32 BattleMessageBox::queue[9]

message types for show, some with args after them; 0 ends them

Definition at line 169 of file menu.h.

Referenced by FIGHTSTG_showMessage(), and FIGHTSTG_stepMessage().

started

s32 BattleMessageBox::started

set by show

Definition at line 170 of file menu.h.

Referenced by FIGHTSTG_showMessage(), and FIGHTSTG_stepMessage().

shown

s32 BattleMessageBox::shown

the window being shown

Definition at line 171 of file menu.h.

Referenced by FIGHTSTG_showMessage(), and FIGHTSTG_stepMessage().

count

s32 BattleMessageBox::count

how many

Definition at line 172 of file menu.h.

Referenced by FIGHTSTG_showFightersMessage(), FIGHTSTG_showMessage(), and FIGHTSTG_stepMessage().

interval

s32 BattleMessageBox::interval

the time between them

Definition at line 173 of file menu.h.

Referenced by FIGHTSTG_stepMessage().

shownTime

s32 BattleMessageBox::shownTime

Definition at line 174 of file menu.h.

Referenced by FIGHTSTG_stepMessage().

next

s32 BattleMessageBox::next

in queue

Definition at line 175 of file menu.h.

Referenced by FIGHTSTG_showMessage(), and FIGHTSTG_stepMessage().

pad

s32 BattleMessageBox::pad

never read or written

Definition at line 176 of file menu.h.

arrowPalette

s32 BattleMessageBox::arrowPalette

the arrow's palette, 0-4

Definition at line 177 of file menu.h.

Referenced by FIGHTSTG_drawMessageBox().

arrowTime

s32 BattleMessageBox::arrowTime

when it last changed

Definition at line 178 of file menu.h.

Referenced by FIGHTSTG_drawMessageBox().

showArrow

s32 BattleMessageBox::showArrow

show the arrow

Definition at line 179 of file menu.h.

Referenced by FIGHTSTG_drawMessageBox(), FIGHTSTG_finishMessage(), and FIGHTSTG_stepMessage().

found

s32 BattleMessageBox::found[3]

the fighters FIGHTSTG_findFighters found

Definition at line 180 of file menu.h.

Referenced by FIGHTSTG_findFighters(), and FIGHTSTG_showFightersMessage().

foundCount

s32 BattleMessageBox::foundCount

Definition at line 181 of file menu.h.

Referenced by FIGHTSTG_findFighters(), and FIGHTSTG_showFightersMessage().

show

void(* BattleMessageBox::show) ()

FIGHTSTG_showMessage: (task, type, data)

Definition at line 182 of file menu.h.

Referenced by announceEnemyTech(), announceFirstTech(), announceKnockOut(), announceTech(), applyStatusEvent(), boostAttack(), boostDefense(), boostElement(), boostFieldElement(), boostFighterStat(), boostRandomElement(), boostSideStat(), boostSpeed(), chargeUser(), confuseFighters(), cureStatus(), cureStatusTech(), damageEnemy(), damagePlayer(), dealTechDamage(), drainEnemy(), drainHp(), drainMp(), drainMp(), endBattleOnKnockOut(), FIGHTSTG_createMessage(), FIGHTSTG_stepMessage(), FIGHTSTG_updateCounterattack(), FIGHTSTG_updateEnemyAttack(), FIGHTSTG_updateEnemyTurn(), FIGHTSTG_updateItem(), FIGHTSTG_updateOneHpTurn(), fillGauge(), fleeWhenWeak(), healEnemy(), healPartner(), healWithTech(), lowerEnemySpeed(), queueFirstTurns(), restoreHalfHpMp(), restoreSide(), reviveParty(), reviveSide(), showCounterResult(), showEnemyName(), showFirstTechResult(), showLoweredStat(), showNextRaisedStatus(), showOtherAttackResult(), showRaisedStatus(), showRunAway(), startSpecial(), stealEnemyItem(), switchEnemyOut(), useEnemyTech(), useItemTech(), useSupportTech(), wakeCounteredUp(), wakePlayerUp(), wakeUpOrCounter(), weakenEnemyDefense(), WFIGHTMN_blast(), WFIGHTMN_bringLastEnemy(), WFIGHTMN_clearField(), WFIGHTMN_cureStatus(), WFIGHTMN_digidevolve(), WFIGHTMN_digivolve(), WFIGHTMN_endAutoRecover(), WFIGHTMN_endBlast(), WFIGHTMN_endBoost(), WFIGHTMN_endRestriction(), WFIGHTMN_endSpecial(), WFIGHTMN_knockOut(), WFIGHTMN_recover(), WFIGHTMN_runAway(), WFIGHTMN_runCommand(), WFIGHTMN_tag(), and WFIGHTMN_takeDamage().

finish

void(* BattleMessageBox::finish) (struct BattleMessageBox *task)

FIGHTSTG_finishMessage: closes after 0x14 ticks or Cross.

Definition at line 183 of file menu.h.

Referenced by FIGHTSTG_createMessage(), and WFIGHTMN_showWon().

---

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

• include/battle/battle_mode/menu.h