1

/* $Id$ */

     2

     3

/** @file ai_gamesettings.hpp Everything to read game settings. */

     4

     5

#ifndef AI_GAMESETTINGS_HPP

     6

#define AI_GAMESETTINGS_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all game settings related functions.

    12

 *

    13

 * @note AIGameSettings::IsValid and AIGameSettings::GetValue are functions

    14

 *       that rely on the settings as OpenTTD stores them in savegame and

    15

 *       openttd.cfg. No guarantees can be given on the long term validity,

    16

 *       consistency and stability of the names, values and value ranges.

    17

 *       Using these settings can be dangerous and could cause issues in

    18

 *       future versions. To make sure that a setting still exists in the

    19

 *       current version you have to run AIGameSettings::IsValid before

    20

 *       accessing it.

    21

 *

    22

 * @note The names of the setting for AIGameSettings::IsValid and

    23

 *       AIGameSettings::GetValue are the same ones as those that are shown by

    24

 *       the list_patches command in the in-game console. Settings that are

    25

 *       string based are NOT supported and AIGAmeSettings::IsValid will return

    26

 *       false for them. These settings will not be supported either because

    27

 *       they have no relevance for the AI (default player names, server IPs,

    28

 *       etc.).

    29

 */

    30

class AIGameSettings : public AIObject {

    31

public:

    32

	static const char *GetClassName() { return "AIGameSettings"; }

    33

    34

	/**

    35

	 * Is the given game setting a valid setting for this instance of OpenTTD?

    36

	 * @param setting The setting to check for existence.

    37

	 * @warning Results of this function are not governed by the API. This means

    38

	 *          that a setting that previously existed can be gone or has

    39

	 *          changed it's name.

    40

	 * @note Results achieved in the past offer no gurantee for the future.

    41

	 * @return True if and only if the setting is valid.

    42

	 */

    43

	static bool IsValid(const char *setting);

    44

    45

	/**

    46

	 * Gets the value of the game setting.

    47

	 * @param setting The setting to get the value of.

    48

	 * @pre IsValid(setting).

    49

	 * @warning Results of this function are not governed by the API. This means

    50

	 *          that the value of settings may be out of the expected range. It

    51

	 *          also means that a setting that previously existed can be gone or

    52

	 *          has changed it's name/characteristics.

    53

	 * @note Results achieved in the past offer no gurantee for the future.

    54

	 * @return The value for the setting.

    55

	 */

    56

	static int32 GetValue(const char *setting);

    57

};

    58

    59

#endif /* AI_GAMESETTINGS_HPP */