OpenTTD Source: src/subsidy.cpp Source File

OpenTTD Source 12.0-beta1

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
28 #include "table/strings.h"
29
30 #include "safeguards.h"
31
32 SubsidyPool _subsidy_pool("Subsidy");
33 INSTANTIATE_POOL_METHODS(Subsidy)
34
35
39 void Subsidy::AwardTo(CompanyID company)
40 {
41 assert(!this->IsAwarded());
42
43 this->awarded = company;
44 this->remaining = _settings_game.difficulty.subsidy_duration * MONTHS_IN_YEAR;
45
46 SetDParam(0, company);
47 NewsStringData *company_name = new NewsStringData(GetString(STR_COMPANY_NAME));
48
49 /* Add a news item */
50 std::pair<NewsReferenceType, NewsReferenceType> reftype = SetupSubsidyDecodeParam(this, SubsidyDecodeParamType::NewsAwarded, 1);
51
52 SetDParamStr(0, company_name->string);
53 AddNewsItem(
54 STR_NEWS_SERVICE_SUBSIDY_AWARDED_HALF + _settings_game.difficulty.subsidy_multiplier,
55 NT_SUBSIDIES, NF_NORMAL,
56 reftype.first, this->src, reftype.second, this->dst,
57 company_name
58 );
59 AI::BroadcastNewEvent(new ScriptEventSubsidyAwarded(this->index));
60 Game::NewEvent(new ScriptEventSubsidyAwarded(this->index));
61
62 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
63 }
64
72 std::pair<NewsReferenceType, NewsReferenceType> SetupSubsidyDecodeParam(const Subsidy *s, SubsidyDecodeParamType mode, uint parameter_offset)
73 {
74 NewsReferenceType reftype1 = NR_NONE;
75 NewsReferenceType reftype2 = NR_NONE;
76
77 /* Choose whether to use the singular or plural form of the cargo name based on how we're printing the subsidy */
78 const CargoSpec *cs = CargoSpec::Get(s->cargo_type);
79 if (mode == SubsidyDecodeParamType::Gui || mode == SubsidyDecodeParamType::NewsWithdrawn) {
80 SetDParam(parameter_offset, cs->name);
81 } else {
82 SetDParam(parameter_offset, cs->name_single);
83 }
84
85 switch (s->src_type) {
86 case ST_INDUSTRY:
87 reftype1 = NR_INDUSTRY;
88 SetDParam(parameter_offset + 1, STR_INDUSTRY_NAME);
89 break;
90 case ST_TOWN:
91 reftype1 = NR_TOWN;
92 SetDParam(parameter_offset + 1, STR_TOWN_NAME);
93 break;
94 default: NOT_REACHED();
95 }
96 SetDParam(parameter_offset + 2, s->src);
97
98 switch (s->dst_type) {
99 case ST_INDUSTRY:
100 reftype2 = NR_INDUSTRY;
101 SetDParam(parameter_offset + 4, STR_INDUSTRY_NAME);
102 break;
103 case ST_TOWN:
104 reftype2 = NR_TOWN;
105 SetDParam(parameter_offset + 4, STR_TOWN_NAME);
106 break;
107 default: NOT_REACHED();
108 }
109 SetDParam(parameter_offset + 5, s->dst);
110
111 /* If the subsidy is being offered or awarded, the news item mentions the subsidy duration. */
112 if (mode == SubsidyDecodeParamType::NewsOffered || mode == SubsidyDecodeParamType::NewsAwarded) {
113 SetDParam(parameter_offset + 7, _settings_game.difficulty.subsidy_duration);
114 }
115
116 return std::pair<NewsReferenceType, NewsReferenceType>(reftype1, reftype2);
117 }
118
125 static inline void SetPartOfSubsidyFlag(SourceType type, SourceID index, PartOfSubsidy flag)
126 {
127 switch (type) {
128 case ST_INDUSTRY: Industry::Get(index)->part_of_subsidy |= flag; return;
129 case ST_TOWN: Town::Get(index)->cache.part_of_subsidy |= flag; return;
130 default: NOT_REACHED();
131 }
132 }
133
135 void RebuildSubsidisedSourceAndDestinationCache()
136 {
137 for (Town *t : Town::Iterate()) t->cache.part_of_subsidy = POS_NONE;
138
139 for (Industry *i : Industry::Iterate()) i->part_of_subsidy = POS_NONE;
140
141 for (const Subsidy *s : Subsidy::Iterate()) {
142 SetPartOfSubsidyFlag(s->src_type, s->src, POS_SRC);
143 SetPartOfSubsidyFlag(s->dst_type, s->dst, POS_DST);
144 }
145 }
146
152 void DeleteSubsidyWith(SourceType type, SourceID index)
153 {
154 bool dirty = false;
155
156 for (Subsidy *s : Subsidy::Iterate()) {
157 if ((s->src_type == type && s->src == index) || (s->dst_type == type && s->dst == index)) {
158 delete s;
159 dirty = true;
160 }
161 }
162
163 if (dirty) {
164 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
165 RebuildSubsidisedSourceAndDestinationCache();
166 }
167 }
168
178 static bool CheckSubsidyDuplicate(CargoID cargo, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
179 {
180 for (const Subsidy *s : Subsidy::Iterate()) {
181 if (s->cargo_type == cargo &&
182 s->src_type == src_type && s->src == src &&
183 s->dst_type == dst_type && s->dst == dst) {
184 return true;
185 }
186 }
187 return false;
188 }
189
198 static bool CheckSubsidyDistance(SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
199 {
200 TileIndex tile_src = (src_type == ST_TOWN) ? Town::Get(src)->xy : Industry::Get(src)->location.tile;
201 TileIndex tile_dst = (dst_type == ST_TOWN) ? Town::Get(dst)->xy : Industry::Get(dst)->location.tile;
202
203 return (DistanceManhattan(tile_src, tile_dst) <= SUBSIDY_MAX_DISTANCE);
204 }
205
214 void CreateSubsidy(CargoID cid, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
215 {
216 Subsidy *s = new Subsidy();
217 s->cargo_type = cid;
218 s->src_type = src_type;
219 s->src = src;
220 s->dst_type = dst_type;
221 s->dst = dst;
222 s->remaining = SUBSIDY_OFFER_MONTHS;
223 s->awarded = INVALID_COMPANY;
224
225 std::pair<NewsReferenceType, NewsReferenceType> reftype = SetupSubsidyDecodeParam(s, SubsidyDecodeParamType::NewsOffered);
226 AddNewsItem(STR_NEWS_SERVICE_SUBSIDY_OFFERED, NT_SUBSIDIES, NF_NORMAL, reftype.first, s->src, reftype.second, s->dst);
227 SetPartOfSubsidyFlag(s->src_type, s->src, POS_SRC);
228 SetPartOfSubsidyFlag(s->dst_type, s->dst, POS_DST);
229 AI::BroadcastNewEvent(new ScriptEventSubsidyOffer(s->index));
230 Game::NewEvent(new ScriptEventSubsidyOffer(s->index));
231
232 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
233 }
234
249 CommandCost CmdCreateSubsidy(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
250 {
251 if (!Subsidy::CanAllocateItem()) return CMD_ERROR;
252
253 CargoID cid = GB(p1, 24, 8);
254 SourceType src_type = (SourceType)GB(p1, 0, 8);
255 SourceID src = GB(p1, 8, 16);
256 SourceType dst_type = (SourceType)GB(p2, 0, 8);
257 SourceID dst = GB(p2, 8, 16);
258
259 if (_current_company != OWNER_DEITY) return CMD_ERROR;
260
261 if (cid >= NUM_CARGO || !::CargoSpec::Get(cid)->IsValid()) return CMD_ERROR;
262
263 switch (src_type) {
264 case ST_TOWN:
265 if (!Town::IsValidID(src)) return CMD_ERROR;
266 break;
267 case ST_INDUSTRY:
268 if (!Industry::IsValidID(src)) return CMD_ERROR;
269 break;
270 default:
271 return CMD_ERROR;
272 }
273 switch (dst_type) {
274 case ST_TOWN:
275 if (!Town::IsValidID(dst)) return CMD_ERROR;
276 break;
277 case ST_INDUSTRY:
278 if (!Industry::IsValidID(dst)) return CMD_ERROR;
279 break;
280 default:
281 return CMD_ERROR;
282 }
283
284 if (flags & DC_EXEC) {
285 CreateSubsidy(cid, src_type, src, dst_type, dst);
286 }
287
288 return CommandCost();
289 }
290
295 bool FindSubsidyPassengerRoute()
296 {
297 if (!Subsidy::CanAllocateItem()) return false;
298
299 const Town *src = Town::GetRandom();
300 if (src->cache.population < SUBSIDY_PAX_MIN_POPULATION ||
301 src->GetPercentTransported(CT_PASSENGERS) > SUBSIDY_MAX_PCT_TRANSPORTED) {
302 return false;
303 }
304
305 const Town *dst = Town::GetRandom();
306 if (dst->cache.population < SUBSIDY_PAX_MIN_POPULATION || src == dst) {
307 return false;
308 }
309
310 if (DistanceManhattan(src->xy, dst->xy) > SUBSIDY_MAX_DISTANCE) return false;
311 if (CheckSubsidyDuplicate(CT_PASSENGERS, ST_TOWN, src->index, ST_TOWN, dst->index)) return false;
312
313 CreateSubsidy(CT_PASSENGERS, ST_TOWN, src->index, ST_TOWN, dst->index);
314
315 return true;
316 }
317
318 bool FindSubsidyCargoDestination(CargoID cid, SourceType src_type, SourceID src);
319
320
325 bool FindSubsidyTownCargoRoute()
326 {
327 if (!Subsidy::CanAllocateItem()) return false;
328
329 SourceType src_type = ST_TOWN;
330
331 /* Select a random town. */
332 const Town *src_town = Town::GetRandom();
333 if (src_town->cache.population < SUBSIDY_CARGO_MIN_POPULATION) return false;
334
335 /* Calculate the produced cargo of houses around town center. */
336 CargoArray town_cargo_produced;
337 TileArea ta = TileArea(src_town->xy, 1, 1).Expand(SUBSIDY_TOWN_CARGO_RADIUS);
338 for (TileIndex tile : ta) {
339 if (IsTileType(tile, MP_HOUSE)) {
340 AddProducedCargo(tile, town_cargo_produced);
341 }
342 }
343
344 /* Passenger subsidies are not handled here. */
345 town_cargo_produced[CT_PASSENGERS] = 0;
346
347 uint8 cargo_count = 0;
348 for (CargoID i = 0; i < NUM_CARGO; i++) {
349 if (town_cargo_produced[i] > 0) cargo_count++;
350 }
351
352 /* No cargo produced at all? */
353 if (cargo_count == 0) return false;
354
355 /* Choose a random cargo that is produced in the town. */
356 uint8 cargo_number = RandomRange(cargo_count);
357 CargoID cid;
358 for (cid = 0; cid < NUM_CARGO; cid++) {
359 if (town_cargo_produced[cid] > 0) {
360 if (cargo_number == 0) break;
361 cargo_number--;
362 }
363 }
364
365 /* Avoid using invalid NewGRF cargoes. */
366 if (!CargoSpec::Get(cid)->IsValid() ||
367 _settings_game.linkgraph.GetDistributionType(cid) != DT_MANUAL) {
368 return false;
369 }
370
371 /* Quit if the percentage transported is large enough. */
372 if (src_town->GetPercentTransported(cid) > SUBSIDY_MAX_PCT_TRANSPORTED) return false;
373
374 SourceID src = src_town->index;
375
376 return FindSubsidyCargoDestination(cid, src_type, src);
377 }
378
383 bool FindSubsidyIndustryCargoRoute()
384 {
385 if (!Subsidy::CanAllocateItem()) return false;
386
387 SourceType src_type = ST_INDUSTRY;
388
389 /* Select a random industry. */
390 const Industry *src_ind = Industry::GetRandom();
391 if (src_ind == nullptr) return false;
392
393 uint trans, total;
394
395 CargoID cid;
396
397 /* Randomize cargo type */
398 int num_cargos = 0;
399 uint cargo_index;
400 for (cargo_index = 0; cargo_index < lengthof(src_ind->produced_cargo); cargo_index++) {
401 if (src_ind->produced_cargo[cargo_index] != CT_INVALID) num_cargos++;
402 }
403 if (num_cargos == 0) return false; // industry produces nothing
404 int cargo_num = RandomRange(num_cargos) + 1;
405 for (cargo_index = 0; cargo_index < lengthof(src_ind->produced_cargo); cargo_index++) {
406 if (src_ind->produced_cargo[cargo_index] != CT_INVALID) cargo_num--;
407 if (cargo_num == 0) break;
408 }
409 assert(cargo_num == 0); // indicates loop didn't break as intended
410 cid = src_ind->produced_cargo[cargo_index];
411 trans = src_ind->last_month_pct_transported[cargo_index];
412 total = src_ind->last_month_production[cargo_index];
413
414 /* Quit if no production in this industry
415 * or if the pct transported is already large enough
416 * or if the cargo is automatically distributed */
417 if (total == 0 || trans > SUBSIDY_MAX_PCT_TRANSPORTED ||
418 cid == CT_INVALID ||
419 _settings_game.linkgraph.GetDistributionType(cid) != DT_MANUAL) {
420 return false;
421 }
422
423 SourceID src = src_ind->index;
424
425 return FindSubsidyCargoDestination(cid, src_type, src);
426 }
427
435 bool FindSubsidyCargoDestination(CargoID cid, SourceType src_type, SourceID src)
436 {
437 /* Choose a random destination. */
438 SourceType dst_type = Chance16(1, 2) ? ST_TOWN : ST_INDUSTRY;
439
440 SourceID dst;
441 switch (dst_type) {
442 case ST_TOWN: {
443 /* Select a random town. */
444 const Town *dst_town = Town::GetRandom();
445
446 /* Calculate cargo acceptance of houses around town center. */
447 CargoArray town_cargo_accepted;
448 TileArea ta = TileArea(dst_town->xy, 1, 1).Expand(SUBSIDY_TOWN_CARGO_RADIUS);
449 for (TileIndex tile : ta) {
450 if (IsTileType(tile, MP_HOUSE)) {
451 AddAcceptedCargo(tile, town_cargo_accepted, nullptr);
452 }
453 }
454
455 /* Check if the town can accept this cargo. */
456 if (town_cargo_accepted[cid] < 8) return false;
457
458 dst = dst_town->index;
459 break;
460 }
461
462 case ST_INDUSTRY: {
463 /* Select a random industry. */
464 const Industry *dst_ind = Industry::GetRandom();
465 if (dst_ind == nullptr) return false;
466
467 /* The industry must accept the cargo */
468 bool valid = std::find(dst_ind->accepts_cargo, endof(dst_ind->accepts_cargo), cid) != endof(dst_ind->accepts_cargo);
469 if (!valid) return false;
470
471 dst = dst_ind->index;
472 break;
473 }
474
475 default: NOT_REACHED();
476 }
477
478 /* Check that the source and the destination are not the same. */
479 if (src_type == dst_type && src == dst) return false;
480
481 /* Check distance between source and destination. */
482 if (!CheckSubsidyDistance(src_type, src, dst_type, dst)) return false;
483
484 /* Avoid duplicate subsidies. */
485 if (CheckSubsidyDuplicate(cid, src_type, src, dst_type, dst)) return false;
486
487 CreateSubsidy(cid, src_type, src, dst_type, dst);
488
489 return true;
490 }
491
493 void SubsidyMonthlyLoop()
494 {
495 bool modified = false;
496
497 for (Subsidy *s : Subsidy::Iterate()) {
498 if (--s->remaining == 0) {
499 if (!s->IsAwarded()) {
500 std::pair<NewsReferenceType, NewsReferenceType> reftype = SetupSubsidyDecodeParam(s, SubsidyDecodeParamType::NewsWithdrawn);
501 AddNewsItem(STR_NEWS_OFFER_OF_SUBSIDY_EXPIRED, NT_SUBSIDIES, NF_NORMAL, reftype.first, s->src, reftype.second, s->dst);
502 AI::BroadcastNewEvent(new ScriptEventSubsidyOfferExpired(s->index));
503 Game::NewEvent(new ScriptEventSubsidyOfferExpired(s->index));
504 } else {
505 if (s->awarded == _local_company) {
506 std::pair<NewsReferenceType, NewsReferenceType> reftype = SetupSubsidyDecodeParam(s, SubsidyDecodeParamType::NewsWithdrawn);
507 AddNewsItem(STR_NEWS_SUBSIDY_WITHDRAWN_SERVICE, NT_SUBSIDIES, NF_NORMAL, reftype.first, s->src, reftype.second, s->dst);
508 }
509 AI::BroadcastNewEvent(new ScriptEventSubsidyExpired(s->index));
510 Game::NewEvent(new ScriptEventSubsidyExpired(s->index));
511 }
512 delete s;
513 modified = true;
514 }
515 }
516
517 if (modified) {
518 RebuildSubsidisedSourceAndDestinationCache();
519 } else if (_settings_game.difficulty.subsidy_duration == 0) {
520 /* If subsidy duration is set to 0, subsidies are disabled, so bail out. */
521 return;
522 } else if (_settings_game.linkgraph.distribution_pax != DT_MANUAL &&
523 _settings_game.linkgraph.distribution_mail != DT_MANUAL &&
524 _settings_game.linkgraph.distribution_armoured != DT_MANUAL &&
525 _settings_game.linkgraph.distribution_default != DT_MANUAL) {
526 /* Return early if there are no manually distributed cargoes and if we
527 * don't need to invalidate the subsidies window. */
528 return;
529 }
530
531 bool passenger_subsidy = false;
532 bool town_subsidy = false;
533 bool industry_subsidy = false;
534
535 int random_chance = RandomRange(16);
536
537 if (random_chance < 2 && _settings_game.linkgraph.distribution_pax == DT_MANUAL) {
538 /* There is a 1/8 chance each month of generating a passenger subsidy. */
539 int n = 1000;
540
541 do {
542 passenger_subsidy = FindSubsidyPassengerRoute();
543 } while (!passenger_subsidy && n--);
544 } else if (random_chance == 2) {
545 /* Cargo subsidies with a town as a source have a 1/16 chance. */
546 int n = 1000;
547
548 do {
549 town_subsidy = FindSubsidyTownCargoRoute();
550 } while (!town_subsidy && n--);
551 } else if (random_chance == 3) {
552 /* Cargo subsidies with an industry as a source have a 1/16 chance. */
553 int n = 1000;
554
555 do {
556 industry_subsidy = FindSubsidyIndustryCargoRoute();
557 } while (!industry_subsidy && n--);
558 }
559
560 modified |= passenger_subsidy || town_subsidy || industry_subsidy;
561
562 if (modified) InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
563 }
564
574 bool CheckSubsidised(CargoID cargo_type, CompanyID company, SourceType src_type, SourceID src, const Station *st)
575 {
576 /* If the source isn't subsidised, don't continue */
577 if (src == INVALID_SOURCE) return false;
578 switch (src_type) {
579 case ST_INDUSTRY:
580 if (!(Industry::Get(src)->part_of_subsidy & POS_SRC)) return false;
581 break;
582 case ST_TOWN:
583 if (!(Town::Get(src)->cache.part_of_subsidy & POS_SRC)) return false;
584 break;
585 default: return false;
586 }
587
588 /* Remember all towns near this station (at least one house in its catchment radius)
589 * which are destination of subsidised path. Do that only if needed */
590 std::vector<const Town *> towns_near;
591 if (!st->rect.IsEmpty()) {
592 for (const Subsidy *s : Subsidy::Iterate()) {
593 /* Don't create the cache if there is no applicable subsidy with town as destination */
594 if (s->dst_type != ST_TOWN) continue;
595 if (s->cargo_type != cargo_type || s->src_type != src_type || s->src != src) continue;
596 if (s->IsAwarded() && s->awarded != company) continue;
597
598 BitmapTileIterator it(st->catchment_tiles);
599 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
600 if (!IsTileType(tile, MP_HOUSE)) continue;
601 const Town *t = Town::GetByTile(tile);
602 if (t->cache.part_of_subsidy & POS_DST) include(towns_near, t);
603 }
604 break;
605 }
606 }
607
608 bool subsidised = false;
609
610 /* Check if there's a (new) subsidy that applies. There can be more subsidies triggered by this delivery!
611 * Think about the case that subsidies are A->B and A->C and station has both B and C in its catchment area */
612 for (Subsidy *s : Subsidy::Iterate()) {
613 if (s->cargo_type == cargo_type && s->src_type == src_type && s->src == src && (!s->IsAwarded() || s->awarded == company)) {
614 switch (s->dst_type) {
615 case ST_INDUSTRY:
616 for (Industry *ind : st->industries_near) {
617 if (s->dst == ind->index) {
618 assert(ind->part_of_subsidy & POS_DST);
619 subsidised = true;
620 if (!s->IsAwarded()) s->AwardTo(company);
621 }
622 }
623 break;
624 case ST_TOWN:
625 for (const Town *tp : towns_near) {
626 if (s->dst == tp->index) {
627 assert(tp->cache.part_of_subsidy & POS_DST);
628 subsidised = true;
629 if (!s->IsAwarded()) s->AwardTo(company);
630 }
631 }
632 break;
633 default:
634 NOT_REACHED();
635 }
636 }
637 }
638
639 return subsidised;
640 }
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:49
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
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:3218
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:178
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
Industry::part_of_subsidy
PartOfSubsidy part_of_subsidy
NOSAVE: is this industry a source/destination of a subsidy?
Definition: industry.h:90
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
DifficultySettings::subsidy_duration
uint16 subsidy_duration
duration of subsidies
Definition: settings_type.h:83
command_func.h
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:23
NT_SUBSIDIES
@ NT_SUBSIDIES
News about subsidies (announcements, expirations, acceptance)
Definition: news_type.h:35
SubsidyDecodeParamType::NewsAwarded
@ NewsAwarded
News item for an awarded subsidy.
WC_SUBSIDIES_LIST
@ WC_SUBSIDIES_LIST
Subsidies list; Window numbers:
Definition: window_type.h:252
Station
Station data structure.
Definition: station_base.h:447
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:119
LinkGraphSettings::distribution_mail
DistributionType distribution_mail
distribution type for mail
Definition: settings_type.h:529
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:575
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:807
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
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:348
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:72
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:346
Town::GetRandom
static Town * GetRandom()
Return a random valid town.
Definition: town_cmd.cpp:184
FindSubsidyTownCargoRoute
bool FindSubsidyTownCargoRoute()
Tries to create a cargo subsidy with a town as source.
Definition: subsidy.cpp:325
ST_TOWN
@ ST_TOWN
Source/destination is a town.
Definition: cargo_type.h:149
ai.hpp
tile_cmd.h
CmdCreateSubsidy
CommandCost CmdCreateSubsidy(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Create a new subsidy.
Definition: subsidy.cpp:249
Industry::GetRandom
static Industry * GetRandom()
Return a random valid industry.
Definition: industry_cmd.cpp:218
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:82
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:23
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:383
BaseStation::rect
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
Definition: base_station_base.h:76
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
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:125
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:53
NewsStringData
Container for a single string to be passed as NewsAllocatedData.
Definition: news_type.h:146
DeleteSubsidyWith
void DeleteSubsidyWith(SourceType type, SourceID index)
Delete the subsidies associated with a given cargo source type and id.
Definition: subsidy.cpp:152
Game::NewEvent
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:141
_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:259
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
SubsidyDecodeParamType::Gui
@ Gui
Subsidies listed in the Subsidy GUI.
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:586
stdafx.h
NR_NONE
@ NR_NONE
Empty reference.
Definition: news_type.h:50
NF_NORMAL
@ NF_NORMAL
Normal news item. (Newspaper with text only)
Definition: news_type.h:78
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
NewsReferenceType
NewsReferenceType
References to objects in news.
Definition: news_type.h:49
string_func.h
NR_TOWN
@ NR_TOWN
Reference town. Scroll to town when clicking on the news.
Definition: news_type.h:55
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:479
_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
subsidy_func.h
RebuildSubsidisedSourceAndDestinationCache
void RebuildSubsidisedSourceAndDestinationCache()
Perform a full rebuild of the subsidies cache.
Definition: subsidy.cpp:135
SUBSIDY_MAX_DISTANCE
static const uint SUBSIDY_MAX_DISTANCE
Max. length of subsidised route (DistanceManhattan)
Definition: subsidy_base.h:58
endof
#define endof(x)
Get the end element of an fixed size array.
Definition: stdafx.h:386
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:72
Station::catchment_tiles
BitmapTileArea catchment_tiles
NOSAVE: Set of individual tiles covered by catchment area.
Definition: station_base.h:467
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:435
CargoSpec::name_single
StringID name_single
Name of a single entity of this type of cargo.
Definition: cargotype.h:73
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:378
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:214
random_func.hpp
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:88
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:147
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:530
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:574
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
NR_INDUSTRY
@ NR_INDUSTRY
Reference industry. Scroll to industry when clicking on the news. Delete news when industry is delete...
Definition: news_type.h:54
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:198
LinkGraphSettings::distribution_pax
DistributionType distribution_pax
distribution type for passengers
Definition: settings_type.h:528
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:296
SubsidyMonthlyLoop
void SubsidyMonthlyLoop()
Perform the monthly update of open subsidies, and try to create a new one.
Definition: subsidy.cpp:493
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:531
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:295