OpenXcom  1.0
Open-source clone of the original X-Com
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
OpenXcom::TestState Class Reference

A state purely for testing game functionality. More...

#include <TestState.h>

Inheritance diagram for OpenXcom::TestState:
OpenXcom::State

Public Member Functions

 TestState (Game *game)
 Creates the Test state. More...
 
 ~TestState ()
 Cleans up the Test state.
 
void think ()
 Runs state functionality every cycle. More...
 
void blit ()
 Blits the state to the screen. More...
 
- Public Member Functions inherited from OpenXcom::State
 State (Game *game)
 Creates a new state linked to a game. More...
 
virtual ~State ()
 Cleans up the state. More...
 
void add (Surface *surface)
 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 init ()
 Initializes the state. More...
 
virtual void handle (Action *action)
 Handles any events. 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...
 
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 *const 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...
 

Detailed Description

A state purely for testing game functionality.

Fun fact, this was the project's original main(), used for testing and implementing basic engine features until it grew a proper structure and was put aside for actual game states. Useful as a sandbox / testing ground.

Constructor & Destructor Documentation

OpenXcom::TestState::TestState ( Game game)

Creates the Test state.

Initializes all the elements in the test screen.

Parameters
gamePointer to the core game.

Member Function Documentation

void OpenXcom::TestState::blit ( )
virtual

Blits the state to the screen.

Blits all the visible Surface child elements onto the display screen, by order of addition.

Reimplemented from OpenXcom::State.

void OpenXcom::TestState::think ( )
virtual

Runs state functionality every cycle.

Runs any code the state needs to keep updating every game cycle, like timers and other real-time elements.

Reimplemented from OpenXcom::State.


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