OpenXcom  1.0
Open-source clone of the original X-Com
Public Member Functions | List of all members
OpenXcom::LoadGameState Class Reference

Loads a saved game, with an optional message. More...

#include <LoadGameState.h>

Inheritance diagram for OpenXcom::LoadGameState:
OpenXcom::State

Public Member Functions

 LoadGameState (OptionsOrigin origin, const std::string &filename, SDL_Color *palette)
 Creates the Load Game state. More...
 
 LoadGameState (OptionsOrigin origin, SaveType type, SDL_Color *palette)
 Creates the Load Game state. More...
 
 ~LoadGameState ()
 Cleans up the Load Game state.
 
void buildUi (SDL_Color *palette)
 Creates the interface. More...
 
void init ()
 Validates game. More...
 
void think ()
 Loads the game. More...
 
void error (const std::string &msg, SavedGame *save)
 Shows an error message. More...
 
- Public Member Functions inherited from OpenXcom::State
 State ()
 Creates a new state linked to a game. More...
 
virtual ~State ()
 Cleans up the state. More...
 
void setInterface (const std::string &s, bool alterPal=false, SavedBattleGame *battleGame=0)
 Set interface rules. More...
 
void add (Surface *surface)
 Adds a child element to the state. More...
 
void add (Surface *surface, const std::string &id, const std::string &category, Surface *parent=0)
 Adds a child element to the state. More...
 
bool isScreen () const
 Gets whether the state is a full-screen. More...
 
void toggleScreen ()
 Toggles whether the state is a full-screen. More...
 
virtual void handle (Action *action)
 Handles any events. More...
 
virtual void blit ()
 Blits the state to the screen. More...
 
void hideAll ()
 Hides all the state surfaces. More...
 
void showAll ()
 Shws all the state surfaces. More...
 
void resetAll ()
 Resets all the state surfaces. More...
 
const LocalizedTexttr (const std::string &id) const
 Get the localized text. More...
 
LocalizedText tr (const std::string &id, unsigned n) const
 Get the localized text. More...
 
const LocalizedTexttr (const std::string &id, SoldierGender gender) const
 Get the localized text. More...
 
void redrawText ()
 redraw all the text-type surfaces.
 
void centerAllSurfaces ()
 center all surfaces relative to the screen. More...
 
void lowerAllSurfaces ()
 lower all surfaces by half the screen height. More...
 
void applyBattlescapeTheme ()
 switch the colours to use the battlescape palette. More...
 
void setModal (InteractiveSurface *surface)
 Sets a modal surface. More...
 
void setPalette (SDL_Color *colors, int firstcolor=0, int ncolors=256, bool immediately=true)
 Changes a set of colors on the state's 8bpp palette. More...
 
void setPalette (const std::string &palette, int backpals=-1)
 Changes the state's 8bpp palette with certain resources. More...
 
SDL_Color * getPalette ()
 Gets the state's 8bpp palette. More...
 
virtual void resize (int &dX, int &dY)
 Let the state know the window has been resized. More...
 
virtual void recenter (int dX, int dY)
 Re-orients all the surfaces in the state. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from OpenXcom::State
static void setGamePtr (Game *game)
 Sets game object pointer.
 
- Static Protected Attributes inherited from OpenXcom::State
static Game_game = 0
 Initializes static member.
 

Detailed Description

Loads a saved game, with an optional message.

Constructor & Destructor Documentation

◆ LoadGameState() [1/2]

OpenXcom::LoadGameState::LoadGameState ( OptionsOrigin  origin,
const std::string &  filename,
SDL_Color *  palette 
)

Creates the Load Game state.

Initializes all the elements in the Load Game screen.

Parameters
gamePointer to the core game.
originGame section that originated this state.
filenameName of the save file without extension.
paletteParent state palette.

◆ LoadGameState() [2/2]

OpenXcom::LoadGameState::LoadGameState ( OptionsOrigin  origin,
SaveType  type,
SDL_Color *  palette 
)

Creates the Load Game state.

Initializes all the elements in the Load Game screen.

Parameters
gamePointer to the core game.
originGame section that originated this state.
typeType of auto-load being used.
paletteParent state palette.

Member Function Documentation

◆ buildUi()

void OpenXcom::LoadGameState::buildUi ( SDL_Color *  palette)

Creates the interface.

Builds the interface.

Parameters
paletteParent state palette.

◆ error()

void OpenXcom::LoadGameState::error ( const std::string &  msg,
SavedGame save 
)

Shows an error message.

Pops up a window with an error message and cleans up afterwards.

Parameters
msgError message.
savePending save.

◆ init()

void OpenXcom::LoadGameState::init ( )
virtual

Validates game.

Ignore quick loads without a save available.

Reimplemented from OpenXcom::State.

◆ think()

void OpenXcom::LoadGameState::think ( )
virtual

Loads the game.

Loads the specified save.

Reimplemented from OpenXcom::State.


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