OpenTTD

subsidy.cpp
Go to the documentation of this file.
1 /* $Id: subsidy.cpp 26509 2014-04-25 15:40:32Z rubidium $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #include "stdafx.h"
13 #include "company_func.h"
14 #include "industry.h"
15 #include "town.h"
16 #include "news_func.h"
17 #include "ai/ai.hpp"
18 #include "station_base.h"
19 #include "strings_func.h"
20 #include "window_func.h"
21 #include "subsidy_base.h"
22 #include "subsidy_func.h"
23 #include "core/pool_func.hpp"
24 #include "core/random_func.hpp"
25 #include "game/game.hpp"
26 #include "command_func.h"
27 #include "string_func.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 = SUBSIDY_CONTRACT_MONTHS;
46
47 char company_name[MAX_LENGTH_COMPANY_NAME_CHARS * MAX_CHAR_LENGTH];
48 SetDParam(0, company);
49 GetString(company_name, STR_COMPANY_NAME, lastof(company_name));
50
51 char *cn = stredup(company_name);
52
53 /* Add a news item */
54 Pair reftype = SetupSubsidyDecodeParam(this, false);
55 InjectDParam(1);
56
57 SetDParamStr(0, cn);
58 AddNewsItem(
59 STR_NEWS_SERVICE_SUBSIDY_AWARDED_HALF + _settings_game.difficulty.subsidy_multiplier,
60 NT_SUBSIDIES, NF_NORMAL,
61 (NewsReferenceType)reftype.a, this->src, (NewsReferenceType)reftype.b, this->dst,
62 cn
63 );
64 AI::BroadcastNewEvent(new ScriptEventSubsidyAwarded(this->index));
65 Game::NewEvent(new ScriptEventSubsidyAwarded(this->index));
66
67 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
68 }
69
76 Pair SetupSubsidyDecodeParam(const Subsidy *s, bool mode)
77 {
78 NewsReferenceType reftype1 = NR_NONE;
79 NewsReferenceType reftype2 = NR_NONE;
80
81 /* if mode is false, use the singular form */
82 const CargoSpec *cs = CargoSpec::Get(s->cargo_type);
83 SetDParam(0, mode ? cs->name : cs->name_single);
84
85 switch (s->src_type) {
86 case ST_INDUSTRY:
87 reftype1 = NR_INDUSTRY;
88 SetDParam(1, STR_INDUSTRY_NAME);
89 break;
90 case ST_TOWN:
91 reftype1 = NR_TOWN;
92 SetDParam(1, STR_TOWN_NAME);
93 break;
94 default: NOT_REACHED();
95 }
96 SetDParam(2, s->src);
97
98 switch (s->dst_type) {
99 case ST_INDUSTRY:
100 reftype2 = NR_INDUSTRY;
101 SetDParam(4, STR_INDUSTRY_NAME);
102 break;
103 case ST_TOWN:
104 reftype2 = NR_TOWN;
105 SetDParam(4, STR_TOWN_NAME);
106 break;
107 default: NOT_REACHED();
108 }
109 SetDParam(5, s->dst);
110
111 Pair p;
112 p.a = reftype1;
113 p.b = reftype2;
114 return p;
115 }
116
123 static inline void SetPartOfSubsidyFlag(SourceType type, SourceID index, PartOfSubsidy flag)
124 {
125 switch (type) {
126 case ST_INDUSTRY: Industry::Get(index)->part_of_subsidy |= flag; return;
127 case ST_TOWN: Town::Get(index)->cache.part_of_subsidy |= flag; return;
128 default: NOT_REACHED();
129 }
130 }
131
133 void RebuildSubsidisedSourceAndDestinationCache()
134 {
135 Town *t;
136 FOR_ALL_TOWNS(t) t->cache.part_of_subsidy = POS_NONE;
137
138 Industry *i;
139 FOR_ALL_INDUSTRIES(i) i->part_of_subsidy = POS_NONE;
140
141 const Subsidy *s;
142 FOR_ALL_SUBSIDIES(s) {
143 SetPartOfSubsidyFlag(s->src_type, s->src, POS_SRC);
144 SetPartOfSubsidyFlag(s->dst_type, s->dst, POS_DST);
145 }
146 }
147
153 void DeleteSubsidyWith(SourceType type, SourceID index)
154 {
155 bool dirty = false;
156
157 Subsidy *s;
158 FOR_ALL_SUBSIDIES(s) {
159 if ((s->src_type == type && s->src == index) || (s->dst_type == type && s->dst == index)) {
160 delete s;
161 dirty = true;
162 }
163 }
164
165 if (dirty) {
166 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
167 RebuildSubsidisedSourceAndDestinationCache();
168 }
169 }
170
180 static bool CheckSubsidyDuplicate(CargoID cargo, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
181 {
182 const Subsidy *s;
183 FOR_ALL_SUBSIDIES(s) {
184 if (s->cargo_type == cargo &&
185 s->src_type == src_type && s->src == src &&
186 s->dst_type == dst_type && s->dst == dst) {
187 return true;
188 }
189 }
190 return false;
191 }
192
201 static bool CheckSubsidyDistance(SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
202 {
203 TileIndex tile_src = (src_type == ST_TOWN) ? Town::Get(src)->xy : Industry::Get(src)->location.tile;
204 TileIndex tile_dst = (dst_type == ST_TOWN) ? Town::Get(dst)->xy : Industry::Get(dst)->location.tile;
205
206 return (DistanceManhattan(tile_src, tile_dst) <= SUBSIDY_MAX_DISTANCE);
207 }
208
217 void CreateSubsidy(CargoID cid, SourceType src_type, SourceID src, SourceType dst_type, SourceID dst)
218 {
219 Subsidy *s = new Subsidy();
220 s->cargo_type = cid;
221 s->src_type = src_type;
222 s->src = src;
223 s->dst_type = dst_type;
224 s->dst = dst;
225 s->remaining = SUBSIDY_OFFER_MONTHS;
226 s->awarded = INVALID_COMPANY;
227
228 Pair reftype = SetupSubsidyDecodeParam(s, false);
229 AddNewsItem(STR_NEWS_SERVICE_SUBSIDY_OFFERED, NT_SUBSIDIES, NF_NORMAL, (NewsReferenceType)reftype.a, s->src, (NewsReferenceType)reftype.b, s->dst);
230 SetPartOfSubsidyFlag(s->src_type, s->src, POS_SRC);
231 SetPartOfSubsidyFlag(s->dst_type, s->dst, POS_DST);
232 AI::BroadcastNewEvent(new ScriptEventSubsidyOffer(s->index));
233 Game::NewEvent(new ScriptEventSubsidyOffer(s->index));
234
235 InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
236 }
237
252 CommandCost CmdCreateSubsidy(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
253 {
254 if (!Subsidy::CanAllocateItem()) return CMD_ERROR;
255
256 CargoID cid = GB(p1, 24, 8);
257 SourceType src_type = (SourceType)GB(p1, 0, 8);
258 SourceID src = GB(p1, 8, 16);
259 SourceType dst_type = (SourceType)GB(p2, 0, 8);
260 SourceID dst = GB(p2, 8, 16);
261
262 if (_current_company != OWNER_DEITY) return CMD_ERROR;
263
264 if (cid >= NUM_CARGO || !::CargoSpec::Get(cid)->IsValid()) return CMD_ERROR;
265
266 switch (src_type) {
267 case ST_TOWN:
268 if (!Town::IsValidID(src)) return CMD_ERROR;
269 break;
270 case ST_INDUSTRY:
271 if (!Industry::IsValidID(src)) return CMD_ERROR;
272 break;
273 default:
274 return CMD_ERROR;
275 }
276 switch (dst_type) {
277 case ST_TOWN:
278 if (!Town::IsValidID(dst)) return CMD_ERROR;
279 break;
280 case ST_INDUSTRY:
281 if (!Industry::IsValidID(dst)) return CMD_ERROR;
282 break;
283 default:
284 return CMD_ERROR;
285 }
286
287 if (flags & DC_EXEC) {
288 CreateSubsidy(cid, src_type, src, dst_type, dst);
289 }
290
291 return CommandCost();
292 }
293
298 bool FindSubsidyPassengerRoute()
299 {
300 if (!Subsidy::CanAllocateItem()) return false;
301
302 const Town *src = Town::GetRandom();
303 if (src->cache.population < SUBSIDY_PAX_MIN_POPULATION ||
304 src->GetPercentTransported(CT_PASSENGERS) > SUBSIDY_MAX_PCT_TRANSPORTED) {
305 return false;
306 }
307
308 const Town *dst = Town::GetRandom();
309 if (dst->cache.population < SUBSIDY_PAX_MIN_POPULATION || src == dst) {
310 return false;
311 }
312
313 if (DistanceManhattan(src->xy, dst->xy) > SUBSIDY_MAX_DISTANCE) return false;
314 if (CheckSubsidyDuplicate(CT_PASSENGERS, ST_TOWN, src->index, ST_TOWN, dst->index)) return false;
315
316 CreateSubsidy(CT_PASSENGERS, ST_TOWN, src->index, ST_TOWN, dst->index);
317
318 return true;
319 }
320
321 bool FindSubsidyCargoDestination(CargoID cid, SourceType src_type, SourceID src);
322
323
328 bool FindSubsidyTownCargoRoute()
329 {
330 if (!Subsidy::CanAllocateItem()) return false;
331
332 SourceType src_type = ST_TOWN;
333
334 /* Select a random town. */
335 const Town *src_town = Town::GetRandom();
336
337 uint32 town_cargo_produced = src_town->cargo_produced;
338
339 /* Passenger subsidies are not handled here. */
340 ClrBit(town_cargo_produced, CT_PASSENGERS);
341
342 /* No cargo produced at all? */
343 if (town_cargo_produced == 0) return false;
344
345 /* Choose a random cargo that is produced in the town. */
346 uint8 cargo_number = RandomRange(CountBits(town_cargo_produced));
347 CargoID cid;
348 FOR_EACH_SET_CARGO_ID(cid, town_cargo_produced) {
349 if (cargo_number == 0) break;
350 cargo_number--;
351 }
352
353 /* Avoid using invalid NewGRF cargoes. */
354 if (!CargoSpec::Get(cid)->IsValid() ||
355 _settings_game.linkgraph.GetDistributionType(cid) != DT_MANUAL) {
356 return false;
357 }
358
359 /* Quit if the percentage transported is large enough. */
360 if (src_town->GetPercentTransported(cid) > SUBSIDY_MAX_PCT_TRANSPORTED) return false;
361
362 SourceID src = src_town->index;
363
364 return FindSubsidyCargoDestination(cid, src_type, src);
365 }
366
371 bool FindSubsidyIndustryCargoRoute()
372 {
373 if (!Subsidy::CanAllocateItem()) return false;
374
375 SourceType src_type = ST_INDUSTRY;
376
377 /* Select a random industry. */
378 const Industry *src_ind = Industry::GetRandom();
379 if (src_ind == NULL) return false;
380
381 uint trans, total;
382
383 CargoID cid;
384
385 /* Randomize cargo type */
386 if (src_ind->produced_cargo[1] != CT_INVALID && HasBit(Random(), 0)) {
387 cid = src_ind->produced_cargo[1];
388 trans = src_ind->last_month_pct_transported[1];
389 total = src_ind->last_month_production[1];
390 } else {
391 cid = src_ind->produced_cargo[0];
392 trans = src_ind->last_month_pct_transported[0];
393 total = src_ind->last_month_production[0];
394 }
395
396 /* Quit if no production in this industry
397 * or if the pct transported is already large enough
398 * or if the cargo is automatically distributed */
399 if (total == 0 || trans > SUBSIDY_MAX_PCT_TRANSPORTED ||
400 cid == CT_INVALID ||
401 _settings_game.linkgraph.GetDistributionType(cid) != DT_MANUAL) {
402 return false;
403 }
404
405 SourceID src = src_ind->index;
406
407 return FindSubsidyCargoDestination(cid, src_type, src);
408 }
409
417 bool FindSubsidyCargoDestination(CargoID cid, SourceType src_type, SourceID src)
418 {
419 /* Choose a random destination. Only consider towns if they can accept the cargo. */
420 SourceType dst_type = (HasBit(_town_cargoes_accepted, cid) && Chance16(1, 2)) ? ST_TOWN : ST_INDUSTRY;
421
422 SourceID dst;
423 switch (dst_type) {
424 case ST_TOWN: {
425 /* Select a random town. */
426 const Town *dst_town = Town::GetRandom();
427
428 /* Check if the town can accept this cargo. */
429 if (!HasBit(dst_town->cargo_accepted_total, cid)) return false;
430
431 dst = dst_town->index;
432 break;
433 }
434
435 case ST_INDUSTRY: {
436 /* Select a random industry. */
437 const Industry *dst_ind = Industry::GetRandom();
438
439 /* The industry must accept the cargo */
440 if (dst_ind == NULL ||
441 (cid != dst_ind->accepts_cargo[0] &&
442 cid != dst_ind->accepts_cargo[1] &&
443 cid != dst_ind->accepts_cargo[2])) {
444 return false;
445 }
446
447 dst = dst_ind->index;
448 break;
449 }
450
451 default: NOT_REACHED();
452 }
453
454 /* Check that the source and the destination are not the same. */
455 if (src_type == dst_type && src == dst) return false;
456
457 /* Check distance between source and destination. */
458 if (!CheckSubsidyDistance(src_type, src, dst_type, dst)) return false;
459
460 /* Avoid duplicate subsidies. */
461 if (CheckSubsidyDuplicate(cid, src_type, src, dst_type, dst)) return false;
462
463 CreateSubsidy(cid, src_type, src, dst_type, dst);
464
465 return true;
466 }
467
469 void SubsidyMonthlyLoop()
470 {
471 bool modified = false;
472
473 Subsidy *s;
474 FOR_ALL_SUBSIDIES(s) {
475 if (--s->remaining == 0) {
476 if (!s->IsAwarded()) {
477 Pair reftype = SetupSubsidyDecodeParam(s, true);
478 AddNewsItem(STR_NEWS_OFFER_OF_SUBSIDY_EXPIRED, NT_SUBSIDIES, NF_NORMAL, (NewsReferenceType)reftype.a, s->src, (NewsReferenceType)reftype.b, s->dst);
479 AI::BroadcastNewEvent(new ScriptEventSubsidyOfferExpired(s->index));
480 Game::NewEvent(new ScriptEventSubsidyOfferExpired(s->index));
481 } else {
482 if (s->awarded == _local_company) {
483 Pair reftype = SetupSubsidyDecodeParam(s, true);
484 AddNewsItem(STR_NEWS_SUBSIDY_WITHDRAWN_SERVICE, NT_SUBSIDIES, NF_NORMAL, (NewsReferenceType)reftype.a, s->src, (NewsReferenceType)reftype.b, s->dst);
485 }
486 AI::BroadcastNewEvent(new ScriptEventSubsidyExpired(s->index));
487 Game::NewEvent(new ScriptEventSubsidyExpired(s->index));
488 }
489 delete s;
490 modified = true;
491 }
492 }
493
494 if (modified) {
495 RebuildSubsidisedSourceAndDestinationCache();
496 } else if (_settings_game.linkgraph.distribution_pax != DT_MANUAL &&
497 _settings_game.linkgraph.distribution_mail != DT_MANUAL &&
498 _settings_game.linkgraph.distribution_armoured != DT_MANUAL &&
499 _settings_game.linkgraph.distribution_default != DT_MANUAL) {
500 /* Return early if there are no manually distributed cargoes and if we
501 * don't need to invalidate the subsidies window. */
502 return;
503 }
504
505 bool passenger_subsidy = false;
506 bool town_subsidy = false;
507 bool industry_subsidy = false;
508
509 int random_chance = RandomRange(16);
510
511 if (random_chance < 2 && _settings_game.linkgraph.distribution_pax == DT_MANUAL) {
512 /* There is a 1/8 chance each month of generating a passenger subsidy. */
513 int n = 1000;
514
515 do {
516 passenger_subsidy = FindSubsidyPassengerRoute();
517 } while (!passenger_subsidy && n--);
518 } else if (random_chance == 2) {
519 /* Cargo subsidies with a town as a source have a 1/16 chance. */
520 int n = 1000;
521
522 do {
523 town_subsidy = FindSubsidyTownCargoRoute();
524 } while (!town_subsidy && n--);
525 } else if (random_chance == 3) {
526 /* Cargo subsidies with an industry as a source have a 1/16 chance. */
527 int n = 1000;
528
529 do {
530 industry_subsidy = FindSubsidyIndustryCargoRoute();
531 } while (!industry_subsidy && n--);
532 }
533
534 modified |= passenger_subsidy || town_subsidy || industry_subsidy;
535
536 if (modified) InvalidateWindowData(WC_SUBSIDIES_LIST, 0);
537 }
538
548 bool CheckSubsidised(CargoID cargo_type, CompanyID company, SourceType src_type, SourceID src, const Station *st)
549 {
550 /* If the source isn't subsidised, don't continue */
551 if (src == INVALID_SOURCE) return false;
552 switch (src_type) {
553 case ST_INDUSTRY:
554 if (!(Industry::Get(src)->part_of_subsidy & POS_SRC)) return false;
555 break;
556 case ST_TOWN:
557 if (!(Town::Get(src)->cache.part_of_subsidy & POS_SRC)) return false;
558 break;
559 default: return false;
560 }
561
562 /* Remember all towns near this station (at least one house in its catchment radius)
563 * which are destination of subsidised path. Do that only if needed */
564 SmallVector<const Town *, 2> towns_near;
565 if (!st->rect.IsEmpty()) {
566 Subsidy *s;
567 FOR_ALL_SUBSIDIES(s) {
568 /* Don't create the cache if there is no applicable subsidy with town as destination */
569 if (s->dst_type != ST_TOWN) continue;
570 if (s->cargo_type != cargo_type || s->src_type != src_type || s->src != src) continue;
571 if (s->IsAwarded() && s->awarded != company) continue;
572
573 Rect rect = st->GetCatchmentRect();
574
575 for (int y = rect.top; y <= rect.bottom; y++) {
576 for (int x = rect.left; x <= rect.right; x++) {
577 TileIndex tile = TileXY(x, y);
578 if (!IsTileType(tile, MP_HOUSE)) continue;
579 const Town *t = Town::GetByTile(tile);
580 if (t->cache.part_of_subsidy & POS_DST) towns_near.Include(t);
581 }
582 }
583 break;
584 }
585 }
586
587 bool subsidised = false;
588
589 /* Check if there's a (new) subsidy that applies. There can be more subsidies triggered by this delivery!
590 * Think about the case that subsidies are A->B and A->C and station has both B and C in its catchment area */
591 Subsidy *s;
592 FOR_ALL_SUBSIDIES(s) {
593 if (s->cargo_type == cargo_type && s->src_type == src_type && s->src == src && (!s->IsAwarded() || s->awarded == company)) {
594 switch (s->dst_type) {
595 case ST_INDUSTRY:
596 for (const Industry * const *ip = st->industries_near.Begin(); ip != st->industries_near.End(); ip++) {
597 if (s->dst == (*ip)->index) {
598 assert((*ip)->part_of_subsidy & POS_DST);
599 subsidised = true;
600 if (!s->IsAwarded()) s->AwardTo(company);
601 }
602 }
603 break;
604 case ST_TOWN:
605 for (const Town * const *tp = towns_near.Begin(); tp != towns_near.End(); tp++) {
606 if (s->dst == (*tp)->index) {
607 assert((*tp)->cache.part_of_subsidy & POS_DST);
608 subsidised = true;
609 if (!s->IsAwarded()) s->AwardTo(company);
610 }
611 }
612 break;
613 default:
614 NOT_REACHED();
615 }
616 }
617 }
618
619 return subsidised;
620 }
strings_func.h
Functions related to OTTD&#39;s strings.
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:180
NT_SUBSIDIES
News about subsidies (announcements, expirations, acceptance)
Definition: news_type.h:50
ST_TOWN
Source/destination is a town.
Definition: cargo_type.h:141
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
Game::NewEvent
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:134
SUBSIDY_CONTRACT_MONTHS
static const uint SUBSIDY_CONTRACT_MONTHS
Duration of subsidy after awarding.
Definition: subsidy_base.h:57
Station::industries_near
IndustryVector industries_near
Cached list of industries near the station that can accept cargo,.
Definition: station_base.h:475
SetupSubsidyDecodeParam
Pair SetupSubsidyDecodeParam(const Subsidy *s, bool mode)
Setup the string parameters for printing the subsidy at the screen, and compute the news reference fo...
Definition: subsidy.cpp:76
Station::GetCatchmentRect
Rect GetCatchmentRect() const
Determines catchment rectangle of this station.
Definition: station.cpp:294
Subsidy::src
SourceID src
Index of source. Either TownID or IndustryID.
Definition: subsidy_base.h:30
SUBSIDY_OFFER_MONTHS
static const uint SUBSIDY_OFFER_MONTHS
Constants related to subsidies.
Definition: subsidy_base.h:56
Subsidy::IsAwarded
bool IsAwarded() const
Tests whether this subsidy has been awarded to someone.
Definition: subsidy_base.h:47
Pool::PoolItem<&_industry_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
Industry::last_month_production
uint16 last_month_production[2]
total units produced per cargo in the last full month
Definition: industry.h:51
SubsidyMonthlyLoop
void SubsidyMonthlyLoop()
Perform the monthly update of open subsidies, and try to create a new one.
Definition: subsidy.cpp:469
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:25
Subsidy::dst
SourceID dst
Index of destination. Either TownID or IndustryID.
Definition: subsidy_base.h:31
Subsidy::AwardTo
void AwardTo(CompanyID company)
Marks subsidy as awarded, creates news and AI event.
Definition: subsidy.cpp:40
CargoSpec
Specification of a cargo type.
Definition: cargotype.h:56
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:417
LinkGraphSettings::distribution_mail
DistributionTypeByte distribution_mail
distribution type for mail
Definition: settings_type.h:498
DT_MANUAL
Manual distribution. No link graph calculations are run.
Definition: linkgraph_type.h:27
BaseStation::rect
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
Definition: base_station_base.h:77
Industry
Defines the internal data of a functional industry.
Definition: industry.h:39
SmallVector::Begin
const T * Begin() const
Get the pointer to the first item (const)
Definition: smallvec_type.hpp:272
GameSettings::difficulty
DifficultySettings difficulty
settings related to the difficulty
Definition: settings_type.h:543
AI::BroadcastNewEvent
static void BroadcastNewEvent(ScriptEvent *event, CompanyID skip_company=MAX_COMPANIES)
Broadcast a new event to all active AIs.
Definition: ai_core.cpp:258
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
CargoSpec::name_single
StringID name_single
Name of a single entity of this type of cargo.
Definition: cargotype.h:72
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:60
Subsidy::src_type
SourceTypeByte src_type
Source of subsidised path (ST_INDUSTRY or ST_TOWN)
Definition: subsidy_base.h:28
DifficultySettings::subsidy_multiplier
byte subsidy_multiplier
amount of subsidy
Definition: settings_type.h:64
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
SmallVector
Simple vector template class.
Definition: smallvec_type.hpp:29
Town::cargo_produced
uint32 cargo_produced
Bitmap of all cargoes produced by houses in this town.
Definition: town.h:88
Town::cargo_accepted_total
uint32 cargo_accepted_total
NOSAVE: Bitmap of all cargoes accepted by houses in this town.
Definition: town.h:90
CommandCost
Common return value for all commands.
Definition: command_type.h:25
Industry::GetRandom
static Industry * GetRandom()
Return a random valid industry.
Definition: industry_cmd.cpp:202
TownCache::population
uint32 population
Current population of people.
Definition: town.h:47
SmallVector::End
const T * End() const
Get the pointer behind the last valid item (const)
Definition: smallvec_type.hpp:292
FindSubsidyTownCargoRoute
bool FindSubsidyTownCargoRoute()
Tries to create a cargo subsidy with a town as source.
Definition: subsidy.cpp:328
DeleteSubsidyWith
void DeleteSubsidyWith(SourceType type, SourceID index)
Delete the subsidies associated with a given cargo source type and id.
Definition: subsidy.cpp:153
CargoSpec::name
StringID name
Name of this type of cargo.
Definition: cargotype.h:71
RandomRange
static uint32 RandomRange(uint32 limit)
Pick a random number between 0 and limit - 1, inclusive.
Definition: random_func.hpp:83
INVALID_SOURCE
static const SourceID INVALID_SOURCE
Invalid/unknown index of source.
Definition: cargo_type.h:147
_local_company
CompanyByte _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
random_func.hpp
Pseudo random number generator.
OWNER_DEITY
The object is owned by a superuser / goal script.
Definition: company_type.h:29
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:217
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:279
string_func.h
Functions related to low-level strings.
pool_func.hpp
Some methods of Pool are placed here in order to reduce compilation time and binary size...
MAX_CHAR_LENGTH
static const int MAX_CHAR_LENGTH
Max. length of UTF-8 encoded unicode character.
Definition: strings_type.h:20
Town::xy
TileIndex xy
town center tile
Definition: town.h:56
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a give tiletype.
Definition: tile_map.h:143
CmdCreateSubsidy
CommandCost CmdCreateSubsidy(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
Create a new subsidy.
Definition: subsidy.cpp:252
Industry::part_of_subsidy
PartOfSubsidyByte part_of_subsidy
NOSAVE: is this industry a source/destination of a subsidy?
Definition: industry.h:61
FindSubsidyPassengerRoute
bool FindSubsidyPassengerRoute()
Tries to create a passenger subsidy between two towns.
Definition: subsidy.cpp:298
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:340
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
MAX_LENGTH_COMPANY_NAME_CHARS
static const uint MAX_LENGTH_COMPANY_NAME_CHARS
The maximum length of a company name in characters including &#39;\0&#39;.
Definition: company_type.h:42
safeguards.h
A number of safeguards to prevent using unsafe methods.
Town::GetRandom
static Town * GetRandom()
Return a random valid town.
Definition: town_cmd.cpp:145
Industry::accepts_cargo
CargoID accepts_cargo[3]
3 input cargo slots
Definition: industry.h:47
NR_NONE
Empty reference.
Definition: news_type.h:65
SUBSIDY_MAX_DISTANCE
static const uint SUBSIDY_MAX_DISTANCE
Max. length of subsidised route (DistanceManhattan)
Definition: subsidy_base.h:61
stredup
char * stredup(const char *s, const char *last)
Create a duplicate of the given string.
Definition: string.cpp:126
NF_NORMAL
Normal news item. (Newspaper with text only)
Definition: news_type.h:93
Subsidy::awarded
CompanyByte awarded
Subsidy is awarded to this company; INVALID_COMPANY if it&#39;s not awarded to anyone.
Definition: subsidy_base.h:27
_town_cargoes_accepted
uint32 _town_cargoes_accepted
Bitmap of all cargoes accepted by houses.
Definition: town_cmd.cpp:56
WC_SUBSIDIES_LIST
Subsidies list; Window numbers:
Definition: window_type.h:255
Industry::produced_cargo
CargoID produced_cargo[2]
2 production cargo slots
Definition: industry.h:42
LinkGraphSettings::distribution_pax
DistributionTypeByte distribution_pax
distribution type for passengers
Definition: settings_type.h:497
CT_INVALID
Invalid cargo type.
Definition: cargo_type.h:70
FindSubsidyIndustryCargoRoute
bool FindSubsidyIndustryCargoRoute()
Tries to create a cargo subsidy with an industry as source.
Definition: subsidy.cpp:371
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:548
_subsidy_pool
SubsidyPool _subsidy_pool("Subsidy")
Pool for the subsidies.
Subsidy::cargo_type
CargoID cargo_type
Cargo type involved in this subsidy, CT_INVALID for invalid subsidy.
Definition: subsidy_base.h:25
Industry::last_month_pct_transported
byte last_month_pct_transported[2]
percentage transported per cargo in the last full month
Definition: industry.h:50
Pool
Base class for all pools.
Definition: pool_type.hpp:83
Subsidy
Struct about subsidies, offered and awarded.
Definition: subsidy_base.h:24
Chance16
static bool Chance16(const uint a, const uint b)
Flips a coin with given probability.
Definition: random_func.hpp:133
SourceType
SourceType
Types of cargo source and destination.
Definition: cargo_type.h:139
NUM_CARGO
Maximal number of cargo types in a game.
Definition: cargo_type.h:66
INSTANTIATE_POOL_METHODS
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don&#39;t get linker errors.
Definition: pool_func.hpp:224
POS_DST
bit 1 set -> town/industry is destination of subsidised path
Definition: subsidy_type.h:21
DC_EXEC
execute the given command
Definition: command_type.h:342
company_func.h
Functions related to companies.
ClrBit
static T ClrBit(T &x, const uint8 y)
Clears a bit in a variable.
Definition: bitmath_func.hpp:153
subsidy_base.h
Subsidy base class.
InjectDParam
void InjectDParam(uint amount)
Shift the string parameters in the global string parameter array by amount positions, making room at the beginning.
Definition: strings.cpp:288
NR_TOWN
Reference town. Scroll to town when clicking on the news.
Definition: news_type.h:70
CargoSpec::Get
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:118
_current_company
CompanyByte _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
DistanceManhattan
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:159
Subsidy::dst_type
SourceTypeByte dst_type
Destination of subsidised path (ST_INDUSTRY or ST_TOWN)
Definition: subsidy_base.h:29
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, void *free_data=NULL)
Add a new newsitem to be shown.
Definition: news_gui.cpp:645
ST_INDUSTRY
Source/destination is an industry.
Definition: cargo_type.h:140
SourceID
uint16 SourceID
Contains either industry ID, town ID or company ID (or INVALID_SOURCE)
Definition: cargo_type.h:146
RebuildSubsidisedSourceAndDestinationCache
void RebuildSubsidisedSourceAndDestinationCache()
Perform a full rebuild of the subsidies cache.
Definition: subsidy.cpp:133
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:34
SmallVector::Include
bool Include(const T &item)
Tests whether a item is present in the vector, and appends it to the end if not.
Definition: smallvec_type.hpp:250
Town::cache
TownCache cache
Container for all cacheable data.
Definition: town.h:58
Town
Town data structure.
Definition: town.h:55
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:216
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:201
CountBits
static uint CountBits(T value)
Counts the number of set bits in a variable.
Definition: bitmath_func.hpp:253
game.hpp
Base functions for all Games.
command_func.h
Functions related to commands.
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:123
Pool::PoolItem<&_town_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-NULL) Titem.
Definition: pool_type.hpp:235
NewsReferenceType
NewsReferenceType
References to objects in news.
Definition: news_type.h:64
industry.h
Base of all industries.
TownCache::part_of_subsidy
PartOfSubsidyByte part_of_subsidy
Is this town a source/destination of a subsidy?
Definition: town.h:49
POS_NONE
nothing
Definition: subsidy_type.h:19
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:105
ai.hpp
Base functions for all AIs.
town.h
Base of the town class.
NR_INDUSTRY
Reference industry. Scroll to industry when clicking on the news. Delete news when industry is delete...
Definition: news_type.h:69
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:40
MP_HOUSE
A house by a town.
Definition: tile_type.h:46
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:20
Subsidy::remaining
byte remaining
Remaining months when this subsidy is valid.
Definition: subsidy_base.h:26
window_func.h
Window functions not directly related to making/drawing windows.
SUBSIDY_PAX_MIN_POPULATION
static const uint SUBSIDY_PAX_MIN_POPULATION
Min. population of towns for subsidised pax route.
Definition: subsidy_base.h:58
news_func.h
Functions related to news.
station_base.h
Base classes/functions for stations.
POS_SRC
bit 0 set -> town/industry is source of subsidised path
Definition: subsidy_type.h:20
INVALID_COMPANY
An invalid company.
Definition: company_type.h:32
LinkGraphSettings::distribution_default
DistributionTypeByte distribution_default
distribution type for all other goods
Definition: settings_type.h:500
LinkGraphSettings::distribution_armoured
DistributionTypeByte distribution_armoured
distribution type for armoured cargo class
Definition: settings_type.h:499
Station
Station data structure.
Definition: station_base.h:446
subsidy_func.h
Functions related to subsidies.
GameSettings::linkgraph
LinkGraphSettings linkgraph
settings for link graph calculations
Definition: settings_type.h:554
TileXY
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition: map_func.h:165
Pair
A pair of two integers.
Definition: geometry_type.hpp:59
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:3220
PartOfSubsidy
PartOfSubsidy
What part of a subsidy is something?
Definition: subsidy_type.h:18
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:201