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 */

    13

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

    15

	SDT_NUMX        = 0, // any number-type

    16

	SDT_BOOLX       = 1, // a boolean number

    17

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

    18

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

    19

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

    20

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

    22

	/* 10 more possible primitives */

    23

};

    24

    30

	/* 8 bytes allocated for a maximum of 8 flags

    31

	 * Flags directing saving/loading of a variable */

    33

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

    34

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

    35

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

    36

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

    37

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

    39

	/* 3 more possible flags */

    40

};

    41

    47

typedef int32 OnChange(int32 var);

    48

    49

typedef struct SettingDescBase {

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

} SettingDescBase;

    60

    61

typedef struct SettingDesc {

    62

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

    63

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

    64

} SettingDesc;

    65

    66

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

    67

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

    68

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

    69

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

    70

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

    71

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

    72

 * offset in a certain struct */

    73

typedef SettingDesc SettingDescGlobVarList;

    74

    75

typedef enum {

    76

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

    77

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

    78

} IniGroupType;

    79

    80

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

    81

extern Patches _patches_newgame;

    82

    83

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

    84

void IConsoleGetPatchSetting(const char *name);

    85

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

    86

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

    87

    88

#endif /* SETTINGS_H */