OpenXcom::ManageAlienContainmentState Class Reference

ManageAlienContainment screen that lets the player manage alien numbers in a particular base. More...

#include <ManageAlienContainmentState.h>

Inheritance diagram for OpenXcom::ManageAlienContainmentState:

Public Member Functions
	ManageAlienContainmentState (Game *game, Base *base, OptionsOrigin origin)
	Creates the ManageAlienContainment state. More...
	~ManageAlienContainmentState ()
	Cleans up the ManageAlienContainment state.
void	think ()
	Runs the timers. More...
void	btnOkClick (Action *action)
	Handler for clicking the OK button. More...
void	btnCancelClick (Action *action)
	Handler for clicking the Cancel button. More...
void	lstItemsLeftArrowPress (Action *action)
	Handler for pressing an Increase arrow in the list. More...
void	lstItemsLeftArrowRelease (Action *action)
	Handler for releasing an Increase arrow in the list. More...
void	lstItemsLeftArrowClick (Action *action)
	Handler for clicking an Increase arrow in the list. More...
void	lstItemsRightArrowPress (Action *action)
	Handler for pressing a Decrease arrow in the list. More...
void	lstItemsRightArrowRelease (Action *action)
	Handler for releasing a Decrease arrow in the list. More...
void	lstItemsRightArrowClick (Action *action)
	Handler for clicking a Decrease arrow in the list. More...
void	lstItemsMousePress (Action *action)
	Handler for pressing-down a mouse-button in the list. More...
void	increase ()
	Increases the quantity of an alien by one. More...
void	increaseByValue (int change)
	Increases the quantity of an alien by the given value. More...
void	decrease ()
	Decreases the quantity of an alien by one. More...
void	decreaseByValue (int change)
	Decreases the quantity of an alien by the given value. More...
void	updateStrings ()
	Updates the quantity-strings of the selected alien.
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...
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

ManageAlienContainment screen that lets the player manage alien numbers in a particular base.

Constructor & Destructor Documentation

OpenXcom::ManageAlienContainmentState::ManageAlienContainmentState	(	Game *	game,
		Base *	base,
		OptionsOrigin	origin
	)

Creates the ManageAlienContainment state.

Initializes all the elements in the Manage Alien Containment screen.

Parameters

game	Pointer to the core game.
base	Pointer to the base to get info from.
origin	Game section that originated this state.

Member Function Documentation

void OpenXcom::ManageAlienContainmentState::btnCancelClick

(

Action *

action

)

Handler for clicking the Cancel button.

Returns to the previous screen.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::btnOkClick

(

Action *

action

)

Handler for clicking the OK button.

Deals with the selected aliens.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::decrease

(

)

Decreases the quantity of an alien by one.

Decreases the quantity of the selected alien to exterminate by one.

void OpenXcom::ManageAlienContainmentState::decreaseByValue

(

int

change

)

Decreases the quantity of an alien by the given value.

Decreases the quantity of the selected alien to exterminate by "change".

Parameters

change

How much we want to remove.

void OpenXcom::ManageAlienContainmentState::increase

(

)

Increases the quantity of an alien by one.

Increases the quantity of the selected alien to exterminate by one.

void OpenXcom::ManageAlienContainmentState::increaseByValue

(

int

change

)

Increases the quantity of an alien by the given value.

Increases the quantity of the selected alien to exterminate by "change".

Parameters

change

How much we want to add.

void OpenXcom::ManageAlienContainmentState::lstItemsLeftArrowClick

(

Action *

action

)

Handler for clicking an Increase arrow in the list.

Decreases the selected alien count; by one on left-click, to 0 on right-click.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::lstItemsLeftArrowPress

(

Action *

action

)

Handler for pressing an Increase arrow in the list.

Starts decreasing the alien count.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::lstItemsLeftArrowRelease

(

Action *

action

)

Handler for releasing an Increase arrow in the list.

Stops decreasing the alien count.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::lstItemsMousePress

(

Action *

action

)

Handler for pressing-down a mouse-button in the list.

Handles the mouse-wheels on the arrow-buttons.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::lstItemsRightArrowClick

(

Action *

action

)

Handler for clicking a Decrease arrow in the list.

Increases the selected alien count; by one on left-click, to max on right-click.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::lstItemsRightArrowPress

(

Action *

action

)

Handler for pressing a Decrease arrow in the list.

Starts increasing the alien count.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::lstItemsRightArrowRelease

(

Action *

action

)

Handler for releasing a Decrease arrow in the list.

Stops increasing the alien count.

Parameters

action

Pointer to an action.

void OpenXcom::ManageAlienContainmentState::think ( )

virtual

Runs the timers.

Runs the arrow timers.

Reimplemented from OpenXcom::State.

---

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

• ManageAlienContainmentState.h
• ManageAlienContainmentState.cpp