1

/* $Id$ */

     2

     3

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

     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

	/**

    16

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

    17

	 */

    18

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

    19

    20

	/** Different constants related to companies */

    21

	enum CompanyIndex {

    22

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

    23

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

    24

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

    25

		INVALID_COMPANY = 9, ///< An invalid company

    26

	};

    27

    28

	/**

    29

	 * Resolved the given company index to the correct index

    30

	 * for the company. If the company index was MY_COMPANY

    31

	 * it will be resolved to the index of your company.

    32

	 * If the company with the given index does not exist

    33

	 * it will return INVALID_COMPANY.

    34

	 * @param company the company index to resolve.

    35

	 * @return the resolved company index.

    36

	 */

    37

	static CompanyIndex ResolveCompanyIndex(CompanyIndex company);

    38

    39

	/**

    40

	 * Set the name of your company.

    41

	 * @param name the new name of the company.

    42

	 * @pre name != NULL

    43

	 * @return true if the name was changed.

    44

	 */

    45

	static bool SetCompanyName(const char *name);

    46

    47

	/**

    48

	 * Get the name of the given company.

    49

	 * @param company the company to get the name for.

    50

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

    51

	 * @return the name of the given company.

    52

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

    53

	 */

    54

	static char *GetCompanyName(CompanyIndex company);

    55

    56

	/**

    57

	 * Set the name of your president.

    58

	 * @param name the new name of the president.

    59

	 * @pre name != NULL

    60

	 * @return true if the name was changed.

    61

	 */

    62

	static bool SetPresidentName(const char *name);

    63

    64

	/**

    65

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

    66

	 * @param company the company to get the president's name for.

    67

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

    68

	 * @return the name of the president of the given company.

    69

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

    70

	 */

    71

	static char *GetPresidentName(CompanyIndex company);

    72

    73

	/**

    74

	 * Gets the current value of the given company.

    75

	 * @param company the company to get the company value of.

    76

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

    77

	 * @return the current value of the given company.

    78

	 */

    79

	static int32 GetCompanyValue(CompanyIndex company);

    80

    81

	/**

    82

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

    83

	 * @param company the company to get the bank balance of.

    84

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

    85

	 * @return the actual bank balance.

    86

	 */

    87

	static int32 GetBankBalance(CompanyIndex company);

    88

    89

	/**

    90

	 * Gets the amount your company have loaned.

    91

	 * @return the amount loaned money.

    92

	 * @post the return value is always non-negative.

    93

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

    94

	 */

    95

	static int32 GetLoanAmount();

    96

    97

	/**

    98

	 * Gets the maximum amount your company can loan.

    99

	 * @return the maximum amount your company can loan.

   100

	 * @post the return value is always non-negative.

   101

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

   102

	 */

   103

	static int32 GetMaxLoanAmount();

   104

   105

	/**

   106

	 * Gets the interval/loan step.

   107

	 * @return the loan step.

   108

	 * @post return value is always positive.

   109

	 */

   110

	static int32 GetLoanInterval();

   111

   112

	/**

   113

	 * Sets the amount to loan.

   114

	 * @param loan the amount to loan (multiplier of GetLoanInterval()).

   115

	 * @pre loan must be non-negative.

   116

	 * @pre GetLoanInterval must be a multiplier of loan.

   117

	 * @pre loan must be below GetMaxLoan().

   118

	 * @pre loan - GetLoanAmount() + GetBankBalance() must be non-negative.

   119

	 * @return true if the loan could be set to your requested amount.

   120

	 */

   121

	static bool SetLoanAmount(int32 loan);

   122

   123

	/**

   124

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

   125

	 * @param loan the amount to loan (any positive number).

   126

	 * @pre loan must be non-negative.

   127

	 * @pre loan must be below GetMaxLoan().

   128

	 * @return true if we could allocate a minimum of "loan" loan.

   129

	 */

   130

	static bool SetMinimumLoanAmount(int32 loan);

   131

   132

	/**

   133

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

   134

	 * @param tile the tile to build your HQ on, this tile is the most nothern tile of your HQ.

   135

	 * @pre AIMap::IsValidTile(tile).

   136

	 * @note An HQ can not be removed, only by water or rebuilding; If an HQ is build again, the old one is removed.

   137

	 * @return true if the HQ could be build.

   138

	 */

   139

	static bool BuildCompanyHQ(TileIndex tile);

   140

   141

	/**

   142

	 * Return the location of a company's HQ.

   143

	 * @param company the company the get the HQ of.

   144

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY.

   145

	 * @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.

   146

	 */

   147

	static TileIndex GetCompanyHQ(CompanyIndex company);

   148

};

   149

   150

DECLARE_POSTFIX_INCREMENT(AICompany::CompanyIndex);

   151

   152

#endif /* AI_COMPANY_HPP */