PlayerTurn Struct Reference

The player's turn (FIGHTSTG_updatePlayerTurn, BATTLE_TASK_PLAYER_TURN): the battle menu, then the menus of its commands. 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 PlayerTurn *task, s32 state)
void(*	setSubstate )(struct PlayerTurn *task, s32 substate)
void(*	setStep )(struct PlayerTurn *task, s32 step)
void(*	setCounter )(struct PlayerTurn *task, s32 counter)
void(*	nextState )(struct PlayerTurn *task)
void(*	nextSubstate )(struct PlayerTurn *task)
void(*	nextStep )(struct PlayerTurn *task)
void(*	tickCounter )(struct PlayerTurn *task)
void(*	update )()
void(*	destroy )(struct PlayerTurn *task)
s32	command
	the command menu's choice, a BATTLE_COMMAND_*
s32	switchLine
	FIGHTSTG_createSwitchMenu's line, kept while the turn goes back to it.
s32	result
	the open menu's, -1 until it is done and -2 to go back
s32	action
	what the turn does
s32	arg
	the action's: the item, the technique, or the party slot of the partner that digivolves or switches out
s32	digimon
	the Digimon a partner changes into, or the one it switches to
s32	pairTech
	FIGHTSTG_createPairSwitchMenu's technique, which the outgoing and incoming partners do together (action 6)

Detailed Description

The player's turn (FIGHTSTG_updatePlayerTurn, BATTLE_TASK_PLAYER_TURN): the battle menu, then the menus of its commands.

Definition at line 32 of file menu.h.

Field Documentation

id

s32 PlayerTurn::id

Definition at line 33 of file menu.h.

key1

s32 PlayerTurn::key1

Definition at line 33 of file menu.h.

key2

s32 PlayerTurn::key2

Definition at line 33 of file menu.h.

state

s32 PlayerTurn::state

Definition at line 33 of file menu.h.

Referenced by FIGHTSTG_updatePlayerTurn().

substate

s32 PlayerTurn::substate

Definition at line 33 of file menu.h.

Referenced by FIGHTSTG_isPlayerChoosing(), and FIGHTSTG_updatePlayerTurn().

step

s32 PlayerTurn::step

Definition at line 33 of file menu.h.

Referenced by FIGHTSTG_updatePlayerTurn().

counter

s32 PlayerTurn::counter

Definition at line 33 of file menu.h.

Referenced by runCommandMenu(), runConfusedMenu(), runDigivolveMenu(), runItemMenu(), runKnockOutSwitchMenu(), runSwitchMenu(), and runTechMenu().

paused

s32 PlayerTurn::paused

Definition at line 33 of file menu.h.

childCount

s32 PlayerTurn::childCount

Definition at line 33 of file menu.h.

children

void* PlayerTurn::children

Definition at line 33 of file menu.h.

setState

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

Definition at line 33 of file menu.h.

setSubstate

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

Definition at line 33 of file menu.h.

Referenced by FIGHTSTG_updatePlayerTurn(), runCommandMenu(), runConfusedMenu(), runDigivolveMenu(), runItemMenu(), runKnockOutSwitchMenu(), runSwitchMenu(), and runTechMenu().

setStep

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

Definition at line 33 of file menu.h.

Referenced by runCommandMenu().

setCounter

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

Definition at line 33 of file menu.h.

Referenced by runKnockOutSwitchMenu(), and runSwitchMenu().

nextState

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

Definition at line 33 of file menu.h.

Referenced by FIGHTSTG_updatePlayerTurn().

nextSubstate

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

Definition at line 33 of file menu.h.

nextStep

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

Definition at line 33 of file menu.h.

Referenced by FIGHTSTG_updatePlayerTurn().

tickCounter

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

Definition at line 33 of file menu.h.

Referenced by runCommandMenu(), runConfusedMenu(), runDigivolveMenu(), runItemMenu(), runKnockOutSwitchMenu(), runSwitchMenu(), and runTechMenu().

update

void(* PlayerTurn::update) ()

Definition at line 33 of file menu.h.

destroy

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

Definition at line 33 of file menu.h.

command

s32 PlayerTurn::command

the command menu's choice, a BATTLE_COMMAND_*

Definition at line 34 of file menu.h.

Referenced by FIGHTSTG_updatePlayerTurn(), and runCommandMenu().

switchLine

s32 PlayerTurn::switchLine

FIGHTSTG_createSwitchMenu's line, kept while the turn goes back to it.

Definition at line 35 of file menu.h.

Referenced by runCommandMenu(), runKnockOutSwitchMenu(), and runSwitchMenu().

result

s32 PlayerTurn::result

the open menu's, -1 until it is done and -2 to go back

Definition at line 36 of file menu.h.

Referenced by runCommandMenu(), runConfusedMenu(), runDigivolveMenu(), runItemMenu(), runKnockOutSwitchMenu(), runSwitchMenu(), and runTechMenu().

action

s32 PlayerTurn::action

what the turn does

Definition at line 37 of file menu.h.

Referenced by runCommandMenu(), runConfusedMenu(), runDigivolveMenu(), runItemMenu(), runKnockOutSwitchMenu(), runSwitchMenu(), runTechMenu(), WFIGHTMN_runCommand(), and WFIGHTMN_runConfusedCommand().

arg

s32 PlayerTurn::arg

the action's: the item, the technique, or the party slot of the partner that digivolves or switches out

Definition at line 38 of file menu.h.

Referenced by runDigivolveMenu(), runItemMenu(), runKnockOutSwitchMenu(), runSwitchMenu(), runTechMenu(), WFIGHTMN_markPicked(), WFIGHTMN_runCommand(), and WFIGHTMN_tag().

digimon

s32 PlayerTurn::digimon

the Digimon a partner changes into, or the one it switches to

Definition at line 39 of file menu.h.

Referenced by runDigivolveMenu(), runKnockOutSwitchMenu(), runSwitchMenu(), WFIGHTMN_digivolve(), WFIGHTMN_markPicked(), and WFIGHTMN_tag().

pairTech

s32 PlayerTurn::pairTech

FIGHTSTG_createPairSwitchMenu's technique, which the outgoing and incoming partners do together (action 6)

Definition at line 40 of file menu.h.

Referenced by runSwitchMenu(), and WFIGHTMN_pairTech().

---

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

• include/battle/battle_mode/menu.h