_________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine

Classes
settings.h File Reference
#include <bitset>
#include <stdint.h>
#include <string>
#include <vector>
#include <functional>
#include <variant>

Go to the source code of this file.

Classes

struct  SettingsPresets
 
struct  Settings
 

settings.h - The game settings headerfile.

#define USING_TOLUAPP   1
 
#define ENUM_CLASS   enum
 
constexpr unsigned char PlayerMax = 16
 
constexpr unsigned short UnitTypeMax = 2048
 How many players are supported. More...
 
constexpr unsigned short UpgradeMax = 2048
 How many unit types supported. More...
 
constexpr unsigned char MAX_RACES = 8
 How many upgrades supported. More...
 
constexpr unsigned char PlayerNumNeutral = PlayerMax - 1
 
constexpr unsigned char FRAMES_PER_SECOND = 30
 this is the neutral player slot More...
 
constexpr unsigned char CYCLES_PER_SECOND = 30
 Game cycles per second to simulate (original 30-40) More...
 
constexpr int8_t SettingsPresetMapDefault = -1
 
ENUM_CLASS PlayerTypes
 Special: Use map supplied. More...
 
ENUM_CLASS PlayerUnset = 0
 use default More...
 
ENUM_CLASS PlayerNeutral = 2
 not set More...
 
ENUM_CLASS PlayerNobody = 3
 neutral More...
 
ENUM_CLASS PlayerComputer = 4
 unused slot More...
 
ENUM_CLASS PlayerPerson = 5
 computer player More...
 
ENUM_CLASS PlayerRescuePassive = 6
 human player More...
 
ENUM_CLASS PlayerRescueActive
 rescued passive More...
 
std::string PlayerTypeNames [static_cast< int >(PlayerTypes::PlayerRescueActive)+1]
 
ENUM_CLASS RevealTypes
 
ENUM_CLASS cAllUnits
 
ENUM_CLASS cBuildingsOnly
 
ENUM_CLASS NetGameTypes
 Revelation types. More...
 
ENUM_CLASS SettingsMultiPlayerGame
 
ENUM_CLASS Unset
 
ENUM_CLASS GameTypes
 
ENUM_CLASS SettingsGameTypeMelee = 0
 
ENUM_CLASS SettingsGameTypeFreeForAll
 
ENUM_CLASS SettingsGameTypeTopVsBottom
 
ENUM_CLASS SettingsGameTypeLeftVsRight
 
ENUM_CLASS SettingsGameTypeManVsMachine
 
ENUM_CLASS SettingsGameTypeManTeamVsMachine
 
ENUM_CLASS SettingsGameTypeMachineVsMachine
 
ENUM_CLASS SettingsGameTypeMachineVsMachineTraining
 
ENUM_CLASS MapRevealModes
 
ENUM_CLASS cKnown
 
ENUM_CLASS cExplored
 
ENUM_CLASS cNumOfModes
 
ENUM_CLASS FieldOfViewTypes
 
ENUM_CLASS cSimpleRadial
 
ENUM_CLASS NumOfTypes
 
Settings GameSettings
 
void InitSettings ()
 Game settings. More...
 

Macro Definition Documentation

◆ ENUM_CLASS

#define ENUM_CLASS   enum

◆ USING_TOLUAPP

#define USING_TOLUAPP   1

Function Documentation

◆ InitSettings()

void InitSettings ( )

Game settings.

Init Setting to default values

Init Game Setting to default values

Todo:
FIXME: this should not be executed for restart levels!

Variable Documentation

◆ cAllUnits

ENUM_CLASS cAllUnits

◆ cBuildingsOnly

ENUM_CLASS cBuildingsOnly

◆ cExplored

ENUM_CLASS cExplored

◆ cKnown

ENUM_CLASS cKnown

◆ cNumOfModes

ENUM_CLASS cNumOfModes

◆ cSimpleRadial

ENUM_CLASS cSimpleRadial

◆ CYCLES_PER_SECOND

constexpr unsigned char CYCLES_PER_SECOND = 30
constexpr

Game cycles per second to simulate (original 30-40)

◆ FieldOfViewTypes

ENUM_CLASS FieldOfViewTypes

◆ FRAMES_PER_SECOND

constexpr unsigned char FRAMES_PER_SECOND = 30
constexpr

this is the neutral player slot

Frames per second to display (original 30-40)

◆ GameSettings

Settings GameSettings

◆ GameTypes

ENUM_CLASS GameTypes

GameType settings

◆ MapRevealModes

ENUM_CLASS MapRevealModes

Map revealing modes: cHidden - unrevealed, cKnown - you can see unexplored tiles, but they are darker than explored cExplored - all tiles became explored, and covered only by the fog of war if it's enabled.

◆ MAX_RACES

constexpr unsigned char MAX_RACES = 8
constexpr

How many upgrades supported.

◆ NetGameTypes

ENUM_CLASS NetGameTypes

Revelation types.

Single or multiplayer settings

◆ NumOfTypes

ENUM_CLASS NumOfTypes

◆ PlayerComputer

ENUM_CLASS PlayerComputer = 4

unused slot

◆ PlayerMax

constexpr unsigned char PlayerMax = 16
constexpr

◆ PlayerNeutral

ENUM_CLASS PlayerNeutral = 2

not set

◆ PlayerNobody

ENUM_CLASS PlayerNobody = 3

neutral

◆ PlayerNumNeutral

constexpr unsigned char PlayerNumNeutral = PlayerMax - 1
constexpr

◆ PlayerPerson

ENUM_CLASS PlayerPerson = 5

computer player

◆ PlayerRescueActive

ENUM_CLASS PlayerRescueActive
Initial value:
= 7
}

rescued passive

◆ PlayerRescuePassive

ENUM_CLASS PlayerRescuePassive = 6

human player

◆ PlayerTypeNames

std::string PlayerTypeNames[static_cast< int >(PlayerTypes::PlayerRescueActive)+1]

◆ PlayerTypes

ENUM_CLASS PlayerTypes

Special: Use map supplied.

Types for the player

PlayerNeutral

This player is controlled by the computer doing nothing.

PlayerNobody

This player is unused. Nobody controls this player.

PlayerComputer

This player is controlled by the computer. CPlayer::AiNum selects the AI strategy.

PlayerPerson

This player is contolled by a person. This can be the player sitting on the local computer or player playing over the network.

PlayerRescuePassive

This player does nothing, the game pieces just sit in the game (being passive)... when a person player moves next to a PassiveRescue unit/building, then it is "rescued" and becomes part of that persons team. If the city center is rescued, than all units of this player are rescued.

PlayerRescueActive

This player is controlled by the computer. CPlayer::AiNum selects the AI strategy. Until it is rescued it plays like an ally. The first person which reaches units of this player, can rescue them. If the city center is rescued, than all units of this player are rescued.

◆ PlayerUnset

ENUM_CLASS PlayerUnset = 0

use default

◆ RevealTypes

ENUM_CLASS RevealTypes

◆ SettingsGameTypeFreeForAll

ENUM_CLASS SettingsGameTypeFreeForAll

◆ SettingsGameTypeLeftVsRight

ENUM_CLASS SettingsGameTypeLeftVsRight

◆ SettingsGameTypeMachineVsMachine

ENUM_CLASS SettingsGameTypeMachineVsMachine

◆ SettingsGameTypeMachineVsMachineTraining

ENUM_CLASS SettingsGameTypeMachineVsMachineTraining

◆ SettingsGameTypeManTeamVsMachine

ENUM_CLASS SettingsGameTypeManTeamVsMachine

◆ SettingsGameTypeManVsMachine

ENUM_CLASS SettingsGameTypeManVsMachine

◆ SettingsGameTypeMelee

ENUM_CLASS SettingsGameTypeMelee = 0

◆ SettingsGameTypeTopVsBottom

ENUM_CLASS SettingsGameTypeTopVsBottom

◆ SettingsMultiPlayerGame

ENUM_CLASS SettingsMultiPlayerGame

◆ SettingsPresetMapDefault

constexpr int8_t SettingsPresetMapDefault = -1
constexpr

◆ UnitTypeMax

constexpr unsigned short UnitTypeMax = 2048
constexpr

How many players are supported.

◆ Unset

ENUM_CLASS Unset

◆ UpgradeMax

constexpr unsigned short UpgradeMax = 2048
constexpr

How many unit types supported.

(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.