wavelength 1.0.0
Loading...
Searching...
No Matches
MetagameArena Class Reference

The arena scene shown behind the front end, and its arena unlock animations. More...

#include <metagamearena.h>

Public Member Functions

 MetagameArena ()
 Build the arena with nothing loaded.
 ~MetagameArena ()
 Delete the load of the arena scene.
void StartLoad ()
 Start loading the arena scene across frames.
bool IsLoaded () const
 Report whether the arena scene and its triggers have loaded.
void ShowUnlocks ()
 Set the frame of each unlock animation to show the arenas the player has unlocked.
void Unload ()
 Stop the triggers and delete the arena scene.
void Poll (int nState, int nLoadStage, float flTime, float flTick)
 Advance the arena scene and the unlock animations by one frame.
void Draw (int nState)
 Draw the arena scene while the front end shows and the scene has loaded.
void SetRevealArena (int nArena)
 Choose the arena the next reveal shows.
void StartReveal (float flTime)
 Start the animation that reveals the chosen arena.

Detailed Description

The arena scene shown behind the front end, and its arena unlock animations.

The class is not polymorphic and has no RTTI. The name is inferred from the Metagame/Arena/s.rnd file it loads, named after the arena_prefix entry of the metagame configuration. Metagame builds the one instance. The scene loads first, then the triggers of the trigger_file entry. An unlock reveal plays one ArenaUnlockAnim_0N.view and its particles.

Constructor & Destructor Documentation

◆ MetagameArena()

MetagameArena::MetagameArena ( )

Build the arena with nothing loaded.

Ghidra address:
NTSC-U/C: 0x00162808
Ghidra address:
PAL: 0x00165580

◆ ~MetagameArena()

MetagameArena::~MetagameArena ( )

Delete the load of the arena scene.

Ghidra address:
NTSC-U/C: 0x00162870
Ghidra address:
PAL: 0x001655e8

Member Function Documentation

◆ StartLoad()

void MetagameArena::StartLoad ( )

Start loading the arena scene across frames.

Ghidra address:
NTSC-U/C: 0x001628d0
Ghidra address:
PAL: 0x00165648

◆ IsLoaded()

bool MetagameArena::IsLoaded ( ) const

Report whether the arena scene and its triggers have loaded.

Returns
Whether the scene is ready.
Ghidra address:
NTSC-U/C: 0x00162988
Ghidra address:
PAL: 0x00165700

◆ ShowUnlocks()

void MetagameArena::ShowUnlocks ( )

Set the frame of each unlock animation to show the arenas the player has unlocked.

The animation of the arena being revealed stays at its first frame.

Ghidra address:
NTSC-U/C: 0x00162cc8
Ghidra address:
PAL: 0x00165a40

◆ Unload()

void MetagameArena::Unload ( )

Stop the triggers and delete the arena scene.

Ghidra address:
NTSC-U/C: 0x00162ef0
Ghidra address:
PAL: 0x00165c68

◆ Poll()

void MetagameArena::Poll ( int nState,
int nLoadStage,
float flTime,
float flTick )

Advance the arena scene and the unlock animations by one frame.

Parameters
nStateThe metagame state, one of Metagame::State.
nLoadStageThe metagame load stage, one of Metagame::LoadStage.
flTimeThe front end clock.
flTickThe front end clock in ticks.
Ghidra address:
NTSC-U/C: 0x00162f38
Ghidra address:
PAL: 0x00165cb0

◆ Draw()

void MetagameArena::Draw ( int nState)

Draw the arena scene while the front end shows and the scene has loaded.

Parameters
nStateThe metagame state, one of Metagame::State.
Ghidra address:
NTSC-U/C: 0x00163160
Ghidra address:
PAL: 0x00165ed8

◆ SetRevealArena()

void MetagameArena::SetRevealArena ( int nArena)

Choose the arena the next reveal shows.

Parameters
nArenaThe arena, counted from 1.
Ghidra address:
NTSC-U/C: 0x001631c8
Ghidra address:
PAL: 0x00165f40

◆ StartReveal()

void MetagameArena::StartReveal ( float flTime)

Start the animation that reveals the chosen arena.

Parameters
flTimeThe front end clock.
Ghidra address:
NTSC-U/C: 0x001631d8
Ghidra address:
PAL: 0x00165f50

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