1

/* $Id$ */

     2

     3

/** @file company_type.h Types related to companies. */

     4

     5

#ifndef COMPANY_TYPE_H

     6

#define COMPANY_TYPE_H

     7

     8

#include "core/enum_type.hpp"

     9

    10

/**

    11

 * Enum for all companies/owners.

    12

 */

    13

enum Owner {

    14

	/* All companies below MAX_COMPANIES are playable

    15

	 * companies, above, they are special, computer controlled 'companies' */

    16

	OWNER_BEGIN     = 0x00, ///< First owner

    17

	COMPANY_FIRST   = 0x00, ///< First company, same as owner

    18

	MAX_COMPANIES   = 0x08, ///< Maximum number of companies

    19

	OWNER_TOWN      = 0x0F, ///< A town owns the tile, or a town is expanding

    20

	OWNER_NONE      = 0x10, ///< The tile has no ownership

    21

	OWNER_WATER     = 0x11, ///< The tile/execution is done by "water"

    22

	OWNER_END,              ///< Last + 1 owner

    23

	INVALID_OWNER   = 0xFF, ///< An invalid owner

    24

	INVALID_COMPANY = 0xFF, ///< An invalid company

    25

    26

	/* 'Fake' companies used for networks */

    27

	COMPANY_INACTIVE_CLIENT = 253, ///< The client is joining

    28

	COMPANY_NEW_COMPANY     = 254, ///< The client wants a new company

    29

	COMPANY_SPECTATOR       = 255, ///< The client is spectating

    30

};

    31

DECLARE_POSTFIX_INCREMENT(Owner);

    32

    33

enum {

    34

	MAX_LENGTH_PRESIDENT_NAME_BYTES  =  31, ///< The maximum length of a president name in bytes including '\0'

    35

	MAX_LENGTH_PRESIDENT_NAME_PIXELS =  94, ///< The maximum length of a president name in pixels

    36

	MAX_LENGTH_COMPANY_NAME_BYTES    =  31, ///< The maximum length of a company name in bytes including '\0'

    37

	MAX_LENGTH_COMPANY_NAME_PIXELS   = 150, ///< The maximum length of a company name in pixels

    38

};

    39

    40

/** Define basic enum properties */

    41

template <> struct EnumPropsT<Owner> : MakeEnumPropsT<Owner, byte, OWNER_BEGIN, OWNER_END, INVALID_OWNER> {};

    42

typedef TinyEnumT<Owner> OwnerByte;

    43

    44

typedef Owner CompanyID;

    45

typedef OwnerByte CompanyByte;

    46

    47

typedef uint8 CompanyMask;

    48

    49

struct Company;

    50

typedef uint32 CompanyManagerFace; ///< Company manager face bits, info see in company_manager_face.h

    51

    52

#endif /* COMPANY_TYPE_H */