company_type.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef COMPANY_TYPE_H
#define COMPANY_TYPE_H
 
#include "core/enum_type.hpp"
#include "core/pool_type.hpp"
 
using CompanyID = PoolID<uint8_t, struct CompanyIDTag, 0xF, 0xFF>;
 
/* 'Fake' companies used for networks */
static constexpr CompanyID COMPANY_INACTIVE_CLIENT{253}; 
static constexpr CompanyID COMPANY_NEW_COMPANY{254}; 
static constexpr CompanyID COMPANY_SPECTATOR{255}; 
 
using Owner = CompanyID;
static constexpr Owner OWNER_BEGIN = Owner::Begin(); 
static constexpr Owner OWNER_TOWN{0x0F}; 
static constexpr Owner OWNER_NONE{0x10}; 
static constexpr Owner OWNER_WATER{0x11}; 
static constexpr Owner OWNER_DEITY{0x12}; 
static constexpr Owner OWNER_END{0x13}; 
static constexpr Owner INVALID_OWNER = Owner::Invalid(); 
 
static const uint8_t MAX_COMPANIES = CompanyID::End().base();
static const uint MAX_LENGTH_PRESIDENT_NAME_CHARS = 32; 
static const uint MAX_LENGTH_COMPANY_NAME_CHARS   = 32; 
 
static const uint MAX_HISTORY_QUARTERS            = 24; 
 
static const uint MIN_COMPETITORS_INTERVAL = 0;   
static const uint MAX_COMPETITORS_INTERVAL = 500; 
 
typedef Owner CompanyID;
 
class CompanyMask : public BaseBitSet<CompanyMask, CompanyID, uint16_t> {
public:
  constexpr CompanyMask() : BaseBitSet<CompanyMask, CompanyID, uint16_t>() {}
  static constexpr size_t DecayValueType(CompanyID value) { return value.base(); }
 
  constexpr auto operator <=>(const CompanyMask &) const noexcept = default;
};
 
struct Company;
typedef uint32_t CompanyManagerFace; 
 
enum CompanyRemoveReason : uint8_t {
  CRR_MANUAL,    
  CRR_AUTOCLEAN, 
  CRR_BANKRUPT,  
 
  CRR_END,       
 
  CRR_NONE = CRR_MANUAL, 
};
 
enum CompanyCtrlAction : uint8_t {
  CCA_NEW,    
  CCA_NEW_AI, 
  CCA_DELETE, 
 
  CCA_END,    
};
 
enum CompanyAllowListCtrlAction : uint8_t {
  CALCA_ADD, 
  CALCA_REMOVE, 
 
  CALCA_END,    
};
 
#endif /* COMPANY_TYPE_H */