game_options Class Reference

Options for the game. More...

#include <game_options.h>

Public Member Functions
	game_options ()
auto	get_click_distance () const noexcept
	Get the distance the mouse must be maximally in for a click to connect to a piece.
auto	get_damage_per_chess_move () const noexcept
	Get the damage per chess move that all pieces deal.
auto	get_game_speed () const noexcept
	Get the game speed.
double	get_message_display_time_secs () const noexcept
	How long log messages are displayed.
auto	get_show_debug_info () const noexcept
	Show the debug info.
auto	get_show_occupied () const noexcept
	Show the squares that are actually occupied by the piecs?
auto	get_show_selected () const noexcept
	Are selected units highlighted?
starting_position_type	get_starting_position () const noexcept
	Get the starting position.
const auto &	get_music_volume () const noexcept
	Get the music volume, as a percentage.
const volume &	get_sound_effects_volume () const noexcept
	Get the sound effects volume.
void	reset ()
	Reset all values to defaults.
void	set_game_speed (const game_speed speed) noexcept
	Set the game speed.
void	set_music_volume (const volume &v) noexcept
	Set the volume, as a percentage.
void	set_show_debug_info (const bool b) noexcept
	Set showing the debug info.
void	set_starting_position (const starting_position_type starting_position) noexcept
	Set the starting position.
void	set_sound_effects_volume (const volume &v) noexcept
	Set the sound effects volume, as a percentage.

Detailed Description

Options for the game.

Options for the game, such as speed. Some options are set by the user in the options_view}, some are variables obtained by tuning the game.

Constructor & Destructor Documentation

game_options()

game_options::game_options

(

)

Member Function Documentation

get_click_distance()

auto game_options::get_click_distance ( ) const

inlinenoexcept

Get the distance the mouse must be maximally in for a click to connect to a piece.

get_damage_per_chess_move()

auto game_options::get_damage_per_chess_move ( ) const

inlinenoexcept

Get the damage per chess move that all pieces deal.

get_game_speed()

auto game_options::get_game_speed ( ) const

inlinenoexcept

Get the game speed.

get_message_display_time_secs()

double game_options::get_message_display_time_secs ( ) const

inlinenoexcept

How long log messages are displayed.

get_music_volume()

const auto & game_options::get_music_volume ( ) const

inlinenoexcept

Get the music volume, as a percentage.

get_show_debug_info()

auto game_options::get_show_debug_info ( ) const

inlinenoexcept

Show the debug info.

get_show_occupied()

auto game_options::get_show_occupied ( ) const

inlinenoexcept

Show the squares that are actually occupied by the piecs?

get_show_selected()

auto game_options::get_show_selected ( ) const

inlinenoexcept

Are selected units highlighted?

get_sound_effects_volume()

const volume & game_options::get_sound_effects_volume ( ) const

inlinenoexcept

Get the sound effects volume.

get_starting_position()

starting_position_type game_options::get_starting_position ( ) const

inlinenoexcept

Get the starting position.

reset()

void game_options::reset

(

)

Reset all values to defaults.

set_game_speed()

void game_options::set_game_speed ( const game_speed  speed )

inlinenoexcept

Set the game speed.

set_music_volume()

void game_options::set_music_volume ( const volume &  v )

inlinenoexcept

Set the volume, as a percentage.

set_show_debug_info()

void game_options::set_show_debug_info ( const bool  b )

inlinenoexcept

Set showing the debug info.

set_sound_effects_volume()

void game_options::set_sound_effects_volume ( const volume &  v )

inlinenoexcept

Set the sound effects volume, as a percentage.

set_starting_position()

void game_options::set_starting_position ( const starting_position_type  starting_position )

inlinenoexcept

Set the starting position.

---

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

• include/game_options.h
• src/game_options.cpp