game_options.h File Reference

#include "ccfwd.h"
#include "screen_coordinate.h"
#include "starting_position_type.h"
#include "volume.h"
#include "game_speed.h"
#include <iosfwd>

Include dependency graph for game_options.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	game_options
	Options for the game. More...

Functions
void	decrease_game_speed (game_options &g) noexcept
	Decrease the game speed.
void	decrease_music_volume (game_options &g) noexcept
	Decrease the music volume.
void	decrease_sound_effects_volume (game_options &g) noexcept
	Decrease the sound effects volume.
void	decrease_starting_position (game_options &g) noexcept
	Decrease the sound effects volume.
bool	do_show_selected (const game_options &g) noexcept
	Are selected squares shown on-screen?
constexpr double	get_default_click_distance () noexcept
	The default pixels distance for the mouse for a click to connect to a piece.
constexpr double	get_default_message_display_time_secs () noexcept
	How long log messages are displayed.
volume	get_default_music_volume () noexcept
	The default music volume.
volume	get_default_sound_effects_volume () noexcept
	The default sound effects volume.
const volume &	get_music_volume (const game_options &g) noexcept
	Get the music volume.
double	get_music_volume_as_percentage (const game_options &g) noexcept
	Get the music volume as a percentage.
const volume &	get_sound_effects_volume (const game_options &g) noexcept
	Get the sound effects volume.
starting_position_type	get_starting_position (const game_options &g) noexcept
	Get the starting position.
void	increase_game_speed (game_options &g) noexcept
	Increase the game speed.
void	increase_music_volume (game_options &g) noexcept
	Increase the music volume.
void	increase_sound_effects_volume (game_options &g) noexcept
	Increase the sound effects volume.
void	increase_starting_position (game_options &g) noexcept
	Increase the starting position.
void	test_game_options ()
	Test this class and its free functions.
bool	operator== (const game_options &lhs, const game_options &rhs) noexcept
bool	operator!= (const game_options &lhs, const game_options &rhs) noexcept
std::ostream &	operator<< (std::ostream &os, const game_options &options) noexcept

Function Documentation

decrease_game_speed()

void decrease_game_speed ( game_options &  g )

noexcept

Decrease the game speed.

decrease_music_volume()

void decrease_music_volume ( game_options &  g )

noexcept

Decrease the music volume.

decrease_sound_effects_volume()

void decrease_sound_effects_volume ( game_options &  g )

noexcept

Decrease the sound effects volume.

decrease_starting_position()

void decrease_starting_position ( game_options &  g )

noexcept

Decrease the sound effects volume.

do_show_selected()

bool do_show_selected ( const game_options &  g )

noexcept

Are selected squares shown on-screen?

get_default_click_distance()

constexpr double get_default_click_distance ( )

constexprnoexcept

The default pixels distance for the mouse for a click to connect to a piece.

get_default_message_display_time_secs()

constexpr double get_default_message_display_time_secs ( )

constexprnoexcept

How long log messages are displayed.

get_default_music_volume()

volume get_default_music_volume ( )

noexcept

The default music volume.

In percent, i.e. 20 denotes 20% of the maximum.

get_default_sound_effects_volume()

volume get_default_sound_effects_volume ( )

noexcept

The default sound effects volume.

In percent, i.e. 20 denotes 20% of the maximum.

get_music_volume()

const volume & get_music_volume ( const game_options &  g )

noexcept

Get the music volume.

get_music_volume_as_percentage()

double get_music_volume_as_percentage ( const game_options &  g )

noexcept

Get the music volume as a percentage.

get_sound_effects_volume()

const volume & get_sound_effects_volume ( const game_options &  g )

noexcept

Get the sound effects volume.

get_starting_position()

starting_position_type get_starting_position ( const game_options &  g )

noexcept

Get the starting position.

increase_game_speed()

void increase_game_speed ( game_options &  g )

noexcept

Increase the game speed.

increase_music_volume()

void increase_music_volume ( game_options &  g )

noexcept

Increase the music volume.

increase_sound_effects_volume()

void increase_sound_effects_volume ( game_options &  g )

noexcept

Increase the sound effects volume.

increase_starting_position()

void increase_starting_position ( game_options &  g )

noexcept

Increase the starting position.

operator!=()

bool operator!= ( const game_options &  lhs, const game_options &  rhs  )

noexcept

operator<<()

std::ostream & operator<< ( std::ostream &  os, const game_options &  options  )

noexcept

operator==()

bool operator== ( const game_options &  lhs, const game_options &  rhs  )

noexcept

test_game_options()

void test_game_options

(

)

Test this class and its free functions.