The Battle for Wesnoth  1.15.1+dev
Public Member Functions | Private Member Functions | List of all members
savegame::ingame_savegame Class Reference

Class for "normal" midgame saves. More...

#include <savegame.hpp>

Inheritance diagram for savegame::ingame_savegame:
Inheritance graph

Public Member Functions

 ingame_savegame (saved_game &gamestate, const compression::format compress_saves)
 
- Public Member Functions inherited from savegame::savegame
virtual ~savegame ()
 
bool save_game_automatic (bool ask_for_overwrite=false, const std::string &filename="")
 Saves a game without user interaction, unless the file exists and it should be asked to overwrite it. More...
 
bool save_game_interactive (const std::string &message, DIALOG_TYPE dialog_type)
 Save a game interactively through the savegame dialog. More...
 
const std::string & filename () const
 
std::string create_filename () const
 Build the filename according to the specific savegame's needs. More...
 
std::string create_filename (unsigned int turn_number) const
 Build the filename for the specified turn. More...
 

Private Member Functions

virtual std::string create_initial_filename (unsigned int turn_number) const override
 Create a filename for automatic saves. More...
 
void write_game (config_writer &out) override
 Writing the savegame config to a file. More...
 

Additional Inherited Members

- Public Types inherited from savegame::savegame
enum  DIALOG_TYPE { YES_NO, OK_CANCEL }
 
- Protected Member Functions inherited from savegame::savegame
 savegame (saved_game &gamestate, const compression::format compress_saves, const std::string &title="Save")
 The only constructor of savegame. More...
 
bool save_game (const std::string &filename="")
 Save a game without any further user interaction. More...
 
bool check_filename (const std::string &filename)
 Check, if the filename contains illegal constructs like ".gz". More...
 
void set_error_message (const std::string &error_message)
 Customize the standard error message. More...
 
const std::string & title () const
 
const saved_gamegamestate () const
 
void before_save ()
 If there needs to be some data fiddling before saving the game, this is the place to go. More...
 
- Protected Attributes inherited from savegame::savegame
std::string filename_
 Filename of the savegame file on disk. More...
 
std::string title_
 Title of the savegame dialog. More...
 

Detailed Description

Class for "normal" midgame saves.

The additional members are needed for creating the snapshot information.

Definition at line 239 of file savegame.hpp.

Constructor & Destructor Documentation

◆ ingame_savegame()

savegame::ingame_savegame::ingame_savegame ( saved_game gamestate,
const compression::format  compress_saves 
)

Definition at line 611 of file savegame.cpp.

Member Function Documentation

◆ create_initial_filename()

std::string savegame::ingame_savegame::create_initial_filename ( unsigned int  turn_number) const
overrideprivatevirtual

Create a filename for automatic saves.

Implements savegame::savegame.

Reimplemented in savegame::autosave_savegame.

Definition at line 616 of file savegame.cpp.

References _(), saved_game::classification(), savegame::savegame::gamestate(), and game_classification::label.

◆ write_game()

void savegame::ingame_savegame::write_game ( config_writer out)
overrideprivatevirtual

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