OpenTTD
Public Member Functions | Data Fields
MusicSet Struct Reference

All data of a music set. More...

#include <base_media_base.h>

Inheritance diagram for MusicSet:
BaseSet< MusicSet, NUM_SONGS_AVAILABLE, false >

Public Member Functions

bool FillSetDetails (struct IniFile *ini, const char *path, const char *full_filename)
- Public Member Functions inherited from BaseSet< MusicSet, NUM_SONGS_AVAILABLE, false >
 ~BaseSet ()
 Free everything we allocated.
int GetNumMissing () const
 Get the number of missing files.
int GetNumInvalid () const
 Get the number of invalid files.
bool FillSetDetails (IniFile *ini, const char *path, const char *full_filename, bool allow_empty_filename=true)
const char * GetDescription (const char *isocode=NULL) const
 Get the description for the given ISO code.
const char * GetTextfile (TextfileType type) const
 Search a textfile file next to this base media.

Data Fields

char song_name [NUM_SONGS_AVAILABLE][32]
 The name of the different songs.
byte track_nr [NUM_SONGS_AVAILABLE]
byte num_available
- Data Fields inherited from BaseSet< MusicSet, NUM_SONGS_AVAILABLE, false >
const char * name
 The name of the base set.
TranslatedStrings description
 Description of the base set.
uint32 shortname
 Four letter short variant of the name.
uint32 version
 The version of this base set.
bool fallback
 This set is a fallback set, i.e. it should be used only as last resort.
MD5File files [NUM_FILES]
 All files part of this set.
uint found_files
 Number of the files that could be found.
uint valid_files
 Number of the files that could be found and are valid.
MusicSetnext
 The next base set in this list.

Additional Inherited Members

- Public Types inherited from BaseSet< MusicSet, NUM_SONGS_AVAILABLE, false >
typedef SmallMap< const char
*, const char * > 
TranslatedStrings
- Static Public Member Functions inherited from BaseSet< MusicSet, NUM_SONGS_AVAILABLE, false >
static MD5File::ChecksumResult CheckMD5 (const MD5File *file, Subdirectory subdir)
 Calculate and check the MD5 hash of the supplied file.
- Static Public Attributes inherited from BaseSet< MusicSet, NUM_SONGS_AVAILABLE, false >
static const size_t NUM_FILES
 Number of files in this set.
static const bool SEARCH_IN_TARS
 Whether to search in the tars or not.
static const char *const * file_names
 Internal names of the files in this set.

Detailed Description

All data of a music set.

Definition at line 284 of file base_media_base.h.

Field Documentation

char MusicSet::song_name[NUM_SONGS_AVAILABLE][32]

The name of the different songs.

Definition at line 286 of file base_media_base.h.

Referenced by GetSongName().


The documentation for this struct was generated from the following files: