1

/* $Id$ */

     2

     3

/** @file ai_industry.hpp Everything to query about industries */

     4

     5

#ifndef AI_INDUSTRY_HPP

     6

#define AI_INDUSTRY_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all industry related functions.

    12

 */

    13

class AIIndustry : public AIObject {

    14

public:

    15

	/**

    16

	 * Gets the maximum industry index; there are no valid industries with a

    17

	 *   higher index.

    18

	 * @return the maximum industry index.

    19

	 * @post return value is always non-negative.

    20

	 */

    21

	IndustryID GetMaxIndustryID();

    22

    23

	/**

    24

	 * Gets the number of industries. This is different than GetMaxIndustryID()

    25

	 *   because of the way OpenTTD works internally.

    26

	 * @return the number of industries.

    27

	 * @post return value is always non-negative.

    28

	 */

    29

	int32 GetIndustryCount();

    30

    31

	/**

    32

	 * Checks whether the given industry index is valid.

    33

	 * @param industry_id the index to check.

    34

	 * @return true if and only if the industry is valid.

    35

	 */

    36

	bool IsValidIndustry(IndustryID industry_id);

    37

    38

	/**

    39

	 * Get the name of the industry.

    40

	 * @param industry_id the industry to get the name of.

    41

	 * @pre industry_id has to be valid (use IsValidIndustry()).

    42

	 * @return the name of the industry.

    43

	 * @note the returned name must be free'd (C++ only).

    44

	 */

    45

	char *GetName(IndustryID industry_id);

    46

    47

	/**

    48

	 * Gets the location of the industry.

    49

	 * @param industry_id the location of the industry.

    50

	 * @pre industry_id has to be valid (use IsValidIndustry()).

    51

	 * @return the location of the industry.

    52

	 * @post return value is always positive and below AIMap::GetMapSize().

    53

	 */

    54

	TileIndex GetLocation(IndustryID industry_id);

    55

};

    56

    57

#ifdef DEFINE_SQUIRREL_CLASS

    58

void SQAIIndustryRegister(Squirrel *engine) {

    59

	DefSQClass <AIIndustry> SQAIIndustry("AIIndustry");

    60

	SQAIIndustry.PreRegister(engine);

    61

	SQAIIndustry.AddConstructor(engine);

    62

	SQAIIndustry.DefSQFunction(engine, &AIIndustry::GetMaxIndustryID, "GetMaxIndustryID");

    63

	SQAIIndustry.DefSQFunction(engine, &AIIndustry::GetIndustryCount, "GetIndustryCount");

    64

	SQAIIndustry.DefSQFunction(engine, &AIIndustry::IsValidIndustry,  "IsValidIndustry");

    65

	SQAIIndustry.DefSQFunction(engine, &AIIndustry::GetName,          "GetName");

    66

	SQAIIndustry.DefSQFunction(engine, &AIIndustry::GetLocation,      "GetLocation");

    67

	SQAIIndustry.PostRegister(engine);

    68

}

    69

#endif /* SQUIRREL_CLASS */

    70

    71

#endif /* AI_INDUSTRY_HPP */