Base for all base media (graphics, sounds)
More...
#include <base_media_base.h>
|
static const char * | ini_set |
| The set as saved in the config file. More...
|
|
|
bool | AddFile (const char *filename, size_t basepath_length, const char *tar_filename) |
| Add a file with the given filename. More...
|
|
|
static const char * | GetExtension () |
| Get the extension that is used to identify this set. More...
|
|
|
static Tbase_set * | available_sets |
| All available sets.
|
|
static Tbase_set * | duplicate_sets |
| All sets that aren't available, but needed for not downloading base sets when a newer version than the one on BaNaNaS is loaded.
|
|
static const Tbase_set * | used_set |
| The currently used set.
|
|
|
virtual | ~FileScanner () |
| Destruct the proper one... More...
|
|
uint | Scan (const char *extension, Subdirectory sd, bool tars=true, bool recursive=true) |
| Scan for files with the given extension in the given search path. More...
|
|
uint | Scan (const char *extension, const char *directory, bool recursive=true) |
| Scan for files with the given extension in the given search path. More...
|
|
Subdirectory | subdir |
| The current sub directory we are searching through.
|
|
template<class Tbase_set>
class BaseMedia< Tbase_set >
Base for all base media (graphics, sounds)
- Template Parameters
-
Tbase_set | the real set we're going to be |
Definition at line 171 of file base_media_base.h.
◆ AddFile()
template<class Tbase_set >
bool BaseMedia< Tbase_set >::AddFile |
( |
const char * |
filename, |
|
|
size_t |
basepath_length, |
|
|
const char * |
tar_filename |
|
) |
| |
|
protectedvirtual |
Add a file with the given filename.
- Parameters
-
filename | the full path to the file to read |
basepath_length | amount of characters to chop of before to get a filename relative to the search path. |
tar_filename | the name of the tar file the file is read from. |
- Returns
- true if the file is added.
Implements FileScanner.
Definition at line 158 of file base_media_func.h.
◆ DetermineBestSet()
template<class Tbase_set >
bool BaseMedia< Tbase_set >::DetermineBestSet |
( |
| ) |
|
|
static |
Determine the graphics pack that has to be used.
The one with the most correct files wins.
- Returns
- true if a best set has been found.
Definition at line 432 of file gfxinit.cpp.
◆ FindSets()
template<class Tbase_set>
static uint BaseMedia< Tbase_set >::FindSets |
( |
| ) |
|
|
inlinestatic |
◆ GetAvailableSets()
template<class Tbase_set >
Tbase_set * BaseMedia< Tbase_set >::GetAvailableSets |
( |
| ) |
|
|
static |
Return the available sets.
- Returns
- The available sets.
Definition at line 390 of file base_media_func.h.
◆ GetExtension()
template<class Tbase_set >
const char * BaseMedia< Tbase_set >::GetExtension |
( |
| ) |
|
|
staticprotected |
Get the extension that is used to identify this set.
- Returns
- the extension
Definition at line 456 of file gfxinit.cpp.
◆ GetIndexOfUsedSet()
template<class Tbase_set >
int BaseMedia< Tbase_set >::GetIndexOfUsedSet |
( |
| ) |
|
|
static |
Get the index of the currently active graphics set.
- Returns
- the current set's index
Definition at line 349 of file base_media_func.h.
◆ GetNumSets()
template<class Tbase_set >
Count the number of available graphics sets.
- Returns
- the number of sets
Definition at line 334 of file base_media_func.h.
◆ GetSet()
template<class Tbase_set >
const Tbase_set * BaseMedia< Tbase_set >::GetSet |
( |
int |
index | ) |
|
|
static |
Get the name of the graphics set at the specified index.
- Returns
- the name of the set
Definition at line 365 of file base_media_func.h.
◆ GetSetsList()
template<class Tbase_set >
char * BaseMedia< Tbase_set >::GetSetsList |
( |
char * |
p, |
|
|
const char * |
last |
|
) |
| |
|
static |
Returns a list with the sets.
- Parameters
-
p | where to print to |
last | the last character to print to |
- Returns
- the last printed character
Definition at line 261 of file base_media_func.h.
◆ GetUsedSet()
template<class Tbase_set >
const Tbase_set * BaseMedia< Tbase_set >::GetUsedSet |
( |
| ) |
|
|
static |
◆ HasSet()
template<class Tbase_set >
Check whether we have an set with the exact characteristics as ci.
- Parameters
-
ci | the characteristics to search on (shortname and md5sum) |
md5sum | whether to check the MD5 checksum |
- Returns
- true iff we have an set matching.
Definition at line 307 of file base_media_func.h.
Referenced by BaseMedia< GraphicsSet >::HasSet().
◆ SetSet()
template<class Tbase_set >
bool BaseMedia< Tbase_set >::SetSet |
( |
const char * |
name | ) |
|
|
static |
Set the set to be used.
- Parameters
-
- Returns
- true if it could be loaded
Definition at line 234 of file base_media_func.h.
◆ ini_set
template<class Tbase_set>
The documentation for this class was generated from the following files: