OpenXcom::StartState Class Reference

Initializes the game and loads all required content. More...

#include <StartState.h>

Inheritance diagram for OpenXcom::StartState:

Public Member Functions
	StartState ()
	Creates the Start state. More...
	~StartState ()
	Cleans up the Start state. More...
void	init ()
	Reset everything. More...
void	think ()
	Displays messages. More...
void	handle (Action *action)
	Handles key clicks. More...
void	animate ()
	Animates the terminal. More...
void	addLine (const std::string &str)
	Adds a line of text. 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	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 LocalizedText &	tr (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 LocalizedText &	tr (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...

Static Public Member Functions
static int	load (void *game_ptr)
	Loads the game resources. More...
Static Public Member Functions inherited from OpenXcom::State
static void	setGamePtr (Game *game)
	Sets game object pointer.

Additional Inherited Members
Static Protected Attributes inherited from OpenXcom::State
static Game *	_game = 0
	Initializes static member.

Detailed Description

Initializes the game and loads all required content.

Constructor & Destructor Documentation

StartState()

OpenXcom::StartState::StartState

(

)

Creates the Start state.

Initializes all the elements in the Loading screen.

Parameters

game	Pointer to the core game.

~StartState()

OpenXcom::StartState::~StartState

(

)

Cleans up the Start state.

Kill the thread in case the game is quit early.

Member Function Documentation

addLine()

void OpenXcom::StartState::addLine

(

const std::string &

str

)

Adds a line of text.

Adds a line of text to the terminal and moves the cursor appropriately.

Parameters

str	Text line to add.

animate()

void OpenXcom::StartState::animate

(

)

Animates the terminal.

Blinks the cursor and spreads out terminal output.

handle()

void OpenXcom::StartState::handle ( Action *  action )

virtual

Handles key clicks.

The game quits if the player presses any key when an error message is on display.

Parameters

action

Pointer to an action.

Reimplemented from OpenXcom::State.

init()

void OpenXcom::StartState::init ( )

virtual

Reset everything.

Reset and reload data.

Reimplemented from OpenXcom::State.

load()

int OpenXcom::StartState::load ( void *  game_ptr )

static

Loads the game resources.

Loads game data and updates status accordingly.

Parameters

game_ptr

Pointer to the game.

Returns

Thread status, 0 = ok

think()

void OpenXcom::StartState::think ( )

virtual

Displays messages.

If the loading fails, it shows an error, otherwise moves on to the game.

Reimplemented from OpenXcom::State.

---

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

• StartState.h
• StartState.cpp