PRooFPS-dd Dev Doc 1.0
PRooFPS-dd Developer Documentation
Loading...
Searching...
No Matches
List of all members | Public Member Functions | Friends
TestableMapcycle Class Reference

Detailed Description

Definition at line 20 of file MapcycleTest.h.

#include <MapcycleTest.h>

+ Inheritance diagram for TestableMapcycle:

Public Member Functions

 TestableMapcycle ()
 
virtual ~TestableMapcycle ()
 
- Public Member Functions inherited from proofps_dd::Mapcycle
CConsole & getConsole () const
 
 Mapcycle ()
 
 ~Mapcycle ()
 
 Mapcycle (const Mapcycle &)=delete
 
Mapcycle & operator= (const Mapcycle &)=delete
 
 Mapcycle (Mapcycle &&)=delete
 
Mapcycle && operator= (Mapcycle &&)=delete
 
bool initialize ()
 Updates list of available maps and mapcycle content.
 
bool isInitialized () const
 
void shutdown ()
 Releases any allocated resources related to available maps list and mapcycle.
 
const std::set< std::string > & availableMapsGet () const
 
const std::string & availableMapsGetElem (const size_t &index) const
 
const char ** availableMapsGetAsCharPtrArray () const
 This is convenience function to be used with GUI: Dear ImGUI requires this kind of array as source of items of Listbox.
 
const std::set< std::string > & availableMapsNoChangingGet () const
 
const std::string & availableMapsNoChangingGetElem (const size_t &index) const
 
const std::vector< std::string > & mapcycleGet () const
 
const char ** mapcycleGetAsCharPtrArray () const
 This is convenience function to be used with GUI: Dear ImGUI requires this kind of array as source of items of Listbox.
 
std::string mapcycleGetCurrent () const
 
bool mapcycleIsCurrentLast () const
 
std::string mapcycleNext ()
 
std::string mapcycleRewindToFirst ()
 
std::string mapcycleForwardToLast ()
 
bool mapcycleSaveToFile ()
 
void mapcycle_availableMaps_Synchronize ()
 This one is recommended during initialization, since it reloads both the mapcycle and available maps list, and makes sure they become disjoint sets.
 
bool mapcycleAdd_availableMapsRemove (const std::string &sMapFilename)
 
bool mapcycleAdd_availableMapsRemove (const std::vector< std::string > &vMapFilenames)
 
bool mapcycleAdd_availableMapsRemove ()
 
bool mapcycleRemove_availableMapsAdd (const std::string &sMapFilename)
 
bool mapcycleRemove_availableMapsAdd (const size_t &indexToMapcycle)
 
bool mapcycleRemove_availableMapsAdd (const std::vector< std::string > &vMapFilenames)
 
bool mapcycleRemove_availableMapsAdd ()
 

Friends

class MapcycleTest
 

Additional Inherited Members

- Static Public Member Functions inherited from proofps_dd::Mapcycle
static const char * getLoggerModuleName ()
 
static bool isValidMapFilename (const std::string &sFilename)
 
- Static Public Attributes inherited from proofps_dd::Mapcycle
static constexpr char * GAME_MAPS_DIR = "gamedata/maps/"
 
- Protected Member Functions inherited from proofps_dd::Mapcycle
void availableMapsRefresh ()
 
bool availableMapsAdd (const std::string &sMapFilename)
 
bool availableMapsAdd (const std::vector< std::string > &vMapFilenames)
 
bool availableMapsRemove (const std::string &sMapFilename)
 
bool availableMapsRemove (const size_t &index)
 
bool availableMapsRemove (const std::vector< std::string > &vMapFilenames)
 
bool mapcycleReload ()
 
bool mapcycleAdd (const std::string &sMapFilename)
 
bool mapcycleAdd (const std::vector< std::string > &vMapFilenames)
 
bool mapcycleAdd (const std::set< std::string > &vMapFilenames)
 
bool mapcycleRemove (const std::string &sMapFilename)
 
bool mapcycleRemove (const size_t &index)
 
bool mapcycleRemove (const std::vector< std::string > &vMapFilenames)
 
void mapcycleClear ()
 
size_t mapcycleRemoveNonExisting ()
 Removes items from mapcycle that are referring to non-existing files in the current filesystem.
 

Constructor & Destructor Documentation

◆ TestableMapcycle()

TestableMapcycle::TestableMapcycle ( )
inline

Definition at line 24 of file MapcycleTest.h.

◆ ~TestableMapcycle()

virtual TestableMapcycle::~TestableMapcycle ( )
inlinevirtual

Definition at line 27 of file MapcycleTest.h.

Friends And Related Symbol Documentation

◆ MapcycleTest

friend class MapcycleTest
friend

Definition at line 29 of file MapcycleTest.h.

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