mirror of
https://github.com/wesnoth/wesnoth
synced 2025-04-30 01:47:13 +00:00
106 lines
3.0 KiB
C++
106 lines
3.0 KiB
C++
/* $Id$ */
|
|
/*
|
|
Copyright (C) 2007 - 2009 by Mark de Wever <koraq@xs4all.nl>
|
|
Part of the Battle for Wesnoth Project http://www.wesnoth.org/
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License version 2
|
|
or at your option any later version.
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY.
|
|
|
|
See the COPYING file for more details.
|
|
*/
|
|
|
|
/**
|
|
* @file src/settings.hpp
|
|
* General settings and defaults for scenarios.
|
|
*/
|
|
|
|
#ifndef SETTINGS_HPP_INCLUDED
|
|
#define SETTINGS_HPP_INCLUDED
|
|
|
|
#include <string>
|
|
|
|
/**
|
|
* Contains the general settings which have a default.
|
|
* These values can be used to initialize the preferences,
|
|
* but also to set map values if these aren't defined.
|
|
*/
|
|
|
|
namespace settings {
|
|
|
|
/**
|
|
* Gets the number of turns.
|
|
* If no valid value supplied, it will return a default.
|
|
* The value is also range checked.
|
|
* When out of bounds, it will be set to the nearest bound.
|
|
*
|
|
* @param value string containing the number of turns
|
|
*
|
|
* @returns the number of turns
|
|
*/
|
|
int get_turns(const std::string& value);
|
|
const int turns_min = 1; //< minimum number of turns
|
|
const int turns_max = 100; //< maximum number of turns
|
|
const int turns_default = 100; //< default number of turns
|
|
const int turns_step = 1; //< slider step size for turns
|
|
|
|
/**
|
|
* Gets the village gold.
|
|
* If no valid value supplied, it will return a default.
|
|
* The value is also range checked.
|
|
* When out of bounds, it will be set to the nearest bound.
|
|
*
|
|
* @param value string containing the village gold
|
|
*
|
|
* @returns the village gold
|
|
*/
|
|
int get_village_gold(const std::string& value);
|
|
|
|
/**
|
|
* Gets the xp modifier.
|
|
* If no valid value supplied, it will return a default.
|
|
* The value is also range checked.
|
|
* When out of bounds, it will be set to the nearest bound.
|
|
*
|
|
* @param value string containing the xp modifier
|
|
*
|
|
* @returns the xp modifier
|
|
*/
|
|
int get_xp_modifier(const std::string& value);
|
|
|
|
/**
|
|
* Returns whether the fog of war should be used.
|
|
* If no valid value is supplied, it will return a default.
|
|
*
|
|
* @param value string containing a boolean value
|
|
*
|
|
* @returns whether or not the fog of war should be used
|
|
*/
|
|
bool use_fog(const std::string& value);
|
|
|
|
/**
|
|
* Returns whether the random start time feature should be used.
|
|
* If no valid value is supplied, it will return a default.
|
|
*
|
|
* @param value string containing a boolean value
|
|
*
|
|
* @returns whether or not the random start time should be used
|
|
*/
|
|
bool use_random_start_time(const std::string& value);
|
|
|
|
/**
|
|
* Returns whether the shroud should be used.
|
|
* If no valid value is supplied, it will return a default.
|
|
*
|
|
* @param value string containing a boolean value
|
|
*
|
|
* @returns whether or not the shroud should be used
|
|
*/
|
|
bool use_shroud(const std::string& value);
|
|
|
|
} // namespace settings
|
|
|
|
#endif
|