Screen that lets the user configure various Battlescape options. More...

#include <OptionsBattlescapeState.h>

Inheritance diagram for OpenXcom::OptionsBattlescapeState:

Public Member Functions
	OptionsBattlescapeState (OptionsOrigin origin)
	Creates the Battlescape Options state. More...

	~OptionsBattlescapeState ()
	Cleans up the Battlescape Options state.

void	cbxEdgeScrollChange (Action *action)
	Handler for changing the Edge Scroll combobox. More...

void	cbxDragScrollChange (Action *action)
	Handler for changing the Drag Scroll combobox. More...

void	slrScrollSpeedChange (Action *action)
	Handler for changing the scroll speed slider. More...

void	slrFireSpeedChange (Action *action)
	Handler for changing the fire speed slider. More...

void	slrXcomSpeedChange (Action *action)
	Handler for changing the X-COM movement speed slider. More...

void	slrAlienSpeedChange (Action *action)
	Handler for changing the alien movement speed slider. More...

void	btnPathPreviewClick (Action *action)
	Handler for clicking a Path Preview button. More...

void	btnTooltipsClick (Action *action)
	Handler for clicking the Tooltips button. More...

void	btnDeathsClick (Action *action)
	Handler for clicking the Death Notifications button. More...

Public Member Functions inherited from OpenXcom::OptionsBaseState
	OptionsBaseState (OptionsOrigin origin)
	Creates the Options state. More...

	~OptionsBaseState ()
	Cleans up the Options state.

void	init ()
	Initializes palettes. More...

void	setCategory (TextButton *button)
	Presses a certain category button. More...

void	btnOkClick (Action *action)
	Handler for clicking the OK button. More...

void	btnCancelClick (Action *action)
	Handler for clicking the Cancel button. More...

void	btnDefaultClick (Action *action)
	Handler for clicking the Restore Defaults button. More...

void	btnGroupPress (Action *action)
	Handler for clicking one of the grouping buttons.

void	txtTooltipIn (Action *action)
	Handler for showing tooltip. More...

void	txtTooltipOut (Action *action)
	Handler for hiding tooltip. 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 ()
	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	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...

const LocalizedText &	tr (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	recenter (int dX, int dY)
	Re-orients all the surfaces in the state. More...

Additional Inherited Members
Static Public Member Functions inherited from OpenXcom::OptionsBaseState
static void	restart (OptionsOrigin origin)
	Restarts the game states.

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

Screen that lets the user configure various Battlescape options.

Constructor & Destructor Documentation

◆ OptionsBattlescapeState()

OpenXcom::OptionsBattlescapeState::OptionsBattlescapeState ( OptionsOrigin origin )

Creates the Battlescape Options state.

Initializes all the elements in the Battlescape Options screen.

Parameters

game	Pointer to the core game.
origin	Game section that originated this state.

Member Function Documentation

◆ btnDeathsClick()

void OpenXcom::OptionsBattlescapeState::btnDeathsClick ( Action * action )

Handler for clicking the Death Notifications button.

Updates the Death Notifications option.

Parameters

action Pointer to an action.

◆ btnPathPreviewClick()

void OpenXcom::OptionsBattlescapeState::btnPathPreviewClick ( Action * action )

Handler for clicking a Path Preview button.

Updates the path preview options.

Parameters

action Pointer to an action.

◆ btnTooltipsClick()

void OpenXcom::OptionsBattlescapeState::btnTooltipsClick ( Action * action )

Handler for clicking the Tooltips button.

Updates the Tooltips option.

Parameters

action Pointer to an action.

◆ cbxDragScrollChange()

void OpenXcom::OptionsBattlescapeState::cbxDragScrollChange ( Action * action )

Handler for changing the Drag Scroll combobox.

Changes the Drag Scroll option.

Parameters

action Pointer to an action.

◆ cbxEdgeScrollChange()

void OpenXcom::OptionsBattlescapeState::cbxEdgeScrollChange ( Action * action )

Handler for changing the Edge Scroll combobox.

Changes the Edge Scroll option.

Parameters

action Pointer to an action.

◆ slrAlienSpeedChange()

void OpenXcom::OptionsBattlescapeState::slrAlienSpeedChange ( Action * action )

Handler for changing the alien movement speed slider.

Updates the alien movement speed.

Parameters

action Pointer to an action.

◆ slrFireSpeedChange()

void OpenXcom::OptionsBattlescapeState::slrFireSpeedChange ( Action * action )

Handler for changing the fire speed slider.

Updates the fire speed.

Parameters

action Pointer to an action.

◆ slrScrollSpeedChange()

void OpenXcom::OptionsBattlescapeState::slrScrollSpeedChange ( Action * action )

Handler for changing the scroll speed slider.

Updates the scroll speed.

Parameters

action Pointer to an action.

◆ slrXcomSpeedChange()

void OpenXcom::OptionsBattlescapeState::slrXcomSpeedChange ( Action * action )

Handler for changing the X-COM movement speed slider.

Updates the X-COM movement speed.

Parameters

action Pointer to an action.

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

OptionsBattlescapeState.h
OptionsBattlescapeState.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OptionsBattlescapeState()

Member Function Documentation

◆ btnDeathsClick()

◆ btnPathPreviewClick()

◆ btnTooltipsClick()

◆ cbxDragScrollChange()

◆ cbxEdgeScrollChange()

◆ slrAlienSpeedChange()

◆ slrFireSpeedChange()

◆ slrScrollSpeedChange()

◆ slrXcomSpeedChange()