1

/* $Id$ */

     2

     3

/** @file ai_settings.hpp everything to change AI settings */

     4

     5

#ifndef AI_SETTINGS_HPP

     6

#define AI_SETTINGS_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all AI settings related functions.

    12

 */

    13

class AISettings : public AIObject {

    14

public:

    15

	/**

    16

	 * The name of the class, needed by several sub-processes.

    17

	 */

    18

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

    19

    20

	/**

    21

	 * Change the minimum amount of time the AI should be put in suspend mode

    22

	 *   when you execute a command. Normally in SP this is 1, and in MP it is

    23

	 *   what ever delay the server has been programmed to delay commands

    24

	 *   (normally between 1 and 5). To give a more 'real' effect to your AI,

    25

	 *   you can control that number here.

    26

	 * @param ticks the minimum amount of ticks to wait.

    27

	 * @pre ticks should be positive. Too big values will influence performance of the AI.

    28

	 * @note If the number is lower then the MP setting, the MP setting wins.

    29

	 */

    30

	static void SetCommandDelay(uint ticks);

    31

};

    32

    33

#endif /* AI_SETTINGS_HPP */