1

/* $Id$ */

     2

     3

/** @file ai_company.hpp Everything to query a company's financials and statistics or build company related buildings. */

     4

     5

#ifndef AI_COMPANY_HPP

     6

#define AI_COMPANY_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all company related functions.

    12

 */

    13

class AICompany : public AIObject {

    14

public:

    15

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

    16

    18

	enum CompanyIndex {

    19

		FIRST_COMPANY   = 0, ///< The first available company.

    20

		LAST_COMPANY    = 7, ///< The last available company.

    21

		MY_COMPANY      = 8, ///< Constant that gets resolved to the correct company index for your company.

    23

	};

    24

    25

	/**

    32

	 */

    33

	static CompanyIndex ResolveCompanyIndex(CompanyIndex company);

    34

    35

	/**

    36

	 * Set the name of your company.

    39

	 */

    40

	static bool SetCompanyName(const char *name);

    41

    42

	/**

    43

	 * Get the name of the given company.

    45

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

    47

	 */

    48

	static char *GetCompanyName(CompanyIndex company);

    49

    50

	/**

    51

	 * Set the name of your president.

    54

	 */

    55

	static bool SetPresidentName(const char *name);

    56

    57

	/**

    58

	 * Get the name of the president of the given company.

    60

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

    62

	 */

    63

	static char *GetPresidentName(CompanyIndex company);

    64

    65

	/**

    66

	 * Sets the amount to loan.

    73

	 */

    74

	static bool SetLoanAmount(int32 loan);

    75

    76

	/**

    77

	 * Sets the minimum amount to loan, i.e. the given amount of loan rounded up.

    82

	 */

    83

	static bool SetMinimumLoanAmount(int32 loan);

    84

    85

	/**

    86

	 * Gets the amount your company have loaned.

    89

	 * @post GetLoanInterval() is always a multiplier of the return value.

    90

	 */

    91

	static int32 GetLoanAmount();

    92

    93

	/**

    94

	 * Gets the maximum amount your company can loan.

    97

	 * @post GetLoanInterval() is always a multiplier of the return value.

    98

	 */

    99

	static int32 GetMaxLoanAmount();

   100

   101

	/**

   102

	 * Gets the interval/loan step.

   105

	 */

   106

	static int32 GetLoanInterval();

   107

   108

	/**

   109

	 * Gets the current value of the given company.

   111

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

   113

	 */

   114

	static int32 GetCompanyValue(CompanyIndex company);

   115

   116

	/**

   117

	 * Gets the bank balance. In other words, the amount of money the given company can spent.

   119

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

   121

	 */

   122

	static int32 GetBankBalance(CompanyIndex company);

   123

   124

	/**

   125

	 * Build your company's HQ on the given tile.

   127

	 * @pre AIMap::IsValidTile(tile).

   131

	 */

   132

	static bool BuildCompanyHQ(TileIndex tile);

   133

   134

	/**

   135

	 * Return the location of a company's HQ.

   137

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY.

   138

	 * @return The tile of the company's HQ, this tile is the most nothern tile of that HQ, or INVALID_TILE if there is no HQ yet.

   139

	 */

   140

	static TileIndex GetCompanyHQ(CompanyIndex company);

   141

};

   142

   143

DECLARE_POSTFIX_INCREMENT(AICompany::CompanyIndex);

   144

   145

#endif /* AI_COMPANY_HPP */