OpenXcom::MiniMapState Class Reference

The MiniMap is a representation of a Battlescape map that allows you to see more of the map. More...

#include <MiniMapState.h>

Inheritance diagram for OpenXcom::MiniMapState:

Public Member Functions
	MiniMapState (Game *game, Camera *camera, SavedBattleGame *battleGame)
	Creates the MiniMapState. More...
	~MiniMapState ()
	Cleans up the MiniMapState.
void	btnOkClick (Action *action)
	Handler for the OK button. More...
void	btnLevelUpClick (Action *action)
	Handler for the one level up button. More...
void	btnLevelDownClick (Action *action)
	Handler for the one level down button. More...
void	handle (Action *action)
	Handler for right-clicking anything. More...
void	think ()
	Handles timers.
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	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...
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

The MiniMap is a representation of a Battlescape map that allows you to see more of the map.

Constructor & Destructor Documentation

OpenXcom::MiniMapState::MiniMapState	(	Game *	game,
		Camera *	camera,
		SavedBattleGame *	battleGame
	)

Creates the MiniMapState.

Initializes all the elements in the MiniMapState screen.

Parameters

game	Pointer to the core game.
camera	The Battlescape camera.
battleGame	The Battlescape save.

Member Function Documentation

void OpenXcom::MiniMapState::btnLevelDownClick

(

Action *

action

)

Handler for the one level down button.

Changes the currently displayed minimap level.

Parameters

action

Pointer to an action.

void OpenXcom::MiniMapState::btnLevelUpClick

(

Action *

action

)

Handler for the one level up button.

Changes the currently displayed minimap level.

Parameters

action

Pointer to an action.

void OpenXcom::MiniMapState::btnOkClick

(

Action *

action

)

Handler for the OK button.

Returns to the previous screen.

Parameters

action

Pointer to an action.

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

virtual

Handler for right-clicking anything.

Handles mouse-wheeling.

Parameters

action

Pointer to an action.

Reimplemented from OpenXcom::State.

---

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

• MiniMapState.h
• MiniMapState.cpp