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

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

    17

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

    18

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

    19

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

    20

	 *   you can control that number here.

    21

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

    22

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

    23

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

    24

	 */

    25

	void SetCommandDelay(uint ticks);

    26

};

    27

    28

#ifdef DEFINE_SQUIRREL_CLASS

    29

void SQAISettingsRegister(Squirrel *engine) {

    30

	DefSQClass <AISettings> SQAISettings("AISettings");

    31

	SQAISettings.PreRegister(engine);

    32

	SQAISettings.AddConstructor(engine);

    33

	SQAISettings.DefSQFunction(engine, &AISettings::SetCommandDelay, "SetCommandDelay");

    34

	SQAISettings.PostRegister(engine);

    35

}

    36

#endif /* SQUIRREL_CLASS */

    37

    38

#endif /* AI_SETTINGS_HPP */