OpenXcom::ActionMenuState Class Reference

Window that allows the player to select a battlescape action. More...

#include <ActionMenuState.h>

Inheritance diagram for OpenXcom::ActionMenuState:

Public Member Functions
	ActionMenuState (Game *game, BattleAction *action, int x, int y)
	Creates the Action Menu state. More...
	~ActionMenuState ()
	Cleans up the Action Menu state. More...
void	handle (Action *action)
	Handler for right-clicking anything. More...
void	btnActionMenuItemClick (Action *action)
	Handler for clicking a action menu item. More...
void	resize (int &dX, int &dY)
	Update the resolution settings, we just resized the window. 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	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	recenter (int dX, int dY)
	Re-orients all the surfaces in the state. More...

Detailed Description

Window that allows the player to select a battlescape action.

Constructor & Destructor Documentation

OpenXcom::ActionMenuState::ActionMenuState	(	Game *	game,
		BattleAction *	action,
		int	x,
		int	y
	)

Creates the Action Menu state.

Initializes all the elements in the Action Menu window.

Parameters

game	Pointer to the core game.
action	Pointer to the action.
x	Position on the x-axis.
y	position on the y-axis.

OpenXcom::ActionMenuState::~ActionMenuState

(

)

Cleans up the Action Menu state.

Deletes the ActionMenuState.

Member Function Documentation

void OpenXcom::ActionMenuState::btnActionMenuItemClick

(

Action *

action

)

Handler for clicking a action menu item.

Executes the action corresponding to this action menu item.

Parameters

action

Pointer to an action.

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

virtual

Handler for right-clicking anything.

Closes the window on right-click.

Parameters

action

Pointer to an action.

Reimplemented from OpenXcom::State.

void OpenXcom::ActionMenuState::resize ( int &  dX, int &  dY  )

virtual

Update the resolution settings, we just resized the window.

Updates the scale.

Parameters

dX	delta of X;
dY	delta of Y;

Reimplemented from OpenXcom::State.

---

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

• ActionMenuState.h
• ActionMenuState.cpp