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

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

    25

	 */

    26

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

    27

    28

	/**

    29

	 * Get a random value.

    30

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

    31

	 */

    32

	static uint32 Rand();

    33

    34

	/**

    35

	 * Get a random value.

    36

	 * @param unused_param This param is not used, but is needed to work with lists.

    37

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

    38

	 */

    39

	static uint32 RandItem(int unused_param);

    40

    41

	/**

    42

	 * Get a random value in a range.

    43

	 * @param max the maximum value it will return.

    44

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

    45

	 */

    46

	static uint RandRange(uint max);

    47

    48

	/**

    49

	 * Get a random value in a range.

    50

	 * @param unused_param This param is not used, but is needed to work with lists.

    51

	 * @param max the maximum value it will return.

    52

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

    53

	 */

    54

	static uint RandRangeItem(int unused_param, uint max);

    55

    56

	/**

    57

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

    58

	 *   After all, it is a random function.

    59

	 * @param out how many times it should return true.

    60

	 * @param max out of this many times.

    61

	 * @return true if the chance worked out.

    62

	 */

    63

	static bool Chance(uint out, uint max);

    64

    65

	/**

    66

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

    67

	 *   After all, it is a random function.

    68

	 * @param unused_param This param is not used, but is needed to work with lists.

    69

	 * @param out how many times it should return true.

    70

	 * @param max out of this many times.

    71

	 * @return true if the chance worked out.

    72

	 */

    73

	static bool ChanceItem(int unused_param, uint out, uint max);

    74

};

    75

    76

#endif /* AI_BASE_HPP */