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

	 * Set the name of your company.

    17

	 * @param name the new name of the company.

    18

	 * @pre name != NULL

    19

	 * @return true if the command was send without problem.

    20

	 */

    21

	bool SetCompanyName(const char *name);

    22

    23

	/**

    24

	 * Get the name of your company.

    25

	 * @return the name of your company.

    26

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

    27

	 */

    28

	char *GetCompanyName();

    29

    30

	/**

    31

	 * Gets the current value of your company.

    32

	 * @return the current value of your company.

    33

	 */

    34

	int32 GetCompanyValue();

    35

    36

	/**

    37

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

    38

	 * @return the bank balance of your company.

    39

	 */

    40

	int32 GetBankBalance();

    41

    42

	/**

    43

	 * Gets the amount your company have loaned.

    44

	 * @return the amount loaned money.

    45

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

    46

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

    47

	 */

    48

	int32 GetLoanAmount();

    49

    50

	/**

    51

	 * Gets the maximum amount your company can loan.

    52

	 * @return the maximum amount your company can loan.

    53

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

    54

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

    55

	 */

    56

	int32 GetMaxLoanAmount();

    57

    58

	/**

    59

	 * Gets the interval/loan step.

    60

	 * @return the loan step.

    61

	 * @post return value is always positive.

    62

	 */

    63

	int32 GetLoanInterval();

    64

    65

	/**

    66

	 * Sets the amount to loan.

    67

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

    68

	 * @pre loan must be non-negative.

    69

	 * @pre GetLoanInterval must be a multiplier of loan.

    70

	 * @pre loan must be below GetMaxLoan().

    71

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

    72

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

    73

	 */

    74

	bool SetLoanAmount(int32 loan);

    75

};

    76

    77

#ifdef DEFINE_SQUIRREL_CLASS

    78

void SQAICompanyRegister(Squirrel *engine) {

    79

	DefSQClass <AICompany> SQAICompany("AICompany");

    80

	SQAICompany.PreRegister(engine);

    81

	SQAICompany.AddConstructor(engine);

    82

	SQAICompany.DefSQFunction(engine, &AICompany::SetCompanyName,   "SetCompanyName");

    83

	SQAICompany.DefSQFunction(engine, &AICompany::GetCompanyName,   "GetCompanyName");

    84

	SQAICompany.DefSQFunction(engine, &AICompany::GetCompanyValue,  "GetCompanyValue");

    85

	SQAICompany.DefSQFunction(engine, &AICompany::GetBankBalance,   "GetBankBalance");

    86

	SQAICompany.DefSQFunction(engine, &AICompany::GetLoanAmount,    "GetLoanAmount");

    87

	SQAICompany.DefSQFunction(engine, &AICompany::GetMaxLoanAmount, "GetMaxLoanAmount");

    88

	SQAICompany.DefSQFunction(engine, &AICompany::GetLoanInterval,  "GetLoanInterval");

    89

	SQAICompany.DefSQFunction(engine, &AICompany::SetLoanAmount,    "SetLoanAmount");

    90

	SQAICompany.PostRegister(engine);

    91

}

    93

    94

#endif /* AI_COMPANY_HPP */