OpenXcom::UnitInfoState Class Reference

Unit Info screen that shows all the info of a specific unit. More...

#include <UnitInfoState.h>

Inheritance diagram for OpenXcom::UnitInfoState:

Public Member Functions
	UnitInfoState (Game *game, BattleUnit *unit, BattlescapeState *parent, bool fromInventory, bool mindProbe)
	Creates the Unit Info state. More...
	~UnitInfoState ()
	Cleans up the Unit Info state.
void	init ()
	Updates the unit info. More...
void	handle (Action *action)
	Handler for clicking the button. More...
void	btnPrevClick (Action *action)
	Handler for clicking the Previous button. More...
void	btnNextClick (Action *action)
	Handler for clicking the Next button. More...
void	exitClick (Action *action)
	Handler for exiting the state. 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	think ()
	Runs state functionality every cycle. 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

Unit Info screen that shows all the info of a specific unit.

Constructor & Destructor Documentation

OpenXcom::UnitInfoState::UnitInfoState	(	Game *	game,
		BattleUnit *	unit,
		BattlescapeState *	parent,
		bool	fromInventory,
		bool	mindProbe
	)

Creates the Unit Info state.

Initializes all the elements in the Unit Info screen.

Parameters

game	Pointer to the core game.
unit	Pointer to the selected unit.
parent	Pointer to parent Battlescape.
fromInventory	Is player coming from the inventory?
mindProbe	Is player using a Mind Probe?

Member Function Documentation

void OpenXcom::UnitInfoState::btnNextClick

(

Action *

action

)

Handler for clicking the Next button.

Selects the next unit.

Parameters

action

Pointer to an action.

void OpenXcom::UnitInfoState::btnPrevClick

(

Action *

action

)

Handler for clicking the Previous button.

Selects the previous unit.

Parameters

action

Pointer to an action.

void OpenXcom::UnitInfoState::exitClick

(

Action *

action

)

Handler for exiting the state.

Exits the screen.

Parameters

action

Pointer to an action.

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

virtual

Handler for clicking the button.

Closes the window on right-click.

Parameters

action

Pointer to an action.

Reimplemented from OpenXcom::State.

void OpenXcom::UnitInfoState::init ( )

virtual

Updates the unit info.

Updates unit info which can change after going into other screens.

Reimplemented from OpenXcom::State.

---

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

• UnitInfoState.h
• UnitInfoState.cpp