OpenXcom::CraftSoldiersState Class Reference

Select Squad screen that lets the player pick the soldiers to assign to a craft. More...

#include <CraftSoldiersState.h>

Inheritance diagram for OpenXcom::CraftSoldiersState:

Public Member Functions
	CraftSoldiersState (Game *game, Base *base, size_t craft)
	Creates the Craft Soldiers state. More...
	~CraftSoldiersState ()
	Cleans up the Craft Soldiers state.
void	btnOkClick (Action *action)
	Handler for clicking the OK button. More...
void	init ()
	Updates the soldiers list. More...
void	lstItemsLeftArrowClick (Action *action)
	Handler for clicking the Soldiers reordering button. More...
void	moveSoldierUp (Action *action, int row, bool max=false)
	Moves a soldier up. More...
void	lstItemsRightArrowClick (Action *action)
	Handler for clicking the Soldiers reordering button. More...
void	moveSoldierDown (Action *action, int row, bool max=false)
	Moves a soldier down. More...
void	lstSoldiersClick (Action *action)
	Handler for clicking the Soldiers list. More...
void	lstSoldiersMousePress (Action *action)
	Handler for pressing-down a mouse-button in the list. 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	handle (Action *action)
	Handles any events. 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

Select Squad screen that lets the player pick the soldiers to assign to a craft.

Constructor & Destructor Documentation

OpenXcom::CraftSoldiersState::CraftSoldiersState	(	Game *	game,
		Base *	base,
		size_t	craft
	)

Creates the Craft Soldiers state.

Initializes all the elements in the Craft Soldiers screen.

Parameters

game	Pointer to the core game.
base	Pointer to the base to get info from.
craft	ID of the selected craft.

Member Function Documentation

void OpenXcom::CraftSoldiersState::btnOkClick

(

Action *

action

)

Handler for clicking the OK button.

Returns to the previous screen.

Parameters

action

Pointer to an action.

void OpenXcom::CraftSoldiersState::init ( )

virtual

Updates the soldiers list.

Shows the soldiers in a list.

Reimplemented from OpenXcom::State.

void OpenXcom::CraftSoldiersState::lstItemsLeftArrowClick

(

Action *

action

)

Handler for clicking the Soldiers reordering button.

Reorders a soldier up.

Parameters

action

Pointer to an action.

void OpenXcom::CraftSoldiersState::lstItemsRightArrowClick

(

Action *

action

)

Handler for clicking the Soldiers reordering button.

Reorders a soldier down.

Parameters

action

Pointer to an action.

void OpenXcom::CraftSoldiersState::lstSoldiersClick

(

Action *

action

)

Handler for clicking the Soldiers list.

Shows the selected soldier's info.

Parameters

action

Pointer to an action.

void OpenXcom::CraftSoldiersState::lstSoldiersMousePress

(

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::CraftSoldiersState::moveSoldierDown	(	Action *	action,
		int	row,
		bool	max = false
	)

Moves a soldier down.

Moves a soldier down on the list.

Parameters

action	Pointer to an action.
row	Selected soldier row.
max	Move the soldier to the bottom?

void OpenXcom::CraftSoldiersState::moveSoldierUp	(	Action *	action,
		int	row,
		bool	max = false
	)

Moves a soldier up.

Moves a soldier up on the list.

Parameters

action	Pointer to an action.
row	Selected soldier row.
max	Move the soldier to the top?

---

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

• CraftSoldiersState.h
• CraftSoldiersState.cpp