OpenXcom  1.0
Open-source clone of the original X-Com
Public Member Functions | List of all members
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:
OpenXcom::State

Public Member Functions

 MiniMapState (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 ()
 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 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 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

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

Constructor & Destructor Documentation

◆ MiniMapState()

OpenXcom::MiniMapState::MiniMapState ( Camera camera,
SavedBattleGame battleGame 
)

Creates the MiniMapState.

Initializes all the elements in the MiniMapState screen.

Parameters
gamePointer to the core game.
cameraThe Battlescape camera.
battleGameThe Battlescape save.

Member Function Documentation

◆ btnLevelDownClick()

void OpenXcom::MiniMapState::btnLevelDownClick ( Action action)

Handler for the one level down button.

Changes the currently displayed minimap level.

Parameters
actionPointer to an action.

◆ btnLevelUpClick()

void OpenXcom::MiniMapState::btnLevelUpClick ( Action action)

Handler for the one level up button.

Changes the currently displayed minimap level.

Parameters
actionPointer to an action.

◆ btnOkClick()

void OpenXcom::MiniMapState::btnOkClick ( Action action)

Handler for the OK button.

Returns to the previous screen.

Parameters
actionPointer to an action.

◆ handle()

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

Handler for right-clicking anything.

Handles mouse-wheeling.

Parameters
actionPointer to an action.

Reimplemented from OpenXcom::State.


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