OpenTTD Source: src/company_type.h Source File

OpenTTD Source 13.1

company_type.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef COMPANY_TYPE_H
11 #define COMPANY_TYPE_H
12
13 #include "core/enum_type.hpp"
14
18 enum Owner : byte {
19 /* All companies below MAX_COMPANIES are playable
20 * companies, above, they are special, computer controlled 'companies' */
21 OWNER_BEGIN = 0x00,
22 COMPANY_FIRST = 0x00,
23 MAX_COMPANIES = 0x0F,
24 OWNER_TOWN = 0x0F,
25 OWNER_NONE = 0x10,
26 OWNER_WATER = 0x11,
27 OWNER_DEITY = 0x12,
28 OWNER_END,
29 INVALID_OWNER = 0xFF,
30 INVALID_COMPANY = 0xFF,
31
32 /* 'Fake' companies used for networks */
33 COMPANY_INACTIVE_CLIENT = 253,
34 COMPANY_NEW_COMPANY = 254,
35 COMPANY_SPECTATOR = 255,
36 };
37 DECLARE_POSTFIX_INCREMENT(Owner)
38
39 static const uint MAX_LENGTH_PRESIDENT_NAME_CHARS = 32;
40 static const uint MAX_LENGTH_COMPANY_NAME_CHARS = 32;
41
42 static const uint MAX_HISTORY_QUARTERS = 24;
43 static const uint MAX_COMPANY_SHARE_OWNERS = 4;
44
46 template <> struct EnumPropsT<Owner> : MakeEnumPropsT<Owner, byte, OWNER_BEGIN, OWNER_END, INVALID_OWNER> {};
47
48 typedef Owner CompanyID;
49
50 typedef uint16 CompanyMask;
51
52 struct Company;
53 typedef uint32 CompanyManagerFace;
54
56 enum CompanyRemoveReason : uint8 {
57 CRR_MANUAL,
58 CRR_AUTOCLEAN,
59 CRR_BANKRUPT,
60
61 CRR_END,
62
63 CRR_NONE = CRR_MANUAL,
64 };
65
67 enum CompanyCtrlAction : uint8 {
68 CCA_NEW,
69 CCA_NEW_AI,
70 CCA_DELETE,
71
72 CCA_END,
73 };
74
75 #endif /* COMPANY_TYPE_H */
CompanyCtrlAction
CompanyCtrlAction
The action to do with CMD_COMPANY_CTRL.
Definition: company_type.h:67
CRR_NONE
@ CRR_NONE
Dummy reason for actions that don't need one.
Definition: company_type.h:63
CompanyManagerFace
uint32 CompanyManagerFace
Company manager face bits, info see in company_manager_face.h.
Definition: company_type.h:52
CCA_DELETE
@ CCA_DELETE
Delete a company.
Definition: company_type.h:70
CRR_BANKRUPT
@ CRR_BANKRUPT
The company went belly-up.
Definition: company_type.h:59
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
MAX_LENGTH_COMPANY_NAME_CHARS
static const uint MAX_LENGTH_COMPANY_NAME_CHARS
The maximum length of a company name in characters including '\0'.
Definition: company_type.h:40
COMPANY_FIRST
@ COMPANY_FIRST
First company, same as owner.
Definition: company_type.h:22
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:14
EnumPropsT
Informative template class exposing basic enumeration properties used by several other templates belo...
Definition: enum_type.hpp:48
COMPANY_NEW_COMPANY
@ COMPANY_NEW_COMPANY
The client wants a new company.
Definition: company_type.h:34
MAX_LENGTH_PRESIDENT_NAME_CHARS
static const uint MAX_LENGTH_PRESIDENT_NAME_CHARS
The maximum length of a president name in characters including '\0'.
Definition: company_type.h:39
INVALID_OWNER
@ INVALID_OWNER
An invalid owner.
Definition: company_type.h:29
OWNER_BEGIN
@ OWNER_BEGIN
First owner.
Definition: company_type.h:21
MAX_COMPANIES
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
CCA_END
@ CCA_END
Sentinel for end.
Definition: company_type.h:72
COMPANY_INACTIVE_CLIENT
@ COMPANY_INACTIVE_CLIENT
The client is joining.
Definition: company_type.h:33
MAX_HISTORY_QUARTERS
static const uint MAX_HISTORY_QUARTERS
The maximum number of quarters kept as performance's history.
Definition: company_type.h:42
CRR_MANUAL
@ CRR_MANUAL
The company is manually removed.
Definition: company_type.h:57
CCA_NEW_AI
@ CCA_NEW_AI
Create a new AI company.
Definition: company_type.h:69
COMPANY_SPECTATOR
@ COMPANY_SPECTATOR
The client is spectating.
Definition: company_type.h:35
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
OWNER_DEITY
@ OWNER_DEITY
The object is owned by a superuser / goal script.
Definition: company_type.h:27
CRR_AUTOCLEAN
@ CRR_AUTOCLEAN
The company is removed due to autoclean.
Definition: company_type.h:58
enum_type.hpp
MakeEnumPropsT
Helper template class that makes basic properties of given enumeration type visible from outsize.
Definition: enum_type.hpp:62
INVALID_COMPANY
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
OWNER_END
@ OWNER_END
Last + 1 owner.
Definition: company_type.h:28
CRR_END
@ CRR_END
Sentinel for end.
Definition: company_type.h:61
MAX_COMPANY_SHARE_OWNERS
static const uint MAX_COMPANY_SHARE_OWNERS
The maximum number of shares of a company that can be owned by another company.
Definition: company_type.h:43
CCA_NEW
@ CCA_NEW
Create a new company.
Definition: company_type.h:68
Company
Definition: company_base.h:117
OWNER_WATER
@ OWNER_WATER
The tile/execution is done by "water".
Definition: company_type.h:26
CompanyRemoveReason
CompanyRemoveReason
The reason why the company was removed.
Definition: company_type.h:56
OWNER_TOWN
@ OWNER_TOWN
A town owns the tile, or a town is expanding.
Definition: company_type.h:24