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

One menu song of the songs entry of the metagame configuration, loading its tracks into a Mix. More...

#include <metamusicsong.h>

Public Member Functions

 MetaMusicSong (Mix *pMix, DataArray *pConfig)
 Build the song and the path of its sample bank.
 ~MetaMusicSong ()
 Release the reader of the song.
void StartLoad ()
 Start reading the song's MIDI file.
void Poll ()
 Read more of the song, and hand its tracks to the music once the file has been read.
int IsLoaded () const
 Report whether the tracks have been handed to the music.
const char * BankFile () const
 Report the sample bank of the song.
void FindBankFile ()
 Set the bank file to the bank_file entry, beside the configuration file of the entry.
void AddTracks ()
 Hand each track the reader built to the music, and then the track names of each mix entry.

Detailed Description

One menu song of the songs entry of the metagame configuration, loading its tracks into a Mix.

The class is not polymorphic and has no RTTI. The name is inferred. The object is 0x24 bytes.

Constructor & Destructor Documentation

◆ MetaMusicSong()

MetaMusicSong::MetaMusicSong ( Mix * pMix,
DataArray * pConfig )

Build the song and the path of its sample bank.

Parameters
pMixThe music the tracks load into.
pConfigThe entry of the song, with its bank_file and mix entries.
Ghidra address:
NTSC-U/C: 0x0016a440
Ghidra address:
PAL: 0x0016d5c8

◆ ~MetaMusicSong()

MetaMusicSong::~MetaMusicSong ( )

Release the reader of the song.

Ghidra address:
NTSC-U/C: 0x0016a4b0
Ghidra address:
PAL: 0x0016d638

Member Function Documentation

◆ StartLoad()

void MetaMusicSong::StartLoad ( )

Start reading the song's MIDI file.

Ghidra address:
NTSC-U/C: 0x0016a510
Ghidra address:
PAL: 0x0016d698

◆ Poll()

void MetaMusicSong::Poll ( )

Read more of the song, and hand its tracks to the music once the file has been read.

Ghidra address:
NTSC-U/C: 0x0016a558
Ghidra address:
PAL: 0x0016d6e0

◆ IsLoaded()

int MetaMusicSong::IsLoaded ( ) const

Report whether the tracks have been handed to the music.

Returns
Non-zero when the song has loaded.
Ghidra address:
NTSC-U/C: 0x0016a5b0
Ghidra address:
PAL: 0x0016d738

◆ BankFile()

const char * MetaMusicSong::BankFile ( ) const

Report the sample bank of the song.

Returns
The bank file.
Ghidra address:
NTSC-U/C: 0x0016a5c8
Ghidra address:
PAL: 0x0016d750

◆ FindBankFile()

void MetaMusicSong::FindBankFile ( )

Set the bank file to the bank_file entry, beside the configuration file of the entry.

Ghidra address:
NTSC-U/C: 0x0016a5d0
Ghidra address:
PAL: 0x0016d758

◆ AddTracks()

void MetaMusicSong::AddTracks ( )

Hand each track the reader built to the music, and then the track names of each mix entry.

Ghidra address:
NTSC-U/C: 0x0016a6a0
Ghidra address:
PAL: 0x0016d828

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