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

View of the entry of one song in the "songs" section of the configuration. More...

#include <songentry.h>

Public Types

enum  Type {
  kTypeNormal = 0 , kTypeBoss = 1 , kTypeBonus = 2 , kTypeSecret = 3 ,
  kTypeTutorial = 4
}
 Values of GetType(). More...

Public Member Functions

 SongEntry ()=default
 SongEntry (DataArray *pData)
 Construct the entry of a song.
int GetType () const
 Report the type of the song.
const char * GetName () const
 Report the name of the song, the first symbol of the entry.
int GetId () const
 Report the number of the song, the id of the entry.
const char * GetTitle () const
 Report the localised title of the song.
const char * GetArtist () const
 Report the localised artist, the token <name>_ARTIST.
const char * GetLabel () const
 Report the localised record label, the token <name>_LABEL.
const char * GetArtistShort () const
 Report the localised short form of the artist, the token <name>_ARTIST_SHORT.
const char * GetArtistShortest () const
 Report the localised shortest form of the artist, the token <name>_ARTIST_SHORTEST, or GetArtistShort() when the locale lacks the token.
const char * GetBio () const
 Report the localised biography, the token <name>_BIO.
const char * GetWww () const
 Report the localised web address, the token <name>_WWW.
const char * GetGenre () const
 Report the localised genre, the token <name>_GENRE, with the tempo when the genre is not empty.
const char * GetGenreName () const
 Report the localised genre, the token <name>_GENRE, without the tempo.
const char * GetRemixTitle () const
 Report the localised name of a remix of the song, the token <name>_REMIX_TITLE.
float GetBpm () const
 Report the bpm of the song.
float GetTunnelScale () const
 Report the tunnel_scale of the song.
int GetBars () const
 Report the song_bars of the song.
int GetRemixBars () const
 Report the remix_song_bars of the song.
int GetDuelBars () const
 Report the duel_song_bars of the song, or the remix_song_bars when the entry does not specify it.
const char * GetTitleShort () const
 Report the short title of the song.
const char * GetArenaPath () const
 Report the arena_path of the entry.
bool IsAvailable (int nSkillLevel) const
 Report whether the song is available at a skill level, which its skill sets the lowest of.
bool IsDuel () const
 Report whether a duel can play the song, from its duel.
bool IsRemixable () const
 Report whether a remix can be made of the song, from its not_remix.
bool IsGameable () const
 Report whether a game can play the song, from its not_game.
void SetData (DataArray *pData)

Static Public Member Functions

static DataArray * Find (const std::vector< SongEntry > &songs, const char *pszName)
 Find a song in a list by name.

Detailed Description

View of the entry of one song in the "songs" section of the configuration.

The class is not polymorphic and has no RTTI. The name is inferred. The object is the one pointer to the entry.

Member Enumeration Documentation

◆ Type

Values of GetType().

Enumerator
kTypeNormal 

A song whose entry does not specify a type.

kTypeBoss 

The boss song of an arena.

kTypeBonus 

A bonus song.

kTypeSecret 

A secret song.

kTypeTutorial 

The tutorial.

Constructor & Destructor Documentation

◆ SongEntry() [1/2]

SongEntry::SongEntry ( )
default

◆ SongEntry() [2/2]

SongEntry::SongEntry ( DataArray * pData)
inlineexplicit

Construct the entry of a song.

Parameters
pDataThe entry, or null.

Member Function Documentation

◆ GetType()

int SongEntry::GetType ( ) const

Report the type of the song.

Returns
The type, or 0 when the entry does not specify one.
Ghidra address:
NTSC-U/C: 0x0027d320
Ghidra address:
PAL: 0x00286c38

◆ GetName()

const char * SongEntry::GetName ( ) const

Report the name of the song, the first symbol of the entry.

Returns
The name.
Ghidra address:
NTSC-U/C: 0x0027cee0
Ghidra address:
PAL: 0x002867f8

◆ GetId()

int SongEntry::GetId ( ) const

Report the number of the song, the id of the entry.

Returns
The number.
Ghidra address:
NTSC-U/C: 0x0027ce40
Ghidra address:
PAL: 0x00286758

◆ GetTitle()

const char * SongEntry::GetTitle ( ) const

Report the localised title of the song.

The name is inferred.

Returns
The title.
Ghidra address:
NTSC-U/C: 0x0027cf00
Ghidra address:
PAL: 0x00286818

◆ GetArtist()

const char * SongEntry::GetArtist ( ) const

Report the localised artist, the token <name>_ARTIST.

Returns
The artist.
Ghidra address:
NTSC-U/C: 0x0027d090
Ghidra address:
PAL: 0x002869a8

◆ GetLabel()

const char * SongEntry::GetLabel ( ) const

Report the localised record label, the token <name>_LABEL.

The name is inferred.

Returns
The record label.
Ghidra address:
NTSC-U/C: 0x0027cf48
Ghidra address:
PAL: 0x00286860

◆ GetArtistShort()

const char * SongEntry::GetArtistShort ( ) const

Report the localised short form of the artist, the token <name>_ARTIST_SHORT.

Returns
The short artist.
Ghidra address:
NTSC-U/C: 0x0027d0d8
Ghidra address:
PAL: 0x002869f0

◆ GetArtistShortest()

const char * SongEntry::GetArtistShortest ( ) const

Report the localised shortest form of the artist, the token <name>_ARTIST_SHORTEST, or GetArtistShort() when the locale lacks the token.

Returns
The shortest artist.
Ghidra address:
NTSC-U/C: 0x0027d120
Ghidra address:
PAL: 0x00286a38

◆ GetBio()

const char * SongEntry::GetBio ( ) const

Report the localised biography, the token <name>_BIO.

Returns
The biography.
Ghidra address:
NTSC-U/C: 0x0027d1a0
Ghidra address:
PAL: 0x00286ab8

◆ GetWww()

const char * SongEntry::GetWww ( ) const

Report the localised web address, the token <name>_WWW.

Returns
The web address.
Ghidra address:
NTSC-U/C: 0x0027d1e8
Ghidra address:
PAL: 0x00286b00

◆ GetGenre()

const char * SongEntry::GetGenre ( ) const

Report the localised genre, the token <name>_GENRE, with the tempo when the genre is not empty.

Returns
The genre.
Ghidra address:
NTSC-U/C: 0x0027d230
Ghidra address:
PAL: 0x00286b48

◆ GetGenreName()

const char * SongEntry::GetGenreName ( ) const

Report the localised genre, the token <name>_GENRE, without the tempo.

Returns
The genre.
Ghidra address:
NTSC-U/C: 0x0027d2d8
Ghidra address:
PAL: 0x00286bf0

◆ GetRemixTitle()

const char * SongEntry::GetRemixTitle ( ) const

Report the localised name of a remix of the song, the token <name>_REMIX_TITLE.

Without a translation of the token, the routine reports the result of the routine at 0x0027cf90.

Returns
The name.
Ghidra address:
NTSC-U/C: 0x0027d010
Ghidra address:
PAL: 0x00286928

◆ GetBpm()

float SongEntry::GetBpm ( ) const

Report the bpm of the song.

Returns
The tempo in beats per minute.
Ghidra address:
NTSC-U/C: 0x0027d510
Ghidra address:
PAL: 0x00286e28

◆ GetTunnelScale()

float SongEntry::GetTunnelScale ( ) const

Report the tunnel_scale of the song.

Returns
The scale, or 1 when the entry does not specify one.
Ghidra address:
NTSC-U/C: 0x0027cea0
Ghidra address:
PAL: 0x002867b8

◆ GetBars()

int SongEntry::GetBars ( ) const

Report the song_bars of the song.

Returns
The number of bars.
Ghidra address:
NTSC-U/C: 0x0027d448
Ghidra address:
PAL: 0x00286d60

◆ GetRemixBars()

int SongEntry::GetRemixBars ( ) const

Report the remix_song_bars of the song.

Returns
The number of bars of a remix.
Ghidra address:
NTSC-U/C: 0x0027d478
Ghidra address:
PAL: 0x00286d90

◆ GetDuelBars()

int SongEntry::GetDuelBars ( ) const

Report the duel_song_bars of the song, or the remix_song_bars when the entry does not specify it.

Returns
The number of bars of a duel.
Ghidra address:
NTSC-U/C: 0x0027d4a8
Ghidra address:
PAL: 0x00286dc0

◆ GetTitleShort()

const char * SongEntry::GetTitleShort ( ) const

Report the short title of the song.

The title is the localized <name>_TITLE_SHORT, or the full title when the text table has no short title.

Returns
The title.
Ghidra address:
NTSC-U/C: 0x0027cf90
Ghidra address:
PAL: 0x002868a8

◆ GetArenaPath()

const char * SongEntry::GetArenaPath ( ) const

Report the arena_path of the entry.

The name is inferred.

Returns
The path.
Ghidra address:
NTSC-U/C: 0x0027ce70
Ghidra address:
PAL: 0x00286788

◆ IsAvailable()

bool SongEntry::IsAvailable ( int nSkillLevel) const

Report whether the song is available at a skill level, which its skill sets the lowest of.

The name is inferred.

Parameters
nSkillLevelThe skill level.
Returns
Whether skill is at most nSkillLevel.
Ghidra address:
NTSC-U/C: 0x0027d358
Ghidra address:
PAL: 0x00286c70

◆ IsDuel()

bool SongEntry::IsDuel ( ) const

Report whether a duel can play the song, from its duel.

The name is inferred.

Returns
Whether duel is non-zero.
Ghidra address:
NTSC-U/C: 0x0027d3a0
Ghidra address:
PAL: 0x00286cb8

◆ IsRemixable()

bool SongEntry::IsRemixable ( ) const

Report whether a remix can be made of the song, from its not_remix.

The name is inferred.

Returns
Whether not_remix is zero.
Ghidra address:
NTSC-U/C: 0x0027d3d8
Ghidra address:
PAL: 0x00286cf0

◆ IsGameable()

bool SongEntry::IsGameable ( ) const

Report whether a game can play the song, from its not_game.

The name is inferred.

Returns
Whether not_game is zero.
Ghidra address:
NTSC-U/C: 0x0027d410
Ghidra address:
PAL: 0x00286d28

◆ Find()

DataArray * SongEntry::Find ( const std::vector< SongEntry > & songs,
const char * pszName )
static

Find a song in a list by name.

The name is inferred.

Parameters
songsThe list.
pszNameThe name of the song.
Returns
The entry of the song, or null when the list does not include it.
Ghidra address:
NTSC-U/C: 0x0027d540
Ghidra address:
PAL: 0x00286e58

◆ SetData()

void SongEntry::SetData ( DataArray * pData)
inline
Parameters
pDataThe entry.

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