1

/* $Id$ */

     2

     3

#ifndef SETTINGS_H

     4

#define SETTINGS_H

     5

     6

#include "saveload.h"

     7

     8

/** Convention/Type of settings. This is then further specified if necessary

     9

 * with the SLE_ (SLE_VAR/SLE_FILE) enums in saveload.h

    10

 * @see VarTypes

    11

 * @see SettingDescBase */

    12

enum SettingDescType {

    13

	/* 4 bytes allocated a maximum of 16 types for GenericType */

    14

	SDT_NUMX        = 0, // any number-type

    15

	SDT_BOOLX       = 1, // a boolean number

    16

	SDT_ONEOFMANY   = 2, // bitmasked number where only ONE bit may be set

    17

	SDT_MANYOFMANY  = 3, // bitmasked number where MULTIPLE bits may be set

    18

	SDT_INTLIST     = 4, // list of integers seperated by a comma ','

    19

	SDT_STRING      = 5, // string with a pre-allocated buffer

    20

	/* 10 more possible primitives */

    21

};

    22

    23

enum SettingGuiFlag {

    24

	/* 8 bytes allocated for a maximum of 8 flags

    25

	 * Flags directing saving/loading of a variable */

    26

	SGF_0ISDISABLED  = 1 << 0, ///< a value of zero means the feature is disabled

    27

	SGF_NOCOMMA      = 1 << 1, ///< number without any thousand seperators (no formatting)

    28

	SGF_MULTISTRING  = 1 << 2, ///< the value represents a limited number of string-options (internally integer)

    29

	SGF_NETWORK_ONLY = 1 << 3, ///< this setting only applies to network games

    30

	SGF_CURRENCY     = 1 << 4, ///< the number represents money, so when reading value multiply by exchange rate

    31

	/* 3 more possible flags */

    32

};

    33

    34

typedef int32 OnChange(int32 var);

    35

typedef byte SettingDescType;

    36

typedef byte SettingGuiFlag;

    37

    38

typedef struct SettingDescBase {

    39

	const char *name;       ///< name of the setting. Used in configuration file and for console

    40

	const void *def;        ///< default value given when none is present

    41

	SettingDescType cmd;    ///< various flags for the variable

    42

	SettingGuiFlag flags;   ///< handles how a setting would show up in the GUI (text/currency, etc.)

    43

	int32 min, max;         ///< minimum and maximum values

    44

	int32 interval;         ///< the interval to use between settings in the 'patches' window. If interval is '0' the interval is dynamically determined

    45

	const char *many;       ///< ONE/MANY_OF_MANY: string of possible values for this type

    46

	StringID str;           ///< (translated) string with descriptive text; gui and console

    47

	OnChange *proc;         ///< callback procedure for when the value is changed

    48

} SettingDescBase;

    49

    50

typedef struct SettingDesc {

    51

	SettingDescBase desc;   ///< Settings structure (going to configuration file)

    52

	SaveLoad save;          ///< Internal structure (going to savegame, parts to config)

    53

} SettingDesc;

    54

    55

/* NOTE: The only difference between SettingDesc and SettingDescGlob is

    56

 * that one uses global variables as a source and the other offsets

    57

 * in a struct which are bound to a certain variable during runtime.

    58

 * The only way to differentiate between these two is to check if an object

    59

 * has been passed to the function or not. If not, then it is a global variable

    60

 * and save->variable has its address, otherwise save->variable only holds the

    61

 * offset in a certain struct */

    62

typedef SettingDesc SettingDescGlobVarList;

    63

    64

typedef enum {

    65

	IGT_VARIABLES = 0, ///< values of the form "landscape = hilly"

    66

	IGT_LIST      = 1, ///< a list of values, seperated by \n and terminated by the next group block

    67

} IniGroupType;

    68

    69

/** The patch values that are used for new games and/or modified in config file */

    70

extern Patches _patches_newgame;

    71

    72

bool IConsoleSetPatchSetting(const char *name, int32 value);

    73

void IConsoleGetPatchSetting(const char *name);

    74

void IConsoleListPatches(void);

    75

const SettingDesc *GetPatchFromName(const char *name, uint *i);

    76

bool SetPatchValue(uint index, const Patches *object, int32 value);

    77

    78

#endif /* SETTINGS_H */