stage.h File Reference

FIGHTSTG's fight stages and their lights (stage.c and lights.c). More...

#include "battle/battle_mode/types.h"
#include "battle/battle_mode/model.h"

Include dependency graph for stage.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	LightSet
	A fight stage's lights: three flat lights and the ambient colour. More...
struct	FightStageInfo
	A fight stage, in FILE_FIGHT_STAGES. More...
struct	FightStage
	The fight stage (FIGHTSTG_createStage), registered as BATTLE_TASK_STAGE: its model, which fades in from black, and its music. More...
struct	Lights
	The stage lights (FIGHTSTG_createLights), registered as BATTLE_TASK_LIGHTS: set puts a light set, fade goes from one to another in time frames. More...

Macros
#define	FILE_FIGHT_STAGES   0x1CB
	The fight stages, the battle's backgrounds: WFIGHTTS lists them as MFSTG001-027.

Functions
FightStage *	FIGHTSTG_createStage (s32 id, s32 fadeInTime)
	The tasks FIGHTSTG starts for WFIGHTMN and WFIGHTTS.
Lights *	FIGHTSTG_createLights (s32 layerId)
	Creates the stage lights (id 0x13) for layer layerId.
void	FIGHTSTG_fadeStage (FightStage *task, Model **children)
	Sets the stage model's color and SCREEN_LAYER's background to their fades' current values (a black background is drawn as 1, 1, 1)
void	FIGHTSTG_updateStage (FightStage *task, Model **children)
	The fight stage's task: loads the stage's model, starts its music and fades in its lights, then fades the model's color and the background in from black; setStage fades them out, frees the old model and stops its music, and loads the new stage.
void	FIGHTSTG_setStage (FightStage *task, s32 id, s32 fadeOutTime, s32 fadeInTime)
	FightStage.setStage: changes to stage ID, fading the old one out over FADEOUTTIME and the new one in over FADEINTIME.
void	FIGHTSTG_updateLights (Lights *task)
	The stage lights' task: steps their fade, then sets the three flat lights and the ambient color for the layer each frame.
void	FIGHTSTG_setLights (Lights *task, LightSet *set)
	Lights.set: switches to SET at once.
void	FIGHTSTG_fadeLights (Lights *task, LightSet *from, LightSet *to, s32 time)
	Lights.fade: fades from FROM (NULL for the current lights) to TO over TIME.
LightSet *	FIGHTSTG_getStageLights (Lights *task, s32 stage)
	Lights.getStageLights: fight stage STAGE's lights.
s32	FIGHTSTG_randomStage (void)
	A random fight stage, 1-27.
s32	FIGHTSTG_getStageMotionsFile (s32 id)
	The file of fight stage ID's motions.

Variables
s32	FIGHTSTG_stageMusic []
	Shared between the overlay's objects.

Detailed Description

FIGHTSTG's fight stages and their lights (stage.c and lights.c).

Definition in file stage.h.

Macro Definition Documentation

FILE_FIGHT_STAGES

#define FILE_FIGHT_STAGES   0x1CB

The fight stages, the battle's backgrounds: WFIGHTTS lists them as MFSTG001-027.

Definition at line 14 of file stage.h.

Function Documentation

FIGHTSTG_createStage()

FightStage * FIGHTSTG_createStage	(	s32	id,
		s32	fadeInTime
	)

The tasks FIGHTSTG starts for WFIGHTMN and WFIGHTTS.

The tasks FIGHTSTG starts for WFIGHTMN and WFIGHTTS.

Definition at line 213 of file stage.c.

Referenced by setUpBattle(), and WFIGHTMN_updateMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

FIGHTSTG_createLights()

Lights * FIGHTSTG_createLights

(

s32

layerId

)

Creates the stage lights (id 0x13) for layer layerId.

Definition at line 118 of file lights.c.

Referenced by setUpBattle(), and WFIGHTMN_updateMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

FIGHTSTG_fadeStage()

void FIGHTSTG_fadeStage	(	FightStage *	task,
		Model **	children
	)

Sets the stage model's color and SCREEN_LAYER's background to their fades' current values (a black background is drawn as 1, 1, 1)

Definition at line 8 of file stage.c.

Referenced by FIGHTSTG_updateStage().

Here is the caller graph for this function:

FIGHTSTG_updateStage()

void FIGHTSTG_updateStage	(	FightStage *	task,
		Model **	children
	)

The fight stage's task: loads the stage's model, starts its music and fades in its lights, then fades the model's color and the background in from black; setStage fades them out, frees the old model and stops its music, and loads the new stage.

Definition at line 118 of file stage.c.

Referenced by FIGHTSTG_createStage().

Here is the call graph for this function:

Here is the caller graph for this function:

FIGHTSTG_setStage()

void FIGHTSTG_setStage	(	FightStage *	task,
		s32	id,
		s32	fadeOutTime,
		s32	fadeInTime
	)

FightStage.setStage: changes to stage ID, fading the old one out over FADEOUTTIME and the new one in over FADEINTIME.

Definition at line 189 of file stage.c.

Referenced by FIGHTSTG_createStage().

Here is the caller graph for this function:

FIGHTSTG_updateLights()

void FIGHTSTG_updateLights

(

Lights *

task

)

The stage lights' task: steps their fade, then sets the three flat lights and the ambient color for the layer each frame.

Definition at line 7 of file lights.c.

Referenced by FIGHTSTG_createLights().

Here is the caller graph for this function:

FIGHTSTG_setLights()

void FIGHTSTG_setLights	(	Lights *	task,
		LightSet *	set
	)

Lights.set: switches to SET at once.

Definition at line 92 of file lights.c.

Referenced by FIGHTSTG_createLights().

Here is the caller graph for this function:

FIGHTSTG_fadeLights()

void FIGHTSTG_fadeLights	(	Lights *	task,
		LightSet *	from,
		LightSet *	to,
		s32	time
	)

Lights.fade: fades from FROM (NULL for the current lights) to TO over TIME.

Definition at line 98 of file lights.c.

Referenced by FIGHTSTG_createLights().

Here is the caller graph for this function:

FIGHTSTG_getStageLights()

LightSet * FIGHTSTG_getStageLights	(	Lights *	task,
		s32	stage
	)

Lights.getStageLights: fight stage STAGE's lights.

Definition at line 111 of file lights.c.

Referenced by FIGHTSTG_createLights().

Here is the caller graph for this function:

FIGHTSTG_randomStage()

s32 FIGHTSTG_randomStage

(

void

)

A random fight stage, 1-27.

Definition at line 200 of file stage.c.

Referenced by FIGHTSTG_updateRoot().

Here is the caller graph for this function:

FIGHTSTG_getStageMotionsFile()

s32 FIGHTSTG_getStageMotionsFile

(

s32

id

)

The file of fight stage ID's motions.

Definition at line 205 of file stage.c.

Referenced by FIGHTSTG_runScriptStage().

Here is the caller graph for this function:

Variable Documentation

FIGHTSTG_stageMusic

s32 FIGHTSTG_stageMusic[]

extern

Shared between the overlay's objects.

Shared between the overlay's objects.

Definition at line 31 of file stage.c.

Referenced by FIGHTSTG_updateStage().