|
wavelength 1.0.0
|
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. | |
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.
| enum SongEntry::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. |
|
default |
|
inlineexplicit |
Construct the entry of a song.
| pData | The entry, or null. |
| int SongEntry::GetType | ( | ) | const |
Report the type of the song.
| const char * SongEntry::GetName | ( | ) | const |
Report the name of the song, the first symbol of the entry.
| int SongEntry::GetId | ( | ) | const |
Report the number of the song, the id of the entry.
| const char * SongEntry::GetTitle | ( | ) | const |
Report the localised title of the song.
The name is inferred.
| const char * SongEntry::GetArtist | ( | ) | const |
Report the localised artist, the token <name>_ARTIST.
| const char * SongEntry::GetLabel | ( | ) | const |
Report the localised record label, the token <name>_LABEL.
The name is inferred.
| const char * SongEntry::GetArtistShort | ( | ) | const |
Report the localised short form of the artist, the token <name>_ARTIST_SHORT.
| 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.
| const char * SongEntry::GetBio | ( | ) | const |
Report the localised biography, the token <name>_BIO.
| const char * SongEntry::GetWww | ( | ) | const |
Report the localised web address, the token <name>_WWW.
| const char * SongEntry::GetGenre | ( | ) | const |
Report the localised genre, the token <name>_GENRE, with the tempo when the genre is not empty.
| const char * SongEntry::GetGenreName | ( | ) | const |
Report the localised genre, the token <name>_GENRE, without the tempo.
| 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.
| float SongEntry::GetBpm | ( | ) | const |
Report the bpm of the song.
| float SongEntry::GetTunnelScale | ( | ) | const |
Report the tunnel_scale of the song.
| int SongEntry::GetBars | ( | ) | const |
Report the song_bars of the song.
| int SongEntry::GetRemixBars | ( | ) | const |
Report the remix_song_bars of the song.
| int SongEntry::GetDuelBars | ( | ) | const |
Report the duel_song_bars of the song, or the remix_song_bars when the entry does not specify it.
| 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.
| const char * SongEntry::GetArenaPath | ( | ) | const |
Report the arena_path of the entry.
The name is inferred.
| 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.
| nSkillLevel | The skill level. |
| bool SongEntry::IsDuel | ( | ) | const |
Report whether a duel can play the song, from its duel.
The name is inferred.
| bool SongEntry::IsRemixable | ( | ) | const |
Report whether a remix can be made of the song, from its not_remix.
The name is inferred.
| bool SongEntry::IsGameable | ( | ) | const |
Report whether a game can play the song, from its not_game.
The name is inferred.
Find a song in a list by name.
The name is inferred.
| songs | The list. |
| pszName | The name of the song. |
|
inline |
| pData | The entry. |