OpenTTD Source: src/subsidy_base.h Source File

OpenTTD Source 12.2

subsidy_base.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 SUBSIDY_BASE_H
11 #define SUBSIDY_BASE_H
12
13 #include "cargo_type.h"
14 #include "company_type.h"
15 #include "subsidy_type.h"
16 #include "core/pool_type.hpp"
17
18 typedef Pool<Subsidy, SubsidyID, 1, 256> SubsidyPool;
19 extern SubsidyPool _subsidy_pool;
20
22 struct Subsidy : SubsidyPool::PoolItem<&_subsidy_pool> {
23 CargoID cargo_type;
24 uint16 remaining;
25 CompanyID awarded;
26 SourceType src_type;
27 SourceType dst_type;
28 SourceID src;
29 SourceID dst;
30
34 inline Subsidy() { }
35
39 inline ~Subsidy() { }
40
45 inline bool IsAwarded() const
46 {
47 return this->awarded != INVALID_COMPANY;
48 }
49
50 void AwardTo(CompanyID company);
51 };
52
54 static const uint SUBSIDY_OFFER_MONTHS = 12;
55 static const uint SUBSIDY_PAX_MIN_POPULATION = 400;
56 static const uint SUBSIDY_CARGO_MIN_POPULATION = 900;
57 static const uint SUBSIDY_MAX_PCT_TRANSPORTED = 42;
58 static const uint SUBSIDY_MAX_DISTANCE = 70;
59 static const uint SUBSIDY_TOWN_CARGO_RADIUS = 6;
60
62 enum class SubsidyDecodeParamType {
63 NewsOffered = 0,
64 NewsAwarded = 1,
65 NewsWithdrawn = 2,
66 Gui = 3,
67 };
68
69 #endif /* SUBSIDY_BASE_H */
Subsidy::remaining
uint16 remaining
Remaining months when this subsidy is valid.
Definition: subsidy_base.h:24
SubsidyDecodeParamType::NewsAwarded
@ NewsAwarded
News item for an awarded subsidy.
SUBSIDY_OFFER_MONTHS
static const uint SUBSIDY_OFFER_MONTHS
Constants related to subsidies.
Definition: subsidy_base.h:54
SUBSIDY_MAX_PCT_TRANSPORTED
static const uint SUBSIDY_MAX_PCT_TRANSPORTED
Subsidy will be created only for towns/industries with less % transported.
Definition: subsidy_base.h:57
SubsidyDecodeParamType::NewsOffered
@ NewsOffered
News item for an offered subsidy.
subsidy_type.h
Subsidy::IsAwarded
bool IsAwarded() const
Tests whether this subsidy has been awarded to someone.
Definition: subsidy_base.h:45
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Subsidy::Subsidy
Subsidy()
We need an (empty) constructor so struct isn't zeroed (as C++ standard states)
Definition: subsidy_base.h:34
SUBSIDY_CARGO_MIN_POPULATION
static const uint SUBSIDY_CARGO_MIN_POPULATION
Min. population of destination town for cargo route.
Definition: subsidy_base.h:56
Subsidy::cargo_type
CargoID cargo_type
Cargo type involved in this subsidy, CT_INVALID for invalid subsidy.
Definition: subsidy_base.h:23
Subsidy
Struct about subsidies, offered and awarded.
Definition: subsidy_base.h:22
SUBSIDY_TOWN_CARGO_RADIUS
static const uint SUBSIDY_TOWN_CARGO_RADIUS
Extent of a tile area around town center when scanning for town cargo acceptance and production (6 ~=...
Definition: subsidy_base.h:59
SourceID
uint16 SourceID
Contains either industry ID, town ID or company ID (or INVALID_SOURCE)
Definition: cargo_type.h:153
cargo_type.h
Subsidy::src
SourceID src
Index of source. Either TownID or IndustryID.
Definition: subsidy_base.h:28
Subsidy::dst
SourceID dst
Index of destination. Either TownID or IndustryID.
Definition: subsidy_base.h:29
SubsidyDecodeParamType::Gui
@ Gui
Subsidies listed in the Subsidy GUI.
SubsidyDecodeParamType::NewsWithdrawn
@ NewsWithdrawn
News item for a subsidy offer withdrawn, or expired subsidy.
Subsidy::dst_type
SourceType dst_type
Destination of subsidised path (ST_INDUSTRY or ST_TOWN)
Definition: subsidy_base.h:27
SourceType
SourceType
Types of cargo source and destination.
Definition: cargo_type.h:147
Pool
Base class for all pools.
Definition: pool_type.hpp:81
SUBSIDY_MAX_DISTANCE
static const uint SUBSIDY_MAX_DISTANCE
Max. length of subsidised route (DistanceManhattan)
Definition: subsidy_base.h:58
_subsidy_pool
SubsidyPool _subsidy_pool
Pool for the subsidies.
Subsidy::~Subsidy
~Subsidy()
(Empty) destructor has to be defined else operator delete might be called with nullptr parameter
Definition: subsidy_base.h:39
Subsidy::AwardTo
void AwardTo(CompanyID company)
Marks subsidy as awarded, creates news and AI event.
Definition: subsidy.cpp:39
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
INVALID_COMPANY
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
SubsidyDecodeParamType
SubsidyDecodeParamType
Types of subsidy news messages, which determine how the date is printed and whether to use singular o...
Definition: subsidy_base.h:62
pool_type.hpp
Subsidy::src_type
SourceType src_type
Source of subsidised path (ST_INDUSTRY or ST_TOWN)
Definition: subsidy_base.h:26
Pool::PoolItem
Base class for all PoolItems.
Definition: pool_type.hpp:234
Subsidy::awarded
CompanyID awarded
Subsidy is awarded to this company; INVALID_COMPANY if it's not awarded to anyone.
Definition: subsidy_base.h:25
company_type.h
SUBSIDY_PAX_MIN_POPULATION
static const uint SUBSIDY_PAX_MIN_POPULATION
Min. population of towns for subsidised pax route.
Definition: subsidy_base.h:55