OpenTTD Source: src/subsidy_func.h Source File

OpenTTD Source 13.2.1

subsidy_func.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_FUNC_H
11 #define SUBSIDY_FUNC_H
12
13 #include "core/geometry_type.hpp"
14 #include "station_type.h"
15 #include "company_type.h"
16 #include "cargo_type.h"
17 #include "news_type.h"
18 #include "subsidy_base.h"
19
20 std::pair<NewsReferenceType, NewsReferenceType> SetupSubsidyDecodeParam(const struct Subsidy *s, SubsidyDecodeParamType mode, uint parameter_offset = 0);
21 void DeleteSubsidyWith(SourceType type, SourceID index);
22 bool CheckSubsidised(CargoID cargo_type, CompanyID company, SourceType src_type, SourceID src, const Station *st);
23 void RebuildSubsidisedSourceAndDestinationCache();
24
25 #endif /* SUBSIDY_FUNC_H */
Station
Station data structure.
Definition: station_base.h:454
RebuildSubsidisedSourceAndDestinationCache
void RebuildSubsidisedSourceAndDestinationCache()
Perform a full rebuild of the subsidies cache.
Definition: subsidy.cpp:132
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
SetupSubsidyDecodeParam
std::pair< NewsReferenceType, NewsReferenceType > SetupSubsidyDecodeParam(const Subsidy *s, SubsidyDecodeParamType mode, uint parameter_offset)
Setup the string parameters for printing the subsidy at the screen, and compute the news reference fo...
Definition: subsidy.cpp:73
geometry_type.hpp
Subsidy
Struct about subsidies, offered and awarded.
Definition: subsidy_base.h:22
SourceID
uint16 SourceID
Contains either industry ID, town ID or company ID (or INVALID_SOURCE)
Definition: cargo_type.h:153
cargo_type.h
SourceType
SourceType
Types of cargo source and destination.
Definition: cargo_type.h:147
DeleteSubsidyWith
void DeleteSubsidyWith(SourceType type, SourceID index)
Delete the subsidies associated with a given cargo source type and id.
Definition: subsidy.cpp:149
CheckSubsidised
bool CheckSubsidised(CargoID cargo_type, CompanyID company, SourceType src_type, SourceID src, const Station *st)
Tests whether given delivery is subsidised and possibly awards the subsidy to delivering company.
Definition: subsidy.cpp:561
news_type.h
subsidy_base.h
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
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
company_type.h
station_type.h