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

    17

	/** Different constants related to CompanyIndex. */

    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.

    22

		INVALID_COMPANY = 9, //!< An invalid company.

    23

	};

    24

    25

	/**

    26

	 * Resolved the given company index to the correct index for the company. If

    27

	 *  the company index was MY_COMPANY it will be resolved to the index of

    28

	 *  your company. If the company with the given index does not exist it will

    29

	 *  return INVALID_COMPANY.

    30

	 * @param company The company index to resolve.

    31

	 * @return The resolved company index.

    32

	 */

    33

	static CompanyIndex ResolveCompanyIndex(CompanyIndex company);

    34

    35

	/**

    36

	 * Set the name of your company.

    37

	 * @param name The new name of the company.

    38

	 * @pre 'name' must have at least one character.

    39

	 * @exception AIError::ERR_NAME_IS_NOT_UNIQUE

    40

	 * @return True if the name was changed.

    41

	 */

    42

	static bool SetCompanyName(const char *name);

    43

    44

	/**

    45

	 * Get the name of the given company.

    46

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

    47

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

    48

	 * @return The name of the given company.

    49

	 */

    50

	static char *GetCompanyName(CompanyIndex company);

    51

    52

	/**

    53

	 * Set the name of your president.

    54

	 * @param name The new name of the president.

    55

	 * @pre 'name' must have at least one character.

    56

	 * @exception AIError::ERR_NAME_IS_NOT_UNIQUE

    57

	 * @return True if the name was changed.

    58

	 */

    59

	static bool SetPresidentName(const char *name);

    60

    61

	/**

    62

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

    63

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

    64

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

    65

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

    66

	 */

    67

	static char *GetPresidentName(CompanyIndex company);

    68

    69

	/**

    70

	 * Sets the amount to loan.

    71

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

    72

	 * @pre 'loan' must be non-negative.

    73

	 * @pre GetLoanInterval() must be a multiplier of GetLoanInterval().

    74

	 * @pre 'loan' must be below GetMaxLoanAmount().

    75

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

    76

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

    77

	 */

    78

	static bool SetLoanAmount(int32 loan);

    79

    80

	/**

    81

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

    82

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

    83

	 * @pre 'loan' must be non-negative.

    84

	 * @pre 'loan' must be below GetMaxLoanAmount().

    85

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

    86

	 */

    87

	static bool SetMinimumLoanAmount(int32 loan);

    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 Money 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 Money GetMaxLoanAmount();

   104

   105

	/**

   106

	 * Gets the interval/loan step.

   107

	 * @return The loan step.

   108

	 * @post Return value is always positive.

   109

	 */

   110

	static Money GetLoanInterval();

   111

   112

	/**

   113

	 * Gets the current value of the given company.

   114

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

   115

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

   116

	 * @return The current value of the given company.

   117

	 */

   118

	static Money GetCompanyValue(CompanyIndex company);

   119

   120

	/**

   121

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

   122

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

   123

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY

   124

	 * @return The actual bank balance.

   125

	 */

   126

	static Money GetBankBalance(CompanyIndex company);

   127

   128

	/**

   129

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

   130

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

   131

	 * @pre AIMap::IsValidTile(tile).

   132

	 * @exception AIError::ERR_AREA_NOT_CLEAR

   133

	 * @exception AIError::ERR_FLAT_LAND_REQUIRED

   134

	 * @return True if the HQ could be build.

   135

	 * @note An HQ can not be removed, only by water or rebuilding; If an HQ is

   136

	 *  build again, the old one is removed.

   137

	 */

   138

	static bool BuildCompanyHQ(TileIndex tile);

   139

   140

	/**

   141

	 * Return the location of a company's HQ.

   142

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

   143

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY.

   144

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

   145

	 */

   146

	static TileIndex GetCompanyHQ(CompanyIndex company);

   147

   148

	/**

   149

	 * Set whether autorenew is enabled for your company.

   150

	 * @param autorenew The new autorenew status.

   151

	 * @return True if autorenew status has been modified.

   152

	 */

   153

	static bool SetAutoRenewStatus(bool autorenew);

   154

   155

	/**

   156

	 * Return whether autorenew is enabled for a company.

   157

	 * @param company The company to get the autorenew status of.

   158

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY.

   159

	 * @return True if autorenew is enabled.

   160

	 */

   161

	static bool GetAutoRenewStatus(CompanyIndex company);

   162

   163

	/**

   164

	 * Set the number of months before/after max age to autorenew an engine for your company.

   165

	 * @param months The new months between autorenew.

   166

	 * @return True if autorenew months has been modified.

   167

	 */

   168

	static bool SetAutoRenewMonths(int16 months);

   169

   170

	/**

   171

	 * Return the number of months before/after max age to autorenew an engine for a company.

   172

	 * @param company The company to get the autorenew months of.

   173

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY.

   174

	 * @return The months before/after max age of engine.

   175

	 */

   176

	static int16 GetAutoRenewMonths(CompanyIndex company);

   177

   178

	/**

   179

	 * Set the minimum money needed to autorenew an engine for your company.

   180

	 * @param money The new minimum required money for autorenew to work.

   181

	 * @return True if autorenew money has been modified.

   182

	 */

   183

	static bool SetAutoRenewMoney(uint32 money);

   184

   185

	/**

   186

	 * Return the minimum money needed to autorenew an engine for a company.

   187

	 * @param company The company to get the autorenew money of.

   188

	 * @pre ResolveCompanyIndex(company) != INVALID_COMPANY.

   189

	 * @return The minimum required money for autorenew to work.

   190

	 */

   191

	static uint32 GetAutoRenewMoney(CompanyIndex company);

   192

};

   193

   194

DECLARE_POSTFIX_INCREMENT(AICompany::CompanyIndex);

   195

   196

#endif /* AI_COMPANY_HPP */