OpenTTD Source: src/subsidy.cpp Source File

OpenTTD Source 13.1

subsidy.cpp
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 #include "stdafx.h"
11 #include "company_func.h"
12 #include "industry.h"
13 #include "town.h"
14 #include "news_func.h"
15 #include "ai/ai.hpp"
16 #include "station_base.h"
17 #include "strings_func.h"
18 #include "window_func.h"
19 #include "subsidy_base.h"
20 #include "subsidy_func.h"
21 #include "core/pool_func.hpp"
22 #include "core/random_func.hpp"
23 #include "game/game.hpp"
24 #include "command_func.h"
25 #include "string_func.h"
26 #include "tile_cmd.h"
27 #include "subsidy_cmd.h"
28
29 #include "table/strings.h"
30
31 #include "safeguards.h"
32
33 SubsidyPool _subsidy_pool("Subsidy");
34 INSTANTIATE_POOL_METHODS(Subsidy)
35
36
40 void Subsidy::AwardTo(CompanyID company)
41 {
42 assert(!this->IsAwarded());
43
44 this->awarded = company;
45 this->remaining = _settings_game.difficulty.subsidy_duration * MONTHS_IN_YEAR;
46
47 SetDParam(0, company);
48 NewsStringData *company_name = new NewsStringData(GetString(STR_COMPANY_NAME));
49
50 /* Add a news item */
51 std::pair<NewsReferenceType, NewsReferenceType> reftype = SetupSubsidyDecodeParam(this, SubsidyDecodeParamType::NewsAwarded, 1);
52
53 SetDParamStr(0, company_name->string);
54 AddNewsItem(
55 STR_NEWS_SERVICE_SUBSIDY_AWARDED_HALF + _settings_game.difficulty.subsidy_multiplier,
56 NT_SUBSIDIES, NF_NORMAL,
57 reftype.first, this->src, reftype.second, this->dst,
58 company_name
59 );
60 AI::BroadcastNewEvent(new ScriptEventSubsidyAwarded(this->index));
61 Game::NewEvent(new ScriptEventSubsidyAwarded(this->index));
62
63 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
64 }
65
73 std::pair<NewsReferenceType, NewsReferenceType> SetupSubsidyDecodeParam(const Subsidy *s, SubsidyDecodeParamType mode, uint parameter_offset)
74 {
75 NewsReferenceType reftype1 = NR_NONE;
76 NewsReferenceType reftype2 = NR_NONE;
77
78 /* Always use the plural form of the cargo name - trying to decide between plural or singular causes issues for translations */
79 const CargoSpec *cs = CargoSpec::Get(s->cargo_type);
80 SetDParam(parameter_offset, cs->name);
81
82 switch (s->src_type) {
83 case ST_INDUSTRY:
84 reftype1 = NR_INDUSTRY;
85 SetDParam(parameter_offset + 1, STR_INDUSTRY_NAME);
86 break;
87 case ST_TOWN:
88 reftype1 = NR_TOWN;
89 SetDParam(parameter_offset + 1, STR_TOWN_NAME);
90 break;
91 default: NOT_REACHED();
92 }
93 SetDParam(parameter_offset + 2, s->src);
94
95 switch (s->dst_type) {
96 case ST_INDUSTRY:
97 reftype2 = NR_INDUSTRY;
98 SetDParam(parameter_offset + 4, STR_INDUSTRY_NAME);
99 break;
100 case ST_TOWN:
101 reftype2 = NR_TOWN;
102 SetDParam(parameter_offset + 4, STR_TOWN_NAME);
103 break;
104 default: NOT_REACHED();
105 }
106 SetDParam(parameter_offset + 5, s->dst);
107
108 /* If the subsidy is being offered or awarded, the news item mentions the subsidy duration. */
109 if (mode == SubsidyDecodeParamType::NewsOffered || mode == SubsidyDecodeParamType::NewsAwarded) {
110 SetDParam(parameter_offset + 7, _settings_game.difficulty.subsidy_duration);
111 }
112
113 return std::pair<NewsReferenceType, NewsReferenceType>(reftype1, reftype2);
114 }
115
122 static inline void SetPartOfSubsidyFlag(SourceType type, SourceID index, PartOfSubsidy flag)
123 {
124 switch (type) {
125 case ST_INDUSTRY: Industry::Get(index)->part_of_subsidy |= flag; return;
126 case ST_TOWN: Town::Get(index)->cache.part_of_subsidy |= flag; return;
127 default: NOT_REACHED();
128 }
129 }
130
132 void RebuildSubsidisedSourceAndDestinationCache()
133 {
134 for (Town *t : Town::Iterate()) t->cache.part_of_subsidy = POS_NONE;
135
136 for (Industry *i : Industry::Iterate()) i->part_of_subsidy = POS_NONE;
137
138 for (const Subsidy *s : Subsidy::Iterate()) {
139 SetPartOfSubsidyFlag(s->src_type, s->src, POS_SRC);
140 SetPartOfSubsidyFlag(s->dst_type, s->dst, POS_DST);
141 }
142 }
143
149 void DeleteSubsidyWith(SourceType type, SourceID index)
150 {
151 bool dirty = false;
152
153 for (Subsidy *s : Subsidy::Iterate()) {
154 if ((s->src_type == type && s->src == index) || (s->dst_type == type && s->dst == index)) {
155 delete s;
156 dirty = true;
157 }
158 }
159
160 if (dirty) {
161 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
162 RebuildSubsidisedSourceAndDestinationCache();
163 }
164 }
165
175 static bool CheckSubsidyDuplicate(CargoID cargo, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
176 {
177 for (const Subsidy *s : Subsidy::Iterate()) {
178 if (s->cargo_type == cargo &&
179 s->src_type == src_type && s->src == src &&
180 s->dst_type == dst_type && s->dst == dst) {
181 return true;
182 }
183 }
184 return false;
185 }
186
195 static bool CheckSubsidyDistance(SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
196 {
197 TileIndex tile_src = (src_type == ST_TOWN) ? Town::Get(src)->xy : Industry::Get(src)->location.tile;
198 TileIndex tile_dst = (dst_type == ST_TOWN) ? Town::Get(dst)->xy : Industry::Get(dst)->location.tile;
199
200 return (DistanceManhattan(tile_src, tile_dst) <= SUBSIDY_MAX_DISTANCE);
201 }
202
211 void CreateSubsidy(CargoID cid, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
212 {
213 Subsidy *s = new Subsidy();
214 s->cargo_type = cid;
215 s->src_type = src_type;
216 s->src = src;
217 s->dst_type = dst_type;
218 s->dst = dst;
219 s->remaining = SUBSIDY_OFFER_MONTHS;
220 s->awarded = INVALID_COMPANY;
221
222 std::pair<NewsReferenceType, NewsReferenceType> reftype = SetupSubsidyDecodeParam(s, SubsidyDecodeParamType::NewsOffered);
223 AddNewsItem(STR_NEWS_SERVICE_SUBSIDY_OFFERED, NT_SUBSIDIES, NF_NORMAL, reftype.first, s->src, reftype.second, s->dst);
224 SetPartOfSubsidyFlag(s->src_type, s->src, POS_SRC);
225 SetPartOfSubsidyFlag(s->dst_type, s->dst, POS_DST);
226 AI::BroadcastNewEvent(new ScriptEventSubsidyOffer(s->index));
227 Game::NewEvent(new ScriptEventSubsidyOffer(s->index));
228
229 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
230 }
231
242 CommandCost CmdCreateSubsidy(DoCommandFlag flags, CargoID cid, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
243 {
244 if (!Subsidy::CanAllocateItem()) return CMD_ERROR;
245
246 if (_current_company != OWNER_DEITY) return CMD_ERROR;
247
248 if (cid >= NUM_CARGO || !::CargoSpec::Get(cid)->IsValid()) return CMD_ERROR;
249
250 switch (src_type) {
251 case ST_TOWN:
252 if (!Town::IsValidID(src)) return CMD_ERROR;
253 break;
254 case ST_INDUSTRY:
255 if (!Industry::IsValidID(src)) return CMD_ERROR;
256 break;
257 default:
258 return CMD_ERROR;
259 }
260 switch (dst_type) {
261 case ST_TOWN:
262 if (!Town::IsValidID(dst)) return CMD_ERROR;
263 break;
264 case ST_INDUSTRY:
265 if (!Industry::IsValidID(dst)) return CMD_ERROR;
266 break;
267 default:
268 return CMD_ERROR;
269 }
270
271 if (flags & DC_EXEC) {
272 CreateSubsidy(cid, src_type, src, dst_type, dst);
273 }
274
275 return CommandCost();
276 }
277
282 bool FindSubsidyPassengerRoute()
283 {
284 if (!Subsidy::CanAllocateItem()) return false;
285
286 const Town *src = Town::GetRandom();
287 if (src->cache.population < SUBSIDY_PAX_MIN_POPULATION ||
288 src->GetPercentTransported(CT_PASSENGERS) > SUBSIDY_MAX_PCT_TRANSPORTED) {
289 return false;
290 }
291
292 const Town *dst = Town::GetRandom();
293 if (dst->cache.population < SUBSIDY_PAX_MIN_POPULATION || src == dst) {
294 return false;
295 }
296
297 if (DistanceManhattan(src->xy, dst->xy) > SUBSIDY_MAX_DISTANCE) return false;
298 if (CheckSubsidyDuplicate(CT_PASSENGERS, ST_TOWN, src->index, ST_TOWN, dst->index)) return false;
299
300 CreateSubsidy(CT_PASSENGERS, ST_TOWN, src->index, ST_TOWN, dst->index);
301
302 return true;
303 }
304
305 bool FindSubsidyCargoDestination(CargoID cid, SourceType src_type, SourceID src);
306
307
312 bool FindSubsidyTownCargoRoute()
313 {
314 if (!Subsidy::CanAllocateItem()) return false;
315
316 SourceType src_type = ST_TOWN;
317
318 /* Select a random town. */
319 const Town *src_town = Town::GetRandom();
320 if (src_town->cache.population < SUBSIDY_CARGO_MIN_POPULATION) return false;
321
322 /* Calculate the produced cargo of houses around town center. */
323 CargoArray town_cargo_produced;
324 TileArea ta = TileArea(src_town->xy, 1, 1).Expand(SUBSIDY_TOWN_CARGO_RADIUS);
325 for (TileIndex tile : ta) {
326 if (IsTileType(tile, MP_HOUSE)) {
327 AddProducedCargo(tile, town_cargo_produced);
328 }
329 }
330
331 /* Passenger subsidies are not handled here. */
332 town_cargo_produced[CT_PASSENGERS] = 0;
333
334 uint8 cargo_count = 0;
335 for (CargoID i = 0; i < NUM_CARGO; i++) {
336 if (town_cargo_produced[i] > 0) cargo_count++;
337 }
338
339 /* No cargo produced at all? */
340 if (cargo_count == 0) return false;
341
342 /* Choose a random cargo that is produced in the town. */
343 uint8 cargo_number = RandomRange(cargo_count);
344 CargoID cid;
345 for (cid = 0; cid < NUM_CARGO; cid++) {
346 if (town_cargo_produced[cid] > 0) {
347 if (cargo_number == 0) break;
348 cargo_number--;
349 }
350 }
351
352 /* Avoid using invalid NewGRF cargoes. */
353 if (!CargoSpec::Get(cid)->IsValid() ||
354 _settings_game.linkgraph.GetDistributionType(cid) != DT_MANUAL) {
355 return false;
356 }
357
358 /* Quit if the percentage transported is large enough. */
359 if (src_town->GetPercentTransported(cid) > SUBSIDY_MAX_PCT_TRANSPORTED) return false;
360
361 SourceID src = src_town->index;
362
363 return FindSubsidyCargoDestination(cid, src_type, src);
364 }
365
370 bool FindSubsidyIndustryCargoRoute()
371 {
372 if (!Subsidy::CanAllocateItem()) return false;
373
374 SourceType src_type = ST_INDUSTRY;
375
376 /* Select a random industry. */
377 const Industry *src_ind = Industry::GetRandom();
378 if (src_ind == nullptr) return false;
379
380 uint trans, total;
381
382 CargoID cid;
383
384 /* Randomize cargo type */
385 int num_cargos = 0;
386 uint cargo_index;
387 for (cargo_index = 0; cargo_index < lengthof(src_ind->produced_cargo); cargo_index++) {
388 if (src_ind->produced_cargo[cargo_index] != CT_INVALID) num_cargos++;
389 }
390 if (num_cargos == 0) return false; // industry produces nothing
391 int cargo_num = RandomRange(num_cargos) + 1;
392 for (cargo_index = 0; cargo_index < lengthof(src_ind->produced_cargo); cargo_index++) {
393 if (src_ind->produced_cargo[cargo_index] != CT_INVALID) cargo_num--;
394 if (cargo_num == 0) break;
395 }
396 assert(cargo_num == 0); // indicates loop didn't break as intended
397 cid = src_ind->produced_cargo[cargo_index];
398 trans = src_ind->last_month_pct_transported[cargo_index];
399 total = src_ind->last_month_production[cargo_index];
400
401 /* Quit if no production in this industry
402 * or if the pct transported is already large enough
403 * or if the cargo is automatically distributed */
404 if (total == 0 || trans > SUBSIDY_MAX_PCT_TRANSPORTED ||
405 cid == CT_INVALID ||
406 _settings_game.linkgraph.GetDistributionType(cid) != DT_MANUAL) {
407 return false;
408 }
409
410 SourceID src = src_ind->index;
411
412 return FindSubsidyCargoDestination(cid, src_type, src);
413 }
414
422 bool FindSubsidyCargoDestination(CargoID cid, SourceType src_type, SourceID src)
423 {
424 /* Choose a random destination. */
425 SourceType dst_type = Chance16(1, 2) ? ST_TOWN : ST_INDUSTRY;
426
427 SourceID dst;
428 switch (dst_type) {
429 case ST_TOWN: {
430 /* Select a random town. */
431 const Town *dst_town = Town::GetRandom();
432
433 /* Calculate cargo acceptance of houses around town center. */
434 CargoArray town_cargo_accepted;
435 TileArea ta = TileArea(dst_town->xy, 1, 1).Expand(SUBSIDY_TOWN_CARGO_RADIUS);
436 for (TileIndex tile : ta) {
437 if (IsTileType(tile, MP_HOUSE)) {
438 AddAcceptedCargo(tile, town_cargo_accepted, nullptr);
439 }
440 }
441
442 /* Check if the town can accept this cargo. */
443 if (town_cargo_accepted[cid] < 8) return false;
444
445 dst = dst_town->index;
446 break;
447 }
448
449 case ST_INDUSTRY: {
450 /* Select a random industry. */
451 const Industry *dst_ind = Industry::GetRandom();
452 if (dst_ind == nullptr) return false;
453
454 /* The industry must accept the cargo */
455 bool valid = std::find(dst_ind->accepts_cargo, endof(dst_ind->accepts_cargo), cid) != endof(dst_ind->accepts_cargo);
456 if (!valid) return false;
457
458 dst = dst_ind->index;
459 break;
460 }
461
462 default: NOT_REACHED();
463 }
464
465 /* Check that the source and the destination are not the same. */
466 if (src_type == dst_type && src == dst) return false;
467
468 /* Check distance between source and destination. */
469 if (!CheckSubsidyDistance(src_type, src, dst_type, dst)) return false;
470
471 /* Avoid duplicate subsidies. */
472 if (CheckSubsidyDuplicate(cid, src_type, src, dst_type, dst)) return false;
473
474 CreateSubsidy(cid, src_type, src, dst_type, dst);
475
476 return true;
477 }
478
480 void SubsidyMonthlyLoop()
481 {
482 bool modified = false;
483
484 for (Subsidy *s : Subsidy::Iterate()) {
485 if (--s->remaining == 0) {
486 if (!s->IsAwarded()) {
487 std::pair<NewsReferenceType, NewsReferenceType> reftype = SetupSubsidyDecodeParam(s, SubsidyDecodeParamType::NewsWithdrawn);
488 AddNewsItem(STR_NEWS_OFFER_OF_SUBSIDY_EXPIRED, NT_SUBSIDIES, NF_NORMAL, reftype.first, s->src, reftype.second, s->dst);
489 AI::BroadcastNewEvent(new ScriptEventSubsidyOfferExpired(s->index));
490 Game::NewEvent(new ScriptEventSubsidyOfferExpired(s->index));
491 } else {
492 if (s->awarded == _local_company) {
493 std::pair<NewsReferenceType, NewsReferenceType> reftype = SetupSubsidyDecodeParam(s, SubsidyDecodeParamType::NewsWithdrawn);
494 AddNewsItem(STR_NEWS_SUBSIDY_WITHDRAWN_SERVICE, NT_SUBSIDIES, NF_NORMAL, reftype.first, s->src, reftype.second, s->dst);
495 }
496 AI::BroadcastNewEvent(new ScriptEventSubsidyExpired(s->index));
497 Game::NewEvent(new ScriptEventSubsidyExpired(s->index));
498 }
499 delete s;
500 modified = true;
501 }
502 }
503
504 if (modified) {
505 RebuildSubsidisedSourceAndDestinationCache();
506 } else if (_settings_game.difficulty.subsidy_duration == 0) {
507 /* If subsidy duration is set to 0, subsidies are disabled, so bail out. */
508 return;
509 } else if (_settings_game.linkgraph.distribution_pax != DT_MANUAL &&
510 _settings_game.linkgraph.distribution_mail != DT_MANUAL &&
511 _settings_game.linkgraph.distribution_armoured != DT_MANUAL &&
512 _settings_game.linkgraph.distribution_default != DT_MANUAL) {
513 /* Return early if there are no manually distributed cargoes and if we
514 * don't need to invalidate the subsidies window. */
515 return;
516 }
517
518 bool passenger_subsidy = false;
519 bool town_subsidy = false;
520 bool industry_subsidy = false;
521
522 int random_chance = RandomRange(16);
523
524 if (random_chance < 2 && _settings_game.linkgraph.distribution_pax == DT_MANUAL) {
525 /* There is a 1/8 chance each month of generating a passenger subsidy. */
526 int n = 1000;
527
528 do {
529 passenger_subsidy = FindSubsidyPassengerRoute();
530 } while (!passenger_subsidy && n--);
531 } else if (random_chance == 2) {
532 /* Cargo subsidies with a town as a source have a 1/16 chance. */
533 int n = 1000;
534
535 do {
536 town_subsidy = FindSubsidyTownCargoRoute();
537 } while (!town_subsidy && n--);
538 } else if (random_chance == 3) {
539 /* Cargo subsidies with an industry as a source have a 1/16 chance. */
540 int n = 1000;
541
542 do {
543 industry_subsidy = FindSubsidyIndustryCargoRoute();
544 } while (!industry_subsidy && n--);
545 }
546
547 modified |= passenger_subsidy || town_subsidy || industry_subsidy;
548
549 if (modified) InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
550 }
551
561 bool CheckSubsidised(CargoID cargo_type, CompanyID company, SourceType src_type, SourceID src, const Station *st)
562 {
563 /* If the source isn't subsidised, don't continue */
564 if (src == INVALID_SOURCE) return false;
565 switch (src_type) {
566 case ST_INDUSTRY:
567 if (!(Industry::Get(src)->part_of_subsidy & POS_SRC)) return false;
568 break;
569 case ST_TOWN:
570 if (!(Town::Get(src)->cache.part_of_subsidy & POS_SRC)) return false;
571 break;
572 default: return false;
573 }
574
575 /* Remember all towns near this station (at least one house in its catchment radius)
576 * which are destination of subsidised path. Do that only if needed */
577 std::vector<const Town *> towns_near;
578 if (!st->rect.IsEmpty()) {
579 for (const Subsidy *s : Subsidy::Iterate()) {
580 /* Don't create the cache if there is no applicable subsidy with town as destination */
581 if (s->dst_type != ST_TOWN) continue;
582 if (s->cargo_type != cargo_type || s->src_type != src_type || s->src != src) continue;
583 if (s->IsAwarded() && s->awarded != company) continue;
584
585 BitmapTileIterator it(st->catchment_tiles);
586 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
587 if (!IsTileType(tile, MP_HOUSE)) continue;
588 const Town *t = Town::GetByTile(tile);
589 if (t->cache.part_of_subsidy & POS_DST) include(towns_near, t);
590 }
591 break;
592 }
593 }
594
595 bool subsidised = false;
596
597 /* Check if there's a (new) subsidy that applies. There can be more subsidies triggered by this delivery!
598 * Think about the case that subsidies are A->B and A->C and station has both B and C in its catchment area */
599 for (Subsidy *s : Subsidy::Iterate()) {
600 if (s->cargo_type == cargo_type && s->src_type == src_type && s->src == src && (!s->IsAwarded() || s->awarded == company)) {
601 switch (s->dst_type) {
602 case ST_INDUSTRY:
603 for (const auto &i : st->industries_near) {
604 if (s->dst == i.industry->index) {
605 assert(i.industry->part_of_subsidy & POS_DST);
606 subsidised = true;
607 if (!s->IsAwarded()) s->AwardTo(company);
608 }
609 }
610 break;
611 case ST_TOWN:
612 for (const Town *tp : towns_near) {
613 if (s->dst == tp->index) {
614 assert(tp->cache.part_of_subsidy & POS_DST);
615 subsidised = true;
616 if (!s->IsAwarded()) s->AwardTo(company);
617 }
618 }
619 break;
620 default:
621 NOT_REACHED();
622 }
623 }
624 }
625
626 return subsidised;
627 }
game.hpp
Subsidy::remaining
uint16 remaining
Remaining months when this subsidy is valid.
Definition: subsidy_base.h:24
MP_HOUSE
@ MP_HOUSE
A house by a town.
Definition: tile_type.h:51
InvalidateWindowData
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3252
CheckSubsidyDuplicate
static bool CheckSubsidyDuplicate(CargoID cargo, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
Check whether a specific subsidy already exists.
Definition: subsidy.cpp:175
Chance16
static bool Chance16(const uint a, const uint b)
Flips a coin with given probability.
Definition: random_func.hpp:131
Pool::PoolItem<&_industry_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
DifficultySettings::subsidy_duration
uint16 subsidy_duration
duration of subsidies
Definition: settings_type.h:87
command_func.h
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:28
SubsidyDecodeParamType::NewsAwarded
@ NewsAwarded
News item for an awarded subsidy.
WC_SUBSIDIES_LIST
@ WC_SUBSIDIES_LIST
Subsidies list; Window numbers:
Definition: window_type.h:253
Station
Station data structure.
Definition: station_base.h:454
BitmapTileIterator
Iterator to iterate over all tiles belonging to a bitmaptilearea.
Definition: bitmap_type.h:107
SUBSIDY_OFFER_MONTHS
static const uint SUBSIDY_OFFER_MONTHS
Constants related to subsidies.
Definition: subsidy_base.h:54
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:235
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:118
LinkGraphSettings::distribution_mail
DistributionType distribution_mail
distribution type for mail
Definition: settings_type.h:540
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
CargoArray
Class for storing amounts of cargo.
Definition: cargo_type.h:82
DT_MANUAL
@ DT_MANUAL
Manual distribution. No link graph calculations are run.
Definition: linkgraph_type.h:25
SubsidyDecodeParamType::NewsOffered
@ NewsOffered
News item for an offered subsidy.
GameSettings::difficulty
DifficultySettings difficulty
settings related to the difficulty
Definition: settings_type.h:586
INVALID_TILE
static constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:108
Industry::last_month_production
uint16 last_month_production[INDUSTRY_NUM_OUTPUTS]
total units produced per cargo in the last full month
Definition: industry.h:79
AddNewsItem
void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1=NR_NONE, uint32 ref1=UINT32_MAX, NewsReferenceType reftype2=NR_NONE, uint32 ref2=UINT32_MAX, const NewsAllocatedData *data=nullptr)
Add a new newsitem to be shown.
Definition: news_gui.cpp:827
include
bool include(std::vector< T > &vec, const T &item)
Helper function to append an item to a vector if it is not already contained Consider using std::set,...
Definition: smallvec_type.hpp:27
valid
uint8 valid
Bits indicating what variable is valid (for each bit, 0 is invalid, 1 is valid).
Definition: newgrf_station.cpp:248
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
TownCache::part_of_subsidy
PartOfSubsidy part_of_subsidy
Is this town a source/destination of a subsidy?
Definition: town.h:44
Town::xy
TileIndex xy
town center tile
Definition: town.h:51
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:57
town.h
RandomRange
static uint32 RandomRange(uint32 limit)
Pick a random number between 0 and limit - 1, inclusive.
Definition: random_func.hpp:81
Industry
Defines the internal data of a functional industry.
Definition: industry.h:66
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:357
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
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:355
Town::GetRandom
static Town * GetRandom()
Return a random valid town.
Definition: town_cmd.cpp:186
FindSubsidyTownCargoRoute
bool FindSubsidyTownCargoRoute()
Tries to create a cargo subsidy with a town as source.
Definition: subsidy.cpp:312
ST_TOWN
@ ST_TOWN
Source/destination is a town.
Definition: cargo_type.h:149
ai.hpp
NR_NONE
@ NR_NONE
Empty reference.
Definition: news_type.h:51
tile_cmd.h
NR_TOWN
@ NR_TOWN
Reference town. Scroll to town when clicking on the news.
Definition: news_type.h:56
Industry::GetRandom
static Industry * GetRandom()
Return a random valid industry.
Definition: industry_cmd.cpp:220
DistanceManhattan
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:157
TownCache::population
uint32 population
Current population of people.
Definition: town.h:42
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
DifficultySettings::subsidy_multiplier
byte subsidy_multiplier
payment multiplier for subsidized deliveries
Definition: settings_type.h:86
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
CommandCost
Common return value for all commands.
Definition: command_type.h:24
SourceID
uint16 SourceID
Contains either industry ID, town ID or company ID (or INVALID_SOURCE)
Definition: cargo_type.h:153
FindSubsidyIndustryCargoRoute
bool FindSubsidyIndustryCargoRoute()
Tries to create a cargo subsidy with an industry as source.
Definition: subsidy.cpp:370
BaseStation::rect
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
Definition: base_station_base.h:75
Subsidy::src
SourceID src
Index of source. Either TownID or IndustryID.
Definition: subsidy_base.h:28
Industry::produced_cargo
CargoID produced_cargo[INDUSTRY_NUM_OUTPUTS]
16 production cargo slots
Definition: industry.h:70
NewsReferenceType
NewsReferenceType
References to objects in news.
Definition: news_type.h:50
SetPartOfSubsidyFlag
static void SetPartOfSubsidyFlag(SourceType type, SourceID index, PartOfSubsidy flag)
Sets a flag indicating that given town/industry is part of subsidised route.
Definition: subsidy.cpp:122
ST_INDUSTRY
@ ST_INDUSTRY
Source/destination is an industry.
Definition: cargo_type.h:148
OrthogonalTileArea
Represents the covered area of e.g.
Definition: tilearea_type.h:18
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:54
NewsStringData
Container for a single string to be passed as NewsAllocatedData.
Definition: news_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
Game::NewEvent
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:146
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
AI::BroadcastNewEvent
static void BroadcastNewEvent(ScriptEvent *event, CompanyID skip_company=MAX_COMPANIES)
Broadcast a new event to all active AIs.
Definition: ai_core.cpp:261
industry.h
safeguards.h
_subsidy_pool
SubsidyPool _subsidy_pool("Subsidy")
Pool for the subsidies.
Subsidy::dst
SourceID dst
Index of destination. Either TownID or IndustryID.
Definition: subsidy_base.h:29
MONTHS_IN_YEAR
static const int MONTHS_IN_YEAR
months per year
Definition: date_type.h:31
GameSettings::linkgraph
LinkGraphSettings linkgraph
settings for link graph calculations
Definition: settings_type.h:597
NT_SUBSIDIES
@ NT_SUBSIDIES
News about subsidies (announcements, expirations, acceptance)
Definition: news_type.h:36
subsidy_cmd.h
stdafx.h
NF_NORMAL
@ NF_NORMAL
Normal news item. (Newspaper with text only)
Definition: news_type.h:79
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
SubsidyDecodeParamType::NewsWithdrawn
@ NewsWithdrawn
News item for a subsidy offer withdrawn, or expired subsidy.
Industry::last_month_pct_transported
byte last_month_pct_transported[INDUSTRY_NUM_OUTPUTS]
percentage transported per cargo in the last full month
Definition: industry.h:78
string_func.h
Subsidy::dst_type
SourceType dst_type
Destination of subsidised path (ST_INDUSTRY or ST_TOWN)
Definition: subsidy_base.h:27
Station::industries_near
IndustryList industries_near
Cached list of industries near the station that can accept cargo,.
Definition: station_base.h:486
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
station_base.h
SourceType
SourceType
Types of cargo source and destination.
Definition: cargo_type.h:147
Pool::PoolItem<&_town_pool >::Iterate
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:386
strings_func.h
Pool
Base class for all pools.
Definition: pool_type.hpp:81
NR_INDUSTRY
@ NR_INDUSTRY
Reference industry. Scroll to industry when clicking on the news. Delete news when industry is delete...
Definition: news_type.h:55
subsidy_func.h
RebuildSubsidisedSourceAndDestinationCache
void RebuildSubsidisedSourceAndDestinationCache()
Perform a full rebuild of the subsidies cache.
Definition: subsidy.cpp:132
SUBSIDY_MAX_DISTANCE
static const uint SUBSIDY_MAX_DISTANCE
Max. length of subsidised route (DistanceManhattan)
Definition: subsidy_base.h:58
CmdCreateSubsidy
CommandCost CmdCreateSubsidy(DoCommandFlag flags, CargoID cid, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
Create a new subsidy.
Definition: subsidy.cpp:242
endof
#define endof(x)
Get the end element of an fixed size array.
Definition: stdafx.h:394
NUM_CARGO
@ NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:65
Town::cache
TownCache cache
Container for all cacheable data.
Definition: town.h:53
Pool::PoolItem<&_subsidy_pool >::CanAllocateItem
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
Definition: pool_type.hpp:307
INVALID_SOURCE
static const SourceID INVALID_SOURCE
Invalid/unknown index of source.
Definition: cargo_type.h:154
POS_NONE
@ POS_NONE
nothing
Definition: subsidy_type.h:17
subsidy_base.h
CargoSpec::name
StringID name
Name of this type of cargo.
Definition: cargotype.h:71
Station::catchment_tiles
BitmapTileArea catchment_tiles
NOSAVE: Set of individual tiles covered by catchment area.
Definition: station_base.h:474
OWNER_DEITY
@ OWNER_DEITY
The object is owned by a superuser / goal script.
Definition: company_type.h:27
PartOfSubsidy
PartOfSubsidy
What part of a subsidy is something?
Definition: subsidy_type.h:16
company_func.h
FindSubsidyCargoDestination
bool FindSubsidyCargoDestination(CargoID cid, SourceType src_type, SourceID src)
Tries to find a suitable destination for the given source and cargo.
Definition: subsidy.cpp:422
INSTANTIATE_POOL_METHODS
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Definition: pool_func.hpp:224
TileArea
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Definition: tilearea_type.h:102
window_func.h
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:386
Town
Town data structure.
Definition: town.h:50
CreateSubsidy
void CreateSubsidy(CargoID cid, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
Creates a subsidy with the given parameters.
Definition: subsidy.cpp:211
random_func.hpp
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
NewsStringData::string
std::string string
The string to retain.
Definition: news_type.h:148
OrthogonalTileArea::Expand
OrthogonalTileArea & Expand(int rad)
Expand a tile area by rad tiles in each direction, keeping within map bounds.
Definition: tilearea.cpp:123
Industry::accepts_cargo
CargoID accepts_cargo[INDUSTRY_NUM_INPUTS]
16 input cargo slots
Definition: industry.h:75
Pool::PoolItem<&_town_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
LinkGraphSettings::distribution_armoured
DistributionType distribution_armoured
distribution type for armoured cargo class
Definition: settings_type.h:541
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
pool_func.hpp
CT_INVALID
@ CT_INVALID
Invalid cargo type.
Definition: cargo_type.h:69
Subsidy::src_type
SourceType src_type
Source of subsidised path (ST_INDUSTRY or ST_TOWN)
Definition: subsidy_base.h:26
Subsidy::awarded
CompanyID awarded
Subsidy is awarded to this company; INVALID_COMPANY if it's not awarded to anyone.
Definition: subsidy_base.h:25
CheckSubsidyDistance
static bool CheckSubsidyDistance(SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
Checks if the source and destination of a subsidy are inside the distance limit.
Definition: subsidy.cpp:195
LinkGraphSettings::distribution_pax
DistributionType distribution_pax
distribution type for passengers
Definition: settings_type.h:539
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:297
SubsidyMonthlyLoop
void SubsidyMonthlyLoop()
Perform the monthly update of open subsidies, and try to create a new one.
Definition: subsidy.cpp:480
POS_DST
@ POS_DST
bit 1 set -> town/industry is destination of subsidised path
Definition: subsidy_type.h:19
LinkGraphSettings::distribution_default
DistributionType distribution_default
distribution type for all other goods
Definition: settings_type.h:542
POS_SRC
@ POS_SRC
bit 0 set -> town/industry is source of subsidised path
Definition: subsidy_type.h:18
SUBSIDY_PAX_MIN_POPULATION
static const uint SUBSIDY_PAX_MIN_POPULATION
Min. population of towns for subsidised pax route.
Definition: subsidy_base.h:55
news_func.h
FindSubsidyPassengerRoute
bool FindSubsidyPassengerRoute()
Tries to create a passenger subsidy between two towns.
Definition: subsidy.cpp:282