OpenTTD Source  20241120-master-g6d3adc6169
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 : uint8_t {
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,
29  INVALID_OWNER = 0xFF,
30  INVALID_COMPANY = 0xFF,
31 
32  /* 'Fake' companies used for networks */
36 };
39 
40 static const uint MAX_LENGTH_PRESIDENT_NAME_CHARS = 32;
41 static const uint MAX_LENGTH_COMPANY_NAME_CHARS = 32;
42 
43 static const uint MAX_HISTORY_QUARTERS = 24;
44 
45 static const uint MIN_COMPETITORS_INTERVAL = 0;
46 static const uint MAX_COMPETITORS_INTERVAL = 500;
47 
48 typedef Owner CompanyID;
49 
50 typedef uint16_t CompanyMask;
51 
52 struct Company;
53 typedef uint32_t CompanyManagerFace;
54 
56 enum CompanyRemoveReason : uint8_t {
60 
62 
64 };
65 
67 enum CompanyCtrlAction : uint8_t {
71 
73 };
74 
79 
81 };
82 
83 #endif /* COMPANY_TYPE_H */
static const uint MAX_LENGTH_PRESIDENT_NAME_CHARS
The maximum length of a president name in characters including '\0'.
Definition: company_type.h:40
static const uint MAX_LENGTH_COMPANY_NAME_CHARS
The maximum length of a company name in characters including '\0'.
Definition: company_type.h:41
CompanyCtrlAction
The action to do with CMD_COMPANY_CTRL.
Definition: company_type.h:67
@ CCA_NEW_AI
Create a new AI company.
Definition: company_type.h:69
@ CCA_DELETE
Delete a company.
Definition: company_type.h:70
@ CCA_NEW
Create a new company.
Definition: company_type.h:68
@ CCA_END
Sentinel for end.
Definition: company_type.h:72
CompanyAllowListCtrlAction
The action to do with CMD_COMPANY_ALLOW_LIST_CTRL.
Definition: company_type.h:76
@ CALCA_END
Sentinel for end.
Definition: company_type.h:80
@ CALCA_REMOVE
Remove a public key.
Definition: company_type.h:78
@ CALCA_ADD
Create a public key.
Definition: company_type.h:77
static const uint MAX_HISTORY_QUARTERS
The maximum number of quarters kept as performance's history.
Definition: company_type.h:43
uint32_t CompanyManagerFace
Company manager face bits, info see in company_manager_face.h.
Definition: company_type.h:52
static const uint MIN_COMPETITORS_INTERVAL
The minimum interval (in minutes) between competitors.
Definition: company_type.h:45
Owner
Enum for all companies/owners.
Definition: company_type.h:18
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
@ INVALID_OWNER
An invalid owner.
Definition: company_type.h:29
@ OWNER_END
Last + 1 owner.
Definition: company_type.h:28
@ COMPANY_SPECTATOR
The client is spectating.
Definition: company_type.h:35
@ COMPANY_INACTIVE_CLIENT
The client is joining.
Definition: company_type.h:33
@ COMPANY_FIRST
First company, same as owner.
Definition: company_type.h:22
@ OWNER_DEITY
The object is owned by a superuser / goal script.
Definition: company_type.h:27
@ OWNER_BEGIN
First owner.
Definition: company_type.h:21
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
@ OWNER_WATER
The tile/execution is done by "water".
Definition: company_type.h:26
@ COMPANY_NEW_COMPANY
The client wants a new company.
Definition: company_type.h:34
@ OWNER_TOWN
A town owns the tile, or a town is expanding.
Definition: company_type.h:24
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
CompanyRemoveReason
The reason why the company was removed.
Definition: company_type.h:56
@ CRR_BANKRUPT
The company went belly-up.
Definition: company_type.h:59
@ CRR_END
Sentinel for end.
Definition: company_type.h:61
@ CRR_AUTOCLEAN
The company is removed due to autoclean.
Definition: company_type.h:58
@ CRR_NONE
Dummy reason for actions that don't need one.
Definition: company_type.h:63
@ CRR_MANUAL
The company is manually removed.
Definition: company_type.h:57
static const uint MAX_COMPETITORS_INTERVAL
The maximum interval (in minutes) between competitors.
Definition: company_type.h:46
Type (helpers) for enums.
#define DECLARE_POSTFIX_INCREMENT(enum_type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:18
#define DECLARE_ENUM_AS_ADDABLE(EnumType)
Operator that allows this enumeration to be added to any other enumeration.
Definition: enum_type.hpp:45