1

/* $Id$ */

     2

     3

/** @file ai_base.hpp declaration of class for AIBase class */

     4

     5

#ifndef AI_BASE_HPP

     6

#define AI_BASE_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles some basic functions.

    12

 *

    13

 * @note The random functions are not called Random and RandomRange, because

    14

 *       when including them the RANDOM_DEBUG stuff messes with their names.

    15

 *       However, because in MP we cannot use Random because that will cause

    16

 *       desyncs (AIs are ran locally, not on all clients). This means that

    17

 *       we use InteractiveRandom in MP, thus the whole random debugging is

    18

 *       pointless for the AIs. Therefor the random functions are called

    19

 *       differently.

    20

 */

    21

class AIBase : public AIObject {

    22

public:

    23

	/**

    24

	 * Get a random value.

    25

	 * @return a random value between 0 and MAX(uint32).

    26

	 */

    27

	uint32 Rand();

    28

    29

	/**

    30

	 * Get a random value in a range.

    31

	 * @param max the maximum value it will return.

    32

	 * @return a random value between 0 .. max.

    33

	 */

    34

	uint RandRange(uint max);

    35

    36

	/**

    37

	 * Returns approximatelly 'out' times true when called 'max' times.

    38

	 *   After all, it is a random function.

    39

	 * @return true if the chance worked out.

    40

	 */

    41

	bool Chance(uint out, uint max);

    42

};

    43

    44

#ifdef DEFINE_SQUIRREL_CLASS

    45

void SQAIBaseRegister(Squirrel *engine) {

    46

	DefSQClass <AIBase> SQAIBase("AIBase");

    47

	SQAIBase.PreRegister(engine);

    48

	SQAIBase.AddConstructor(engine);

    49

	SQAIBase.DefSQFunction(engine, &AIBase::Rand,      "Rand");

    50

	SQAIBase.DefSQFunction(engine, &AIBase::RandRange, "RandRange");

    51

	SQAIBase.DefSQFunction(engine, &AIBase::Chance,    "Chance");

    52

	SQAIBase.PostRegister(engine);

    53

}

    54

#endif /* SQUIRREL_CLASS */

    55

    56

#endif /* AI_BASE_HPP */