OpenTTD Source 20260311-master-g511d3794ce
economy.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include <ranges>
12#include "company_func.h"
13#include "command_func.h"
14#include "industry.h"
15#include "town.h"
16#include "news_func.h"
17#include "network/network.h"
19#include "ai/ai.hpp"
20#include "aircraft.h"
21#include "train.h"
22#include "newgrf_engine.h"
23#include "engine_base.h"
24#include "ground_vehicle.hpp"
25#include "newgrf_cargo.h"
26#include "newgrf_sound.h"
28#include "newgrf_station.h"
29#include "newgrf_airporttiles.h"
30#include "newgrf_roadstop.h"
31#include "object.h"
32#include "strings_func.h"
33#include "vehicle_func.h"
34#include "sound_func.h"
35#include "autoreplace_func.h"
36#include "company_gui.h"
37#include "signs_base.h"
38#include "subsidy_base.h"
39#include "subsidy_func.h"
40#include "station_base.h"
41#include "waypoint_base.h"
42#include "economy_base.h"
43#include "core/pool_func.hpp"
44#include "core/backup_type.hpp"
46#include "cargo_type.h"
47#include "water.h"
48#include "game/game.hpp"
49#include "cargomonitor.h"
50#include "goal_base.h"
51#include "story_base.h"
52#include "linkgraph/refresh.h"
53#include "company_cmd.h"
54#include "economy_cmd.h"
55#include "vehicle_cmd.h"
56#include "timer/timer.h"
59
60#include "table/strings.h"
61#include "table/pricebase.h"
62
63#include "safeguards.h"
64
65
66/* Initialize the cargo payment-pool */
69
70
81static inline int32_t BigMulS(const int32_t a, const int32_t b, const uint8_t shift)
82{
83 return (int32_t)((int64_t)a * (int64_t)b >> shift);
84}
85
86typedef std::vector<Industry *> SmallIndustryList;
87
92 ScoreInfo(100, 120), // ScoreID::Vehicles
93 ScoreInfo(100, 80), // ScoreID::Stations
94 ScoreInfo(100, 10000), // ScoreID::MinProfit
95 ScoreInfo(50, 50000), // ScoreID::MinIncome
96 ScoreInfo(100, 100000), // ScoreID::MaxIncome
97 ScoreInfo(400, 40000), // ScoreID::Delivered
98 ScoreInfo(50, 8), // ScoreID::Cargo
99 ScoreInfo(50, 10000000), // ScoreID::Money
100 ScoreInfo(50, 250000), // ScoreID::Loan
101 ScoreInfo(0, 0), // ScoreID::Total
102};
103
104TypedIndexContainer<std::array<EnumClassIndexContainer<std::array<int64_t, to_underlying(ScoreID::End)>, ScoreID>, MAX_COMPANIES>, CompanyID> _score_part;
105Economy _economy;
107static PriceMultipliers _price_base_multiplier;
108
116{
117 Owner owner = c->index;
118
119 uint num = 0;
120
121 for (const Station *st : Station::Iterate()) {
122 if (st->owner == owner) num += st->facilities.Count();
123 }
124
125 Money value = num * _price[Price::StationValue] * 25;
126
127 for (const Vehicle *v : Vehicle::Iterate()) {
128 if (v->owner != owner) continue;
129
130 if (v->type == VEH_TRAIN ||
131 v->type == VEH_ROAD ||
132 (v->type == VEH_AIRCRAFT && Aircraft::From(v)->IsNormalAircraft()) ||
133 v->type == VEH_SHIP) {
134 value += v->value * 3 >> 1;
135 }
136 }
137
138 return value;
139}
140
150Money CalculateCompanyValue(const Company *c, bool including_loan)
151{
152 Money value = CalculateCompanyAssetValue(c);
153
154 /* Add real money value */
155 if (including_loan) value -= c->current_loan;
156 value += c->money;
157
158 return std::max<Money>(value, 1);
159}
160
178{
179 Money value = CalculateCompanyAssetValue(c);
180
181 value += c->current_loan;
182 /* Negative balance is basically a loan. */
183 if (c->money < 0) {
184 value += -c->money;
185 }
186
187 for (int quarter = 0; quarter < 4; quarter++) {
188 value += std::max<Money>(c->old_economy[quarter].income + c->old_economy[quarter].expenses, 0) * 2;
189 }
190
191 return std::max<Money>(value, 1);
192}
193
203{
204 Owner owner = c->index;
205 int score = 0;
206
207 _score_part[owner].fill(0);
208
209 /* Count vehicles */
210 {
211 Money min_profit = 0;
212 bool min_profit_first = true;
213 uint num = 0;
214
215 for (const Vehicle *v : Vehicle::Iterate()) {
216 if (v->owner != owner) continue;
217 if (IsCompanyBuildableVehicleType(v->type) && v->IsPrimaryVehicle()) {
218 if (v->profit_last_year > 0) num++; // For the vehicle score only count profitable vehicles
219 if (v->economy_age > VEHICLE_PROFIT_MIN_AGE) {
220 /* Find the vehicle with the lowest amount of profit */
221 if (min_profit_first || min_profit > v->profit_last_year) {
222 min_profit = v->profit_last_year;
223 min_profit_first = false;
224 }
225 }
226 }
227 }
228
229 min_profit >>= 8; // remove the fract part
230
231 _score_part[owner][ScoreID::Vehicles] = num;
232 /* Don't allow negative min_profit to show */
233 if (min_profit > 0) {
234 _score_part[owner][ScoreID::MinProfit] = min_profit;
235 }
236 }
237
238 /* Count stations */
239 {
240 uint num = 0;
241 for (const Station *st : Station::Iterate()) {
242 /* Only count stations that are actually serviced */
243 if (st->owner == owner && (st->time_since_load <= 20 || st->time_since_unload <= 20)) num += st->facilities.Count();
244 }
245 _score_part[owner][ScoreID::Stations] = num;
246 }
247
248 /* Generate statistics depending on recent income statistics */
249 {
250 int numec = std::min<uint>(c->num_valid_stat_ent, 12u);
251 if (numec != 0) {
252 auto [min_income, max_income] = std::ranges::minmax(c->old_economy | std::views::take(numec) | std::views::transform([](const auto &ce) { return ce.income + ce.expenses; }));
253
254 if (min_income > 0) _score_part[owner][ScoreID::MinIncome] = min_income;
255 _score_part[owner][ScoreID::MaxIncome] = max_income;
256 }
257 }
258
259 /* Generate score depending on amount of transported cargo */
260 {
261 int numec = std::min<uint>(c->num_valid_stat_ent, 4u);
262 if (numec != 0) {
263 OverflowSafeInt64 total_delivered = 0;
264 for (auto &ce : c->old_economy | std::views::take(numec)) total_delivered += ce.delivered_cargo.GetSum<OverflowSafeInt64>();
265
266 _score_part[owner][ScoreID::Delivered] = total_delivered;
267 }
268 }
269
270 /* Generate score for variety of cargo */
271 {
272 _score_part[owner][ScoreID::Cargo] = c->old_economy[0].delivered_cargo.GetCount();
273 }
274
275 /* Generate score for company's money */
276 {
277 if (c->money > 0) {
278 _score_part[owner][ScoreID::Money] = c->money;
279 }
280 }
281
282 /* Generate score for loan */
283 {
284 _score_part[owner][ScoreID::Loan] = _score_info[ScoreID::Loan].needed - c->current_loan;
285 }
286
287 /* Now we calculate the score for each item.. */
288 {
289 int total_score = 0;
290 int s;
291 score = 0;
292 for (ScoreID i = ScoreID::Begin; i < ScoreID::End; i++) {
293 /* Skip the total */
294 if (i == ScoreID::Total) continue;
295 /* Check the score */
296 s = Clamp<int64_t>(_score_part[owner][i], 0, _score_info[i].needed) * _score_info[i].score / _score_info[i].needed;
297 score += s;
298 total_score += _score_info[i].score;
299 }
300
301 _score_part[owner][ScoreID::Total] = score;
302
303 /* We always want the score scaled to SCORE_MAX (1000) */
304 if (total_score != SCORE_MAX) score = score * SCORE_MAX / total_score;
305 }
306
307 if (update) {
308 c->old_economy[0].performance_history = score;
310 c->old_economy[0].company_value = CalculateCompanyValue(c);
311 }
312
314 return score;
315}
316
322void ChangeOwnershipOfCompanyItems(Owner old_owner, Owner new_owner)
323{
324 /* We need to set _current_company to old_owner before we try to move
325 * the client. This is needed as it needs to know whether "you" really
326 * are the current local company. */
327 Backup<CompanyID> cur_company(_current_company, old_owner);
328 /* In all cases, make spectators of clients connected to that company */
330 if (old_owner == _local_company) {
331 /* Single player cheated to AI company.
332 * There are no spectators in singleplayer mode, so we must pick some other company. */
333 assert(!_networking);
335 for (const Company *c : Company::Iterate()) {
336 if (c->index != old_owner) {
337 SetLocalCompany(c->index);
338 break;
339 }
340 }
341 cur_company2.Restore();
342 assert(old_owner != _local_company);
343 }
344
345 assert(old_owner != new_owner);
346
347 /* Temporarily increase the company's money, to be sure that
348 * removing their property doesn't fail because of lack of money.
349 * Not too drastically though, because it could overflow */
350 if (new_owner == INVALID_OWNER) {
351 Company::Get(old_owner)->money = UINT64_MAX >> 2; // jackpot ;p
352 }
353
354 for (Subsidy *s : Subsidy::Iterate()) {
355 if (s->awarded == old_owner) {
356 if (new_owner == INVALID_OWNER) {
357 delete s;
358 } else {
359 s->awarded = new_owner;
360 }
361 }
362 }
364
365 /* Take care of rating and transport rights in towns */
366 for (Town *t : Town::Iterate()) {
367 /* If a company takes over, give the ratings to that company. */
368 if (new_owner != INVALID_OWNER) {
369 if (t->have_ratings.Test(old_owner)) {
370 if (t->have_ratings.Test(new_owner)) {
371 /* use max of the two ratings. */
372 t->ratings[new_owner] = std::max(t->ratings[new_owner], t->ratings[old_owner]);
373 } else {
374 t->have_ratings.Set(new_owner);
375 t->ratings[new_owner] = t->ratings[old_owner];
376 }
377 }
378 }
379
380 /* Reset the ratings for the old owner */
381 t->ratings[old_owner] = RATING_INITIAL;
382 t->have_ratings.Reset(old_owner);
383
384 /* Transfer exclusive rights */
385 if (t->exclusive_counter > 0 && t->exclusivity == old_owner) {
386 if (new_owner != INVALID_OWNER) {
387 t->exclusivity = new_owner;
388 } else {
389 t->exclusive_counter = 0;
390 t->exclusivity = CompanyID::Invalid();
391 }
392 }
393 }
394
395 {
396 for (Vehicle *v : Vehicle::Iterate()) {
397 if (v->owner == old_owner && IsCompanyBuildableVehicleType(v->type)) {
398 if (new_owner == INVALID_OWNER) {
399 if (v->Previous() == nullptr) delete v;
400 } else {
401 if (v->IsEngineCountable()) GroupStatistics::CountEngine(v, -1);
402 if (v->IsPrimaryVehicle()) GroupStatistics::CountVehicle(v, -1);
403 }
404 }
405 }
406 }
407
408 /* In all cases clear replace engine rules.
409 * Even if it was copied, it could interfere with new owner's rules */
411
412 if (new_owner == INVALID_OWNER) {
413 RemoveAllGroupsForCompany(old_owner);
414 } else {
415 Company *c = Company::Get(new_owner);
416 for (Group *g : Group::Iterate()) {
417 if (g->owner == old_owner) {
418 g->owner = new_owner;
419 g->number = c->freegroups.UseID(c->freegroups.NextID());
420 }
421 }
422 }
423
424 {
425 Company *new_company = new_owner == INVALID_OWNER ? nullptr : Company::Get(new_owner);
426
427 /* Override company settings to new company defaults in case we need to convert them.
428 * This is required as the CmdChangeServiceInt doesn't copy the supplied value when it is non-custom
429 */
430 if (new_owner != INVALID_OWNER) {
431 Company *old_company = Company::Get(old_owner);
432
434 old_company->settings.vehicle.servint_trains = new_company->settings.vehicle.servint_trains;
436 old_company->settings.vehicle.servint_ships = new_company->settings.vehicle.servint_ships;
438 }
439
440 for (Vehicle *v : Vehicle::Iterate()) {
441 if (v->owner == old_owner && IsCompanyBuildableVehicleType(v->type)) {
442 assert(new_owner != INVALID_OWNER);
443
444 /* Correct default values of interval settings while maintaining custom set ones.
445 * This prevents invalid values on mismatching company defaults being accepted.
446 */
447 if (!v->ServiceIntervalIsCustom()) {
448 /* Technically, passing the interval is not needed as the command will query the default value itself.
449 * However, do not rely on that behaviour.
450 */
451 int interval = CompanyServiceInterval(new_company, v->type);
452 Command<Commands::ChangeServiceInterval>::Do({DoCommandFlag::Execute, DoCommandFlag::Bankrupt}, v->index, interval, false, new_company->settings.vehicle.servint_ispercent);
453 }
454
455 v->owner = new_owner;
456
457 /* Owner changes, clear cache */
458 v->colourmap = PAL_NONE;
459 v->InvalidateNewGRFCache();
460
461 if (v->IsEngineCountable()) {
463 }
464 if (v->IsPrimaryVehicle()) {
466 auto &unitidgen = new_company->freeunits[v->type];
467 v->unitnumber = unitidgen.UseID(unitidgen.NextID());
468 }
469 }
470 }
471
472 if (new_owner != INVALID_OWNER) GroupStatistics::UpdateAutoreplace(new_owner);
473 }
474
475 /* Change ownership of tiles */
476 {
477 for (const auto tile : Map::Iterate()) {
478 ChangeTileOwner(tile, old_owner, new_owner);
479 }
480
481 if (new_owner != INVALID_OWNER) {
482 /* Update all signals because there can be new segment that was owned by two companies
483 * and signals were not propagated
484 * Similar with crossings - it is needed to bar crossings that weren't before
485 * because of different owner of crossing and approaching train */
486 for (const auto tile : Map::Iterate()) {
487 if (IsTileType(tile, TileType::Railway) && IsTileOwner(tile, new_owner) && HasSignals(tile)) {
488 TrackBits tracks = GetTrackBits(tile);
489 do { // there may be two tracks with signals for TRACK_BIT_HORZ and TRACK_BIT_VERT
490 Track track = RemoveFirstTrack(&tracks);
491 if (HasSignalOnTrack(tile, track)) AddTrackToSignalBuffer(tile, track, new_owner);
492 } while (tracks != TRACK_BIT_NONE);
493 } else if (IsLevelCrossingTile(tile) && IsTileOwner(tile, new_owner)) {
495 }
496 }
497 }
498
499 /* update signals in buffer */
501 }
502
503 /* Add airport infrastructure count of the old company to the new one. */
504 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.airport += Company::Get(old_owner)->infrastructure.airport;
505
506 /* convert owner of stations (including deleted ones, but excluding buoys) */
507 for (Station *st : Station::Iterate()) {
508 if (st->owner == old_owner) {
509 /* if a company goes bankrupt, set owner to OWNER_NONE so the sign doesn't disappear immediately
510 * also, drawing station window would cause reading invalid company's colour */
511 st->owner = new_owner == INVALID_OWNER ? OWNER_NONE : new_owner;
512 }
513 }
514
515 /* do the same for waypoints (we need to do this here so deleted waypoints are converted too) */
516 for (Waypoint *wp : Waypoint::Iterate()) {
517 if (wp->owner == old_owner) {
518 wp->owner = new_owner == INVALID_OWNER ? OWNER_NONE : new_owner;
519 }
520 }
521
522 for (Sign *si : Sign::Iterate()) {
523 if (si->owner == old_owner) si->owner = new_owner == INVALID_OWNER ? OWNER_NONE : new_owner;
524 }
525
526 /* Remove Game Script created Goals, CargoMonitors and Story pages. */
527 for (Goal *g : Goal::Iterate()) {
528 if (g->company == old_owner) delete g;
529 }
530
533
534 for (StoryPage *sp : StoryPage::Iterate()) {
535 if (sp->company == old_owner) delete sp;
536 }
537
538 /* Change colour of existing windows */
539 if (new_owner != INVALID_OWNER) ChangeWindowOwner(old_owner, new_owner);
540
541 cur_company.Restore();
542
544}
545
551{
552 /* If "Infinite money" setting is on, companies should not go bankrupt. */
553 if (_settings_game.difficulty.infinite_money) return;
554
555 /* If the company has money again, it does not go bankrupt */
556 if (c->money - c->current_loan >= -c->GetMaxLoan()) {
557 int previous_months_of_bankruptcy = CeilDiv(c->months_of_bankruptcy, 3);
560 if (previous_months_of_bankruptcy != 0) CompanyAdminUpdate(c);
561 return;
562 }
563
565
566 switch (c->months_of_bankruptcy) {
567 /* All the boring cases (months) with a bad balance where no action is taken */
568 case 0:
569 case 1:
570 case 2:
571 case 3:
572
573 case 5:
574 case 6:
575
576 case 8:
577 case 9:
578 break;
579
580 /* Warn about bankruptcy after 3 months */
581 case 4: {
582 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_IN_TROUBLE_TITLE, c);
583 EncodedString headline = GetEncodedString(STR_NEWS_COMPANY_IN_TROUBLE_DESCRIPTION, cni->company_name);
584 AddCompanyNewsItem(std::move(headline), std::move(cni));
585 AI::BroadcastNewEvent(new ScriptEventCompanyInTrouble(c->index));
586 Game::NewEvent(new ScriptEventCompanyInTrouble(c->index));
587 break;
588 }
589
590 /* Offer company for sale after 6 months */
591 case 7: {
592 /* Don't consider the loan */
593 Money val = CalculateCompanyValue(c, false);
594
595 c->bankrupt_value = val;
596 c->bankrupt_asked = CompanyMask{}.Set(c->index); // Don't ask the owner
597 c->bankrupt_timeout = 0;
598
599 /* The company assets should always have some value */
600 assert(c->bankrupt_value > 0);
601 break;
602 }
603
604 /* Bankrupt company after 6 months (if the company has no value) or latest
605 * after 9 months (if it still had value after 6 months) */
606 default:
607 case 10: {
608 if (!_networking && _local_company == c->index) {
609 /* If we are in singleplayer mode, leave the company playing. Eg. there
610 * is no THE-END, otherwise mark the client as spectator to make sure
611 * they are no longer in control of this company. However... when you
612 * join another company (cheat) the "unowned" company can bankrupt. */
613 c->bankrupt_asked.Set();
614 break;
615 }
616
617 /* Actually remove the company, but not when we're a network client.
618 * In case of network clients we will be getting a command from the
619 * server. It is done in this way as we are called from the
620 * StateGameLoop which can't change the current company, and thus
621 * updating the local company triggers an assert later on. In the
622 * case of a network game the command will be processed at a time
623 * that changing the current company is okay. In case of single
624 * player we are sure (the above check) that we are not the local
625 * company and thus we won't be moved. */
627 Command<Commands::CompanyControl>::Post(CompanyCtrlAction::Delete, c->index, CompanyRemoveReason::Bankrupt, INVALID_CLIENT_ID);
628 return;
629 }
630 break;
631 }
632 }
633
635}
636
642{
643 /* Check for bankruptcy each month */
644 for (Company *c : Company::Iterate()) {
646 }
647
648 /* Pay Infrastructure Maintenance, if enabled */
649 if (_settings_game.economy.infrastructure_maintenance) {
650 /* Improved monthly infrastructure costs. */
651 for (const Company *c : Company::Iterate()) {
653 uint32_t rail_total = c->infrastructure.GetRailTotal();
654 for (RailType rt = RAILTYPE_BEGIN; rt < RAILTYPE_END; rt++) {
655 if (c->infrastructure.rail[rt] != 0) cost.AddCost(RailMaintenanceCost(rt, c->infrastructure.rail[rt], rail_total));
656 }
657 cost.AddCost(SignalMaintenanceCost(c->infrastructure.signal));
658 uint32_t road_total = c->infrastructure.GetRoadTotal();
659 uint32_t tram_total = c->infrastructure.GetTramTotal();
660 for (RoadType rt = ROADTYPE_BEGIN; rt < ROADTYPE_END; rt++) {
661 if (c->infrastructure.road[rt] != 0) cost.AddCost(RoadMaintenanceCost(rt, c->infrastructure.road[rt], RoadTypeIsRoad(rt) ? road_total : tram_total));
662 }
663 cost.AddCost(CanalMaintenanceCost(c->infrastructure.water));
664 cost.AddCost(StationMaintenanceCost(c->infrastructure.station));
665 cost.AddCost(AirportMaintenanceCost(c->index));
666
667 SubtractMoneyFromCompany(c->index, cost);
668 }
669 }
670
671 /* Only run the economic statistics and update company stats every 3rd economy month (1st of quarter). */
672 if (!HasBit(1 << 0 | 1 << 3 | 1 << 6 | 1 << 9, TimerGameEconomy::month)) return;
673
674 for (Company *c : Company::Iterate()) {
675 /* Drop the oldest history off the end */
676 std::copy_backward(c->old_economy.data(), c->old_economy.data() + MAX_HISTORY_QUARTERS - 1, c->old_economy.data() + MAX_HISTORY_QUARTERS);
677 c->old_economy[0] = c->cur_economy;
678 c->cur_economy = {};
679
680 if (c->num_valid_stat_ent != MAX_HISTORY_QUARTERS) c->num_valid_stat_ent++;
681
683 if (c->block_preview != 0) c->block_preview--;
684 }
685
692}
693
699bool AddInflation(bool check_year)
700{
701 /* The cargo payment inflation differs from the normal inflation, so the
702 * relative amount of money you make with a transport decreases slowly over
703 * the 170 years. After a few hundred years we reach a level in which the
704 * games will become unplayable as the maximum income will be less than
705 * the minimum running cost.
706 *
707 * Furthermore there are a lot of inflation related overflows all over the
708 * place. Solving them is hardly possible because inflation will always
709 * reach the overflow threshold some day. So we'll just perform the
710 * inflation mechanism during the first 170 years (the amount of years that
711 * one had in the original TTD) and stop doing the inflation after that
712 * because it only causes problems that can't be solved nicely and the
713 * inflation doesn't add anything after that either; it even makes playing
714 * it impossible due to the diverging cost and income rates.
715 */
717
718 if (_economy.inflation_prices == MAX_INFLATION || _economy.inflation_payment == MAX_INFLATION) return true;
719
720 /* Approximation for (100 + infl_amount)% ** (1 / 12) - 100%
721 * scaled by 65536
722 * 12 -> months per year
723 * This is only a good approximation for small values
724 */
725 _economy.inflation_prices += (_economy.inflation_prices * _economy.infl_amount * 54) >> 16;
726 _economy.inflation_payment += (_economy.inflation_payment * _economy.infl_amount_pr * 54) >> 16;
727
728 if (_economy.inflation_prices > MAX_INFLATION) _economy.inflation_prices = MAX_INFLATION;
729 if (_economy.inflation_payment > MAX_INFLATION) _economy.inflation_payment = MAX_INFLATION;
730
731 return false;
732}
733
738{
739 /* Setup maximum loan as a rounded down multiple of LOAN_INTERVAL. */
740 _economy.max_loan = ((uint64_t)_settings_game.difficulty.max_loan * _economy.inflation_prices >> 16) / LOAN_INTERVAL * LOAN_INTERVAL;
741
742 /* Setup price bases */
743 for (Price i = Price::Begin; i < Price::End; i++) {
744 Money price = _price_base_specs[i].start_price;
745
746 /* Apply difficulty settings */
747 uint mod = 1;
748 switch (_price_base_specs[i].category) {
749 case PCAT_RUNNING:
750 mod = _settings_game.difficulty.vehicle_costs;
751 break;
752
754 mod = _settings_game.difficulty.construction_cost;
755 break;
756
757 default: break;
758 }
759 switch (mod) {
760 case 0: price *= 6; break;
761 case 1: price *= 8; break; // normalised to 1 below
762 case 2: price *= 9; break;
763 default: NOT_REACHED();
764 }
765
766 /* Apply inflation */
767 price = (int64_t)price * _economy.inflation_prices;
768
769 /* Apply newgrf modifiers, remove fractional part of inflation, and normalise on medium difficulty. */
770 int shift = _price_base_multiplier[i] - 16 - 3;
771 if (shift >= 0) {
772 price <<= shift;
773 } else {
774 price >>= -shift;
775 }
776
777 /* Make sure the price does not get reduced to zero.
778 * Zero breaks quite a few commands that use a zero
779 * cost to see whether something got changed or not
780 * and based on that cause an error. When the price
781 * is zero that fails even when things are done. */
782 if (price == 0) {
783 price = Clamp(_price_base_specs[i].start_price, -1, 1);
784 /* No base price should be zero, but be sure. */
785 assert(price != 0);
786 }
787 /* Store value */
788 _price[i] = price;
789 }
790
791 /* Setup cargo payment */
792 for (CargoSpec *cs : CargoSpec::Iterate()) {
793 cs->current_payment = (cs->initial_payment * (int64_t)_economy.inflation_payment) >> 16;
794 }
795
801}
802
805{
806 for (const Company *c : Company::Iterate()) {
807 /* Over a year the paid interest should be "loan * interest percentage",
808 * but... as that number is likely not dividable by 12 (pay each month),
809 * one needs to account for that in the monthly fee calculations.
810 *
811 * To easily calculate what one should pay "this" month, you calculate
812 * what (total) should have been paid up to this month and you subtract
813 * whatever has been paid in the previous months. This will mean one month
814 * it'll be a bit more and the other it'll be a bit less than the average
815 * monthly fee, but on average it will be exact.
816 *
817 * In order to prevent cheating or abuse (just not paying interest by not
818 * taking a loan) we make companies pay interest on negative cash as well,
819 * except if infinite money is enabled.
820 */
821 Money yearly_fee = c->current_loan * _economy.interest_rate / 100;
822 Money available_money = GetAvailableMoney(c->index);
823 if (available_money < 0) {
824 yearly_fee += -available_money * _economy.interest_rate / 100;
825 }
826 Money up_to_previous_month = yearly_fee * TimerGameEconomy::month / 12;
827 Money up_to_this_month = yearly_fee * (TimerGameEconomy::month + 1) / 12;
828
829 SubtractMoneyFromCompany(c->index, CommandCost(EXPENSES_LOAN_INTEREST, up_to_this_month - up_to_previous_month));
830
832 }
833}
834
835static void HandleEconomyFluctuations()
836{
837 if (_settings_game.difficulty.economy != 0) {
838 /* When economy is Fluctuating, decrease counter */
839 _economy.fluct--;
840 } else if (EconomyIsInRecession()) {
841 /* When it's Steady and we are in recession, end it now */
842 _economy.fluct = -12;
843 } else {
844 /* No need to do anything else in other cases */
845 return;
846 }
847
848 if (_economy.fluct == 0) {
849 _economy.fluct = -(int)GB(Random(), 0, 2);
850 AddNewsItem(GetEncodedString(STR_NEWS_BEGIN_OF_RECESSION), NewsType::Economy, NewsStyle::Normal, {});
851 } else if (_economy.fluct == -12) {
852 _economy.fluct = GB(Random(), 0, 8) + 312;
853 AddNewsItem(GetEncodedString(STR_NEWS_END_OF_RECESSION), NewsType::Economy, NewsStyle::Normal, {});
854 }
855}
856
857
862{
863 _price_base_multiplier.fill(0);
864}
865
873void SetPriceBaseMultiplier(Price price, int factor)
874{
875 assert(price < Price::End);
876 _price_base_multiplier[price] = Clamp(factor, MIN_PRICE_MODIFIER, MAX_PRICE_MODIFIER);
877}
878
883void StartupIndustryDailyChanges(bool init_counter)
884{
885 uint map_size = Map::LogX() + Map::LogY();
886 /* After getting map size, it needs to be scaled appropriately and divided by 31,
887 * which stands for the days in a month.
888 * Using just 31 will make it so that a monthly reset (based on the real number of days of that month)
889 * would not be needed.
890 * Since it is based on "fractional parts", the leftover days will not make much of a difference
891 * on the overall total number of changes performed */
892 _economy.industry_daily_increment = (1 << map_size) / 31;
893
894 if (init_counter) {
895 /* A new game or a savegame from an older version will require the counter to be initialized */
896 _economy.industry_daily_change_counter = 0;
897 }
898}
899
900void StartupEconomy()
901{
902 _economy.interest_rate = _settings_game.difficulty.initial_interest;
903 _economy.infl_amount = _settings_game.difficulty.initial_interest;
904 _economy.infl_amount_pr = std::max(0, _settings_game.difficulty.initial_interest - 1);
905 _economy.fluct = GB(Random(), 0, 8) + 168;
906
907 if (_settings_game.economy.inflation) {
908 /* Apply inflation that happened before our game start year. */
910 for (int i = 0; i < months; i++) {
911 AddInflation(false);
912 }
913 }
914
915 /* Set up prices */
917
918 StartupIndustryDailyChanges(true); // As we are starting a new game, initialize the counter too
919
920}
921
926{
927 _economy.inflation_prices = _economy.inflation_payment = 1 << 16;
930}
931
940Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
941{
942 if (index >= Price::End) return 0;
943
944 Money cost = _price[index] * cost_factor;
945 if (grf_file != nullptr) shift += grf_file->price_base_multipliers[index];
946
947 if (shift >= 0) {
948 cost <<= shift;
949 } else {
950 cost >>= -shift;
951 }
952
953 return cost;
954}
955
956Money GetTransportedGoodsIncome(uint num_pieces, uint dist, uint16_t transit_periods, CargoType cargo_type)
957{
958 const CargoSpec *cs = CargoSpec::Get(cargo_type);
959 if (!cs->IsValid()) {
960 /* User changed newgrfs and some vehicle still carries some cargo which is no longer available. */
961 return 0;
962 }
963
964 /* Use callback to calculate cargo profit, if available */
966 uint32_t var18 = ClampTo<uint16_t>(dist) | (ClampTo<uint8_t>(num_pieces) << 16) | (ClampTo<uint8_t>(transit_periods) << 24);
967 uint16_t callback = GetCargoCallback(CBID_CARGO_PROFIT_CALC, 0, var18, cs);
968 if (callback != CALLBACK_FAILED) {
969 int result = GB(callback, 0, 14);
970
971 /* Simulate a 15 bit signed value */
972 if (HasBit(callback, 14)) result -= 0x4000;
973
974 /* "The result should be a signed multiplier that gets multiplied
975 * by the amount of cargo moved and the price factor, then gets
976 * divided by 8192." */
977 return result * num_pieces * cs->current_payment / 8192;
978 }
979 }
980
981 static const int MIN_TIME_FACTOR = 31;
982 static const int MAX_TIME_FACTOR = 255;
983 static const int TIME_FACTOR_FRAC_BITS = 4;
984 static const int TIME_FACTOR_FRAC = 1 << TIME_FACTOR_FRAC_BITS;
985
986 const int periods1 = cs->transit_periods[0];
987 const int periods2 = cs->transit_periods[1];
988 const int periods_over_periods1 = std::max(transit_periods - periods1, 0);
989 const int periods_over_periods2 = std::max(periods_over_periods1 - periods2, 0);
990 int periods_over_max = MIN_TIME_FACTOR - MAX_TIME_FACTOR;
991 if (periods2 > -periods_over_max) {
992 periods_over_max += transit_periods - periods1;
993 } else {
994 periods_over_max += 2 * (transit_periods - periods1) - periods2;
995 }
996
997 /*
998 * The time factor is calculated based on the time it took
999 * (transit_periods) compared two cargo-depending values. The
1000 * range is divided into four parts:
1001 *
1002 * - constant for fast transits
1003 * - linear decreasing with time with a slope of -1 for medium transports
1004 * - linear decreasing with time with a slope of -2 for slow transports
1005 * - after hitting MIN_TIME_FACTOR, the time factor will be asymptotically decreased to a limit of 1 with a scaled 1/(x+1) function.
1006 *
1007 */
1008 if (periods_over_max > 0) {
1009 const int time_factor = std::max(2 * MIN_TIME_FACTOR * TIME_FACTOR_FRAC * TIME_FACTOR_FRAC / (periods_over_max + 2 * TIME_FACTOR_FRAC), 1); // MIN_TIME_FACTOR / (x/(2 * TIME_FACTOR_FRAC) + 1) + 1, expressed as fixed point with TIME_FACTOR_FRAC_BITS.
1010 return BigMulS(dist * time_factor * num_pieces, cs->current_payment, 21 + TIME_FACTOR_FRAC_BITS);
1011 } else {
1012 const int time_factor = std::max(MAX_TIME_FACTOR - periods_over_periods1 - periods_over_periods2, MIN_TIME_FACTOR);
1013 return BigMulS(dist * time_factor * num_pieces, cs->current_payment, 21);
1014 }
1015}
1016
1018static SmallIndustryList _cargo_delivery_destinations;
1019
1030static uint DeliverGoodsToIndustry(const Station *st, CargoType cargo_type, uint num_pieces, IndustryID source, CompanyID company)
1031{
1032 /* Find the nearest industrytile to the station sign inside the catchment area, whose industry accepts the cargo.
1033 * This fails in three cases:
1034 * 1) The station accepts the cargo because there are enough houses around it accepting the cargo.
1035 * 2) The industries in the catchment area temporarily reject the cargo, and the daily station loop has not yet updated station acceptance.
1036 * 3) The results of callbacks CBID_INDUSTRY_REFUSE_CARGO and CBID_INDTILE_CARGO_ACCEPTANCE are inconsistent. (documented behaviour)
1037 */
1038
1039 uint accepted = 0;
1040
1041 for (const auto &i : st->industries_near) {
1042 if (num_pieces == 0) break;
1043
1044 Industry *ind = i.industry;
1045 if (ind->index == source) continue;
1046
1047 auto it = ind->GetCargoAccepted(cargo_type);
1048 /* Check if matching cargo has been found */
1049 if (it == std::end(ind->accepted)) continue;
1050
1051 /* Check if industry temporarily refuses acceptance */
1052 if (IndustryTemporarilyRefusesCargo(ind, cargo_type)) continue;
1053
1054 if (ind->exclusive_supplier != INVALID_OWNER && ind->exclusive_supplier != st->owner) continue;
1055
1056 /* Insert the industry into _cargo_delivery_destinations, if not yet contained */
1058
1059 uint amount = std::min(num_pieces, 0xFFFFu - it->waiting);
1060 it->waiting += amount;
1061 it->GetOrCreateHistory()[THIS_MONTH].accepted += amount;
1062 it->last_accepted = TimerGameEconomy::date;
1063 num_pieces -= amount;
1064 accepted += amount;
1065
1066 /* Update the cargo monitor. */
1067 AddCargoDelivery(cargo_type, company, amount, {source, SourceType::Industry}, st, ind->index);
1068 }
1069
1070 return accepted;
1071}
1072
1085static Money DeliverGoods(int num_pieces, CargoType cargo_type, StationID dest, uint distance, uint16_t periods_in_transit, Company *company, Source src)
1086{
1087 assert(num_pieces > 0);
1088
1089 Station *st = Station::Get(dest);
1090
1091 /* Give the goods to the industry. */
1092 uint accepted_ind = DeliverGoodsToIndustry(st, cargo_type, num_pieces, src.type == SourceType::Industry ? src.ToIndustryID() : IndustryID::Invalid(), company->index);
1093
1094 /* If this cargo type is always accepted, accept all */
1095 uint accepted_total = HasBit(st->always_accepted, cargo_type) ? num_pieces : accepted_ind;
1096
1097 /* Update station statistics */
1098 if (accepted_total > 0) {
1100 }
1101
1102 /* Update company statistics */
1103 company->cur_economy.delivered_cargo[cargo_type] += accepted_total;
1104
1105 /* Increase town's counter for town effects */
1106 const CargoSpec *cs = CargoSpec::Get(cargo_type);
1107 st->town->received[cs->town_acceptance_effect].new_act += accepted_total;
1108
1109 /* Determine profit */
1110 Money profit = GetTransportedGoodsIncome(accepted_total, distance, periods_in_transit, cargo_type);
1111
1112 /* Update the cargo monitor. */
1113 AddCargoDelivery(cargo_type, company->index, accepted_total - accepted_ind, src, st);
1114
1115 /* Modify profit if a subsidy is in effect */
1116 if (CheckSubsidised(cargo_type, company->index, src, st)) {
1117 switch (_settings_game.difficulty.subsidy_multiplier) {
1118 case 0: profit += profit >> 1; break;
1119 case 1: profit *= 2; break;
1120 case 2: profit *= 3; break;
1121 default: profit *= 4; break;
1122 }
1123 }
1124
1125 return profit;
1126}
1127
1134{
1135 const IndustrySpec *indspec = GetIndustrySpec(i->type);
1136 IndustryCallbackMasks cbm = indspec->callback_mask;
1137
1138 i->was_cargo_delivered = true;
1139
1143 } else {
1145 }
1146 } else {
1147 for (auto ita = std::begin(i->accepted); ita != std::end(i->accepted); ++ita) {
1148 if (ita->waiting == 0 || !IsValidCargoType(ita->cargo)) continue;
1149
1150 for (auto itp = std::begin(i->produced); itp != std::end(i->produced); ++itp) {
1151 if (!IsValidCargoType(itp->cargo)) continue;
1152 itp->waiting = ClampTo<uint16_t>(itp->waiting + (ita->waiting * indspec->input_cargo_multiplier[ita - std::begin(i->accepted)][itp - std::begin(i->produced)] / 256));
1153 }
1154
1155 ita->waiting = 0;
1156 }
1157 }
1158
1160 TriggerIndustryAnimation(i, IndustryAnimationTrigger::CargoReceived);
1161}
1162
1168CargoPayment::CargoPayment(CargoPaymentID index, Vehicle *front) :
1170 current_station(front->last_station_visited),
1171 front(front)
1172{
1173}
1174
1177{
1178 if (CleaningPool()) return;
1179
1180 this->front->cargo_payment = nullptr;
1181
1182 if (this->visual_profit == 0 && this->visual_transfer == 0) return;
1183
1184 Backup<CompanyID> cur_company(_current_company, this->front->owner);
1185
1186 SubtractMoneyFromCompany(_current_company, CommandCost(this->front->GetExpenseType(true), -this->route_profit));
1187 this->front->profit_this_year += (this->visual_profit + this->visual_transfer) << 8;
1188
1189 if (this->route_profit != 0 && IsLocalCompany() && !PlayVehicleSound(this->front, VSE_LOAD_UNLOAD)) {
1190 SndPlayVehicleFx(SND_14_CASHTILL, this->front);
1191 }
1192
1193 if (this->visual_transfer != 0) {
1194 ShowFeederIncomeAnimation(this->front->x_pos, this->front->y_pos,
1195 this->front->z_pos, this->visual_transfer, -this->visual_profit);
1196 } else {
1197 ShowCostOrIncomeAnimation(this->front->x_pos, this->front->y_pos,
1198 this->front->z_pos, -this->visual_profit);
1199 }
1200
1201 cur_company.Restore();
1202}
1203
1211void CargoPayment::PayFinalDelivery(CargoType cargo, const CargoPacket *cp, uint count, TileIndex current_tile)
1212{
1213 /* Handle end of route payment */
1214 Money profit = DeliverGoods(count, cargo, this->current_station, cp->GetDistance(current_tile), cp->GetPeriodsInTransit(), Company::Get(this->front->owner), cp->GetSource());
1215 this->route_profit += profit;
1216
1217 /* The vehicle's profit is whatever route profit there is minus feeder shares. */
1218 this->visual_profit += profit - cp->GetFeederShare(count);
1219}
1220
1229Money CargoPayment::PayTransfer(CargoType cargo, const CargoPacket *cp, uint count, TileIndex current_tile)
1230{
1231 /* Pay transfer vehicle the difference between the payment for the journey from
1232 * the source to the current point, and the sum of the previous transfer payments */
1233 Money profit = -cp->GetFeederShare(count) + GetTransportedGoodsIncome(
1234 count,
1235 cp->GetDistance(current_tile),
1236 cp->GetPeriodsInTransit(),
1237 cargo);
1238
1239 profit = profit * _settings_game.economy.feeder_payment_share / 100;
1240
1241 this->visual_transfer += profit; // accumulate transfer profits for whole vehicle
1242 return profit; // account for the (virtual) profit already made for the cargo packet
1243}
1244
1250{
1251 Station *curr_station = Station::Get(front_v->last_station_visited);
1252 curr_station->loading_vehicles.push_back(front_v);
1253
1254 /* At this moment loading cannot be finished */
1256
1257 /* Start unloading at the first possible moment */
1258 front_v->load_unload_ticks = 1;
1259
1260 assert(front_v->cargo_payment == nullptr);
1261 /* One CargoPayment per vehicle and the vehicle limit equals the
1262 * limit in number of CargoPayments. Can't go wrong. */
1265 front_v->cargo_payment = CargoPayment::Create(front_v);
1266
1267 std::vector<StationID> next_station;
1268 front_v->GetNextStoppingStation(next_station);
1269 if (front_v->orders == nullptr || front_v->current_order.GetUnloadType() != OrderUnloadType::NoUnload) {
1271 for (Vehicle *v = front_v; v != nullptr; v = v->Next()) {
1272 const GoodsEntry *ge = &st->goods[v->cargo_type];
1273 if (v->cargo_cap > 0 && v->cargo.TotalCount() > 0) {
1274 v->cargo.Stage(
1276 front_v->last_station_visited, next_station,
1277 front_v->current_order.GetUnloadType(), ge,
1278 v->cargo_type, front_v->cargo_payment,
1279 v->GetCargoTile());
1280 if (v->cargo.UnloadCount() > 0) v->vehicle_flags.Set(VehicleFlag::CargoUnloading);
1281 }
1282 }
1283 }
1284}
1285
1292static uint GetLoadAmount(Vehicle *v)
1293{
1294 const Engine *e = v->GetEngine();
1295 uint load_amount = e->info.load_amount;
1296
1297 /* The default loadamount for mail is 1/4 of the load amount for passengers */
1298 bool air_mail = v->type == VEH_AIRCRAFT && !Aircraft::From(v)->IsNormalAircraft();
1299 if (air_mail) load_amount = CeilDiv(load_amount, 4);
1300
1301 if (_settings_game.order.gradual_loading) {
1302 uint16_t cb_load_amount = CALLBACK_FAILED;
1303 if (e->GetGRF() != nullptr && e->GetGRF()->grf_version >= 8) {
1304 /* Use callback 36 */
1305 cb_load_amount = GetVehicleProperty(v, PROP_VEHICLE_LOAD_AMOUNT, CALLBACK_FAILED);
1307 /* Use callback 12 */
1308 cb_load_amount = GetVehicleCallback(CBID_VEHICLE_LOAD_AMOUNT, 0, 0, v->engine_type, v);
1309 }
1310 if (cb_load_amount != CALLBACK_FAILED) {
1311 if (e->GetGRF()->grf_version < 8) cb_load_amount = GB(cb_load_amount, 0, 8);
1312 if (cb_load_amount >= 0x100) {
1314 } else if (cb_load_amount != 0) {
1315 load_amount = cb_load_amount;
1316 }
1317 }
1318 }
1319
1320 /* Scale load amount the same as capacity */
1321 if (e->info.misc_flags.Test(EngineMiscFlag::NoDefaultCargoMultiplier) && !air_mail) load_amount = CeilDiv(load_amount * CargoSpec::Get(v->cargo_type)->multiplier, 0x100);
1322
1323 /* Zero load amount breaks a lot of things. */
1324 return std::max(1u, load_amount);
1325}
1326
1336template <class Taction>
1337bool IterateVehicleParts(Vehicle *v, Taction action)
1338{
1339 for (Vehicle *w = v; w != nullptr;
1340 w = w->HasArticulatedPart() ? w->GetNextArticulatedPart() : nullptr) {
1341 if (!action(w)) return false;
1342 if (w->type == VEH_TRAIN) {
1343 Train *train = Train::From(w);
1344 if (train->IsMultiheaded() && !action(train->other_multiheaded_part)) return false;
1345 }
1346 }
1347 if (v->type == VEH_AIRCRAFT && Aircraft::From(v)->IsNormalAircraft()) return action(v->Next());
1348 return true;
1349}
1350
1355{
1361 bool operator()(const Vehicle *v)
1362 {
1363 return v->cargo.StoredCount() == 0;
1364 }
1365};
1366
1371{
1373 CargoTypes &refit_mask;
1374
1382
1389 bool operator()(const Vehicle *v)
1390 {
1391 this->consist_capleft[v->cargo_type] -= v->cargo_cap - v->cargo.ReservedCount();
1392 this->refit_mask |= EngInfo(v->engine_type)->refit_mask;
1393 return true;
1394 }
1395};
1396
1401{
1403 StationID next_hop;
1404
1410 ReturnCargoAction(Station *st, StationID next_one) : st(st), next_hop(next_one) {}
1411
1418 {
1419 v->cargo.Return(UINT_MAX, &this->st->goods[v->cargo_type].GetOrCreateData().cargo, this->next_hop, v->GetCargoTile());
1420 return true;
1421 }
1422};
1423
1428{
1431 std::span<const StationID> next_station;
1433
1443
1451 {
1452 if (this->do_reserve) {
1453 this->st->goods[v->cargo_type].GetOrCreateData().cargo.Reserve(v->cargo_cap - v->cargo.RemainingCount(),
1454 &v->cargo, this->next_station, v->GetCargoTile());
1455 }
1456 this->consist_capleft[v->cargo_type] += v->cargo_cap - v->cargo.RemainingCount();
1457 return true;
1458 }
1459};
1460
1469static void HandleStationRefit(Vehicle *v, CargoArray &consist_capleft, Station *st, std::span<const StationID> next_station, CargoType new_cargo_type)
1470{
1471 Vehicle *v_start = v->GetFirstEnginePart();
1472 if (!IterateVehicleParts(v_start, IsEmptyAction())) return;
1473
1474 Backup<CompanyID> cur_company(_current_company, v->owner);
1475
1476 CargoTypes refit_mask = v->GetEngine()->info.refit_mask;
1477
1478 /* Remove old capacity from consist capacity and collect refit mask. */
1479 IterateVehicleParts(v_start, PrepareRefitAction(consist_capleft, refit_mask));
1480
1481 bool is_auto_refit = new_cargo_type == CARGO_AUTO_REFIT;
1482 if (is_auto_refit) {
1483 /* Get a refittable cargo type with waiting cargo for next_station or StationID::Invalid(). */
1484 new_cargo_type = v_start->cargo_type;
1485 for (CargoType cargo_type : SetCargoBitIterator(refit_mask)) {
1486 if (st->goods[cargo_type].HasData() && st->goods[cargo_type].GetData().cargo.HasCargoFor(next_station)) {
1487 /* Try to find out if auto-refitting would succeed. In case the refit is allowed,
1488 * the returned refit capacity will be greater than zero. */
1489 auto [cc, refit_capacity, mail_capacity, cargo_capacities] = Command<Commands::RefitVehicle>::Do(DoCommandFlag::QueryCost, v_start->index, cargo_type, 0xFF, true, false, 1); // Auto-refit and only this vehicle including artic parts.
1490 /* Try to balance different loadable cargoes between parts of the consist, so that
1491 * all of them can be loaded. Avoid a situation where all vehicles suddenly switch
1492 * to the first loadable cargo for which there is only one packet. If the capacities
1493 * are equal refit to the cargo of which most is available. This is important for
1494 * consists of only a single vehicle as those will generally have a consist_capleft
1495 * of 0 for all cargoes. */
1496 if (refit_capacity > 0 && (consist_capleft[cargo_type] < consist_capleft[new_cargo_type] ||
1497 (consist_capleft[cargo_type] == consist_capleft[new_cargo_type] &&
1498 st->goods[cargo_type].AvailableCount() > st->goods[new_cargo_type].AvailableCount()))) {
1499 new_cargo_type = cargo_type;
1500 }
1501 }
1502 }
1503 }
1504
1505 /* Refit if given a valid cargo. */
1506 if (new_cargo_type < NUM_CARGO && new_cargo_type != v_start->cargo_type) {
1507 /* StationID::Invalid() because in the DistributionType::Manual case that's correct and in the DT_(A)SYMMETRIC
1508 * cases the next hop of the vehicle doesn't really tell us anything if the cargo had been
1509 * "via any station" before reserving. We rather produce some more "any station" cargo than
1510 * misrouting it. */
1511 IterateVehicleParts(v_start, ReturnCargoAction(st, StationID::Invalid()));
1512 CommandCost cost = std::get<0>(Command<Commands::RefitVehicle>::Do(DoCommandFlag::Execute, v_start->index, new_cargo_type, 0xFF, true, false, 1)); // Auto-refit and only this vehicle including artic parts.
1513 if (cost.Succeeded()) v->First()->profit_this_year -= cost.GetCost() << 8;
1514 }
1515
1516 /* Add new capacity to consist capacity and reserve cargo */
1517 IterateVehicleParts(v_start, FinalizeRefitAction(consist_capleft, st, next_station,
1518 is_auto_refit || v->First()->current_order.IsFullLoadOrder()));
1519
1520 cur_company.Restore();
1521}
1522
1529static bool MayLoadUnderExclusiveRights(const Station *st, const Vehicle *v)
1530{
1531 return st->owner != OWNER_NONE || st->town->exclusive_counter == 0 || st->town->exclusivity == v->owner;
1532}
1533
1534struct ReserveCargoAction {
1535 Station *st;
1536 std::span<const StationID> next_station;
1537
1538 ReserveCargoAction(Station *st, std::span<const StationID> next_station) :
1539 st(st), next_station(next_station) {}
1540
1541 bool operator()(Vehicle *v)
1542 {
1544 st->goods[v->cargo_type].GetOrCreateData().cargo.Reserve(v->cargo_cap - v->cargo.RemainingCount(),
1545 &v->cargo, next_station, v->GetCargoTile());
1546 }
1547
1548 return true;
1549 }
1550
1551};
1552
1561static void ReserveConsist(Station *st, Vehicle *u, CargoArray *consist_capleft, std::span<const StationID> next_station)
1562{
1563 /* If there is a cargo payment not all vehicles of the consist have tried to do the refit.
1564 * In that case, only reserve if it's a fixed refit and the equivalent of "articulated chain"
1565 * a vehicle belongs to already has the right cargo. */
1566 bool must_reserve = !u->current_order.IsRefit() || u->cargo_payment == nullptr;
1567 for (Vehicle *v = u; v != nullptr; v = v->Next()) {
1568 assert(v->cargo_cap >= v->cargo.RemainingCount());
1569
1570 /* Exclude various ways in which the vehicle might not be the head of an equivalent of
1571 * "articulated chain". Also don't do the reservation if the vehicle is going to refit
1572 * to a different cargo and hasn't tried to do so, yet. */
1573 if (!v->IsArticulatedPart() &&
1574 (v->type != VEH_TRAIN || !Train::From(v)->IsRearDualheaded()) &&
1575 (v->type != VEH_AIRCRAFT || Aircraft::From(v)->IsNormalAircraft()) &&
1576 (must_reserve || u->current_order.GetRefitCargo() == v->cargo_type)) {
1577 IterateVehicleParts(v, ReserveCargoAction(st, next_station));
1578 }
1579 if (consist_capleft == nullptr || v->cargo_cap == 0) continue;
1580 (*consist_capleft)[v->cargo_type] += v->cargo_cap - v->cargo.RemainingCount();
1581 }
1582}
1583
1591static void UpdateLoadUnloadTicks(Vehicle *front, const Station *st, int ticks)
1592{
1593 if (front->type == VEH_TRAIN && _settings_game.order.station_length_loading_penalty) {
1594 /* Each platform tile is worth 2 rail vehicles. */
1595 int overhang = front->GetGroundVehicleCache()->cached_total_length - st->GetPlatformLength(front->tile) * TILE_SIZE;
1596 if (overhang > 0) {
1597 ticks <<= 1;
1598 ticks += (overhang * ticks) / 8;
1599 }
1600 }
1601 /* Always wait at least 1, otherwise we'll wait 'infinitively' long. */
1602 front->load_unload_ticks = std::max(1, ticks);
1603}
1604
1609static void LoadUnloadVehicle(Vehicle *front)
1610{
1611 assert(front->current_order.IsType(OT_LOADING));
1612
1613 StationID last_visited = front->last_station_visited;
1614 Station *st = Station::Get(last_visited);
1615
1616 std::vector<StationID> next_station;
1617 front->GetNextStoppingStation(next_station);
1618 bool use_autorefit = front->current_order.IsRefit() && front->current_order.GetRefitCargo() == CARGO_AUTO_REFIT;
1619 CargoArray consist_capleft{};
1620 if (_settings_game.order.improved_load && use_autorefit ?
1621 front->cargo_payment == nullptr : (front->current_order.IsFullLoadOrder())) {
1622 ReserveConsist(st, front,
1623 (use_autorefit && front->load_unload_ticks != 0) ? &consist_capleft : nullptr,
1624 next_station);
1625 }
1626
1627 /* We have not waited enough time till the next round of loading/unloading */
1628 if (front->load_unload_ticks != 0) return;
1629
1630 if (front->type == VEH_TRAIN && (!IsTileType(front->tile, TileType::Station) || GetStationIndex(front->tile) != st->index)) {
1631 /* The train reversed in the station. Take the "easy" way
1632 * out and let the train just leave as it always did. */
1634 front->load_unload_ticks = 1;
1635 return;
1636 }
1637
1638 int new_load_unload_ticks = 0;
1639 bool dirty_vehicle = false;
1640 bool dirty_station = false;
1641
1642 bool completely_emptied = true;
1643 bool anything_unloaded = false;
1644 bool anything_loaded = false;
1645 CargoTypes full_load_amount = 0;
1646 CargoTypes cargo_not_full = 0;
1647 CargoTypes cargo_full = 0;
1648 CargoTypes reservation_left = 0;
1649
1650 front->cur_speed = 0;
1651
1652 CargoPayment *payment = front->cargo_payment;
1653
1654 uint artic_part = 0; // Articulated part we are currently trying to load. (not counting parts without capacity)
1655 for (Vehicle *v = front; v != nullptr; v = v->Next()) {
1656 if (v == front || !v->Previous()->HasArticulatedPart()) artic_part = 0;
1657 if (v->cargo_cap == 0) continue;
1658 artic_part++;
1659
1660 GoodsEntry *ge = &st->goods[v->cargo_type];
1661
1662 if (v->vehicle_flags.Test(VehicleFlag::CargoUnloading) && front->current_order.GetUnloadType() != OrderUnloadType::NoUnload) {
1663 uint cargo_count = v->cargo.UnloadCount();
1664 uint amount_unloaded = _settings_game.order.gradual_loading ? std::min(cargo_count, GetLoadAmount(v)) : cargo_count;
1665 bool remaining = false; // Are there cargo entities in this vehicle that can still be unloaded here?
1666
1667 if (!ge->status.Test(GoodsEntry::State::Acceptance) && v->cargo.ActionCount(VehicleCargoList::MTA_DELIVER) > 0) {
1668 /* The station does not accept our goods anymore. */
1670 /* Transfer instead of delivering. */
1672 v->cargo.ActionCount(VehicleCargoList::MTA_DELIVER));
1673 } else {
1674 uint new_remaining = v->cargo.RemainingCount() + v->cargo.ActionCount(VehicleCargoList::MTA_DELIVER);
1675 if (v->cargo_cap < new_remaining) {
1676 /* Return some of the reserved cargo to not overload the vehicle. */
1677 v->cargo.Return(new_remaining - v->cargo_cap, &ge->GetOrCreateData().cargo, StationID::Invalid(), v->GetCargoTile());
1678 }
1679
1680 /* Keep instead of delivering. This may lead to no cargo being unloaded, so ...*/
1682 v->cargo.ActionCount(VehicleCargoList::MTA_DELIVER));
1683
1684 /* ... say we unloaded something, otherwise we'll think we didn't unload
1685 * something and we didn't load something, so we must be finished
1686 * at this station. Setting the unloaded means that we will get a
1687 * retry for loading in the next cycle. */
1688 anything_unloaded = true;
1689 }
1690 }
1691
1692 if (v->cargo.ActionCount(VehicleCargoList::MTA_TRANSFER) > 0) {
1693 /* Mark the station dirty if we transfer, but not if we only deliver. */
1694 dirty_station = true;
1695
1696 if (!ge->HasRating()) {
1697 /* Upon transferring cargo, make sure the station has a rating. Fake a pickup for the
1698 * first unload to prevent the cargo from quickly decaying after the initial drop. */
1699 ge->time_since_pickup = 0;
1701 }
1702 }
1703
1704 assert(payment != nullptr);
1705 amount_unloaded = v->cargo.Unload(amount_unloaded, &ge->GetOrCreateData().cargo, v->cargo_type, payment, v->GetCargoTile());
1706 remaining = v->cargo.UnloadCount() > 0;
1707 if (amount_unloaded > 0) {
1708 dirty_vehicle = true;
1709 anything_unloaded = true;
1710 new_load_unload_ticks += amount_unloaded;
1711
1712 /* Deliver goods to the station */
1713 st->time_since_unload = 0;
1714 }
1715
1716 if (_settings_game.order.gradual_loading && remaining) {
1717 completely_emptied = false;
1718 } else {
1719 /* We have finished unloading (cargo count == 0) */
1720 v->vehicle_flags.Reset(VehicleFlag::CargoUnloading);
1721 }
1722
1723 continue;
1724 }
1725
1726 /* Do not pick up goods when we have no-load set or loading is stopped. */
1728
1729 /* This order has a refit, if this is the first vehicle part carrying cargo and the whole vehicle is empty, try refitting. */
1730 if (front->current_order.IsRefit() && artic_part == 1) {
1731 HandleStationRefit(v, consist_capleft, st, next_station, front->current_order.GetRefitCargo());
1732 ge = &st->goods[v->cargo_type];
1733 }
1734
1735 /* As we're loading here the following link can carry the full capacity of the vehicle. */
1736 v->refit_cap = v->cargo_cap;
1737
1738 /* update stats */
1739 int t;
1740 switch (front->type) {
1741 case VEH_TRAIN:
1742 case VEH_SHIP:
1743 t = front->vcache.cached_max_speed;
1744 break;
1745
1746 case VEH_ROAD:
1747 t = front->vcache.cached_max_speed / 2;
1748 break;
1749
1750 case VEH_AIRCRAFT:
1751 t = Aircraft::From(front)->GetSpeedOldUnits(); // Convert to old units.
1752 break;
1753
1754 default: NOT_REACHED();
1755 }
1756
1757 /* if last speed is 0, we treat that as if no vehicle has ever visited the station. */
1760
1761 assert(v->cargo_cap >= v->cargo.StoredCount());
1762 /* Capacity available for loading more cargo. */
1763 uint cap_left = v->cargo_cap - v->cargo.StoredCount();
1764
1765 if (cap_left > 0) {
1766 /* If vehicle can load cargo, reset time_since_pickup. */
1767 ge->time_since_pickup = 0;
1768
1769 /* If there's goods waiting at the station, and the vehicle
1770 * has capacity for it, load it on the vehicle. */
1771 if ((v->cargo.ActionCount(VehicleCargoList::MTA_LOAD) > 0 || ge->AvailableCount() > 0) && MayLoadUnderExclusiveRights(st, v)) {
1772 if (v->cargo.StoredCount() == 0) TriggerVehicleRandomisation(v, VehicleRandomTrigger::NewCargo);
1773 if (_settings_game.order.gradual_loading) cap_left = std::min(cap_left, GetLoadAmount(v));
1774
1775 uint loaded = ge->GetOrCreateData().cargo.Load(cap_left, &v->cargo, next_station, v->GetCargoTile());
1776 if (v->cargo.ActionCount(VehicleCargoList::MTA_LOAD) > 0) {
1777 /* Remember if there are reservations left so that we don't stop
1778 * loading before they're loaded. */
1779 SetBit(reservation_left, v->cargo_type);
1780 }
1781
1782 /* Store whether the maximum possible load amount was loaded or not.*/
1783 if (loaded == cap_left) {
1784 SetBit(full_load_amount, v->cargo_type);
1785 } else {
1786 ClrBit(full_load_amount, v->cargo_type);
1787 }
1788
1789 /* TODO: Regarding this, when we do gradual loading, we
1790 * should first unload all vehicles and then start
1791 * loading them. Since this will cause
1792 * VEHICLE_TRIGGER_EMPTY to be called at the time when
1793 * the whole vehicle chain is really totally empty, the
1794 * completely_emptied assignment can then be safely
1795 * removed; that's how TTDPatch behaves too. --pasky */
1796 if (loaded > 0) {
1797 completely_emptied = false;
1798 anything_loaded = true;
1799
1800 st->time_since_load = 0;
1801 st->last_vehicle_type = v->type;
1802
1803 if (ge->GetData().cargo.TotalCount() == 0) {
1805 TriggerStationAnimation(st, st->xy, StationAnimationTrigger::CargoTaken, v->cargo_type);
1806 TriggerAirportAnimation(st, AirportAnimationTrigger::CargoTaken, v->cargo_type);
1808 TriggerRoadStopAnimation(st, st->xy, StationAnimationTrigger::CargoTaken, v->cargo_type);
1809 }
1810
1811 new_load_unload_ticks += loaded;
1812
1813 dirty_vehicle = dirty_station = true;
1814 }
1815 }
1816 }
1817
1818 if (v->cargo.StoredCount() >= v->cargo_cap) {
1819 SetBit(cargo_full, v->cargo_type);
1820 } else {
1821 SetBit(cargo_not_full, v->cargo_type);
1822 }
1823 }
1824
1825 if (anything_loaded || anything_unloaded) {
1826 if (front->type == VEH_TRAIN) {
1828 TriggerStationAnimation(st, front->tile, StationAnimationTrigger::VehicleLoads);
1829 } else if (front->type == VEH_ROAD) {
1831 TriggerRoadStopAnimation(st, front->tile, StationAnimationTrigger::VehicleLoads);
1832 }
1833 }
1834
1835 /* Only set completely_emptied, if we just unloaded all remaining cargo */
1836 completely_emptied &= anything_unloaded;
1837
1838 if (!anything_unloaded) delete payment;
1839
1841 if (anything_loaded || anything_unloaded) {
1842 if (_settings_game.order.gradual_loading) {
1843 /* The time it takes to load one 'slice' of cargo or passengers depends
1844 * on the vehicle type - the values here are those found in TTDPatch */
1845 const uint gradual_loading_wait_time[] = { 40, 20, 10, 20 };
1846
1847 new_load_unload_ticks = gradual_loading_wait_time[front->type];
1848 }
1849 /* We loaded less cargo than possible for all cargo types and it's not full
1850 * load and we're not supposed to wait any longer: stop loading. */
1851 if (!anything_unloaded && full_load_amount == 0 && reservation_left == 0 && !front->current_order.IsFullLoadOrder() &&
1852 front->current_order_time >= std::max(front->current_order.GetTimetabledWait() - front->lateness_counter, 0)) {
1854 }
1855
1856 UpdateLoadUnloadTicks(front, st, new_load_unload_ticks);
1857 } else {
1858 UpdateLoadUnloadTicks(front, st, 20); // We need the ticks for link refreshing.
1859 bool finished_loading = true;
1860 if (front->current_order.IsFullLoadOrder()) {
1862 /* if the aircraft carries passengers and is NOT full, then
1863 * continue loading, no matter how much mail is in */
1864 if ((front->type == VEH_AIRCRAFT && IsCargoInClass(front->cargo_type, CargoClass::Passengers) && front->cargo_cap > front->cargo.StoredCount()) ||
1865 (cargo_not_full != 0 && (cargo_full & ~cargo_not_full) == 0)) { // There are still non-full cargoes
1866 finished_loading = false;
1867 }
1868 } else if (cargo_not_full != 0) {
1869 finished_loading = false;
1870 }
1871
1872 /* Refresh next hop stats if we're full loading to make the links
1873 * known to the distribution algorithm and allow cargo to be sent
1874 * along them. Otherwise the vehicle could wait for cargo
1875 * indefinitely if it hasn't visited the other links yet, or if the
1876 * links die while it's loading. */
1877 if (!finished_loading) LinkRefresher::Run(front, true, true);
1878 }
1879
1880 front->vehicle_flags.Set(VehicleFlag::LoadingFinished, finished_loading);
1881 }
1882
1883 /* Calculate the loading indicator fill percent and display
1884 * In the Game Menu do not display indicators
1885 * If _settings_client.gui.loading_indicators == 2, show indicators (bool can be promoted to int as 0 or 1 - results in 2 > 0,1 )
1886 * if _settings_client.gui.loading_indicators == 1, _local_company must be the owner or must be a spectator to show ind., so 1 > 0
1887 * if _settings_client.gui.loading_indicators == 0, do not display indicators ... 0 is never greater than anything
1888 */
1889 if (_game_mode != GM_MENU && (_settings_client.gui.loading_indicators > (uint)(front->owner != _local_company && _local_company != COMPANY_SPECTATOR))) {
1890 StringID percent_up_down = STR_NULL;
1891 int percent = CalcPercentVehicleFilled(front, &percent_up_down);
1892 if (front->fill_percent_te_id == INVALID_TE_ID) {
1893 front->fill_percent_te_id = ShowFillingPercent(front->x_pos, front->y_pos, front->z_pos + 20, percent, percent_up_down);
1894 } else {
1895 UpdateFillingPercent(front->fill_percent_te_id, percent, percent_up_down);
1896 }
1897 }
1898
1899 if (completely_emptied) {
1900 /* Make sure the vehicle is marked dirty, since we need to update the NewGRF
1901 * properties such as weight, power and TE whenever the trigger runs. */
1902 dirty_vehicle = true;
1903 TriggerVehicleRandomisation(front, VehicleRandomTrigger::Empty);
1904 }
1905
1906 if (dirty_vehicle) {
1908 SetWindowDirty(WC_VEHICLE_DETAILS, front->index);
1909 front->MarkDirty();
1910 }
1911 if (dirty_station) {
1912 st->MarkTilesDirty(true);
1913 SetWindowDirty(WC_STATION_VIEW, st->index);
1915 }
1916}
1917
1924{
1925 /* No vehicle is here... */
1926 if (st->loading_vehicles.empty()) return;
1927
1928 Vehicle *last_loading = nullptr;
1929
1930 /* Check if anything will be loaded at all. Otherwise we don't need to reserve either. */
1931 for (Vehicle *v : st->loading_vehicles) {
1932 if (v->vehstatus.Any({VehState::Stopped, VehState::Crashed})) continue;
1933
1934 assert(v->load_unload_ticks != 0);
1935 if (--v->load_unload_ticks == 0) last_loading = v;
1936 }
1937
1938 /* We only need to reserve and load/unload up to the last loading vehicle.
1939 * Anything else will be forgotten anyway after returning from this function.
1940 *
1941 * Especially this means we do _not_ need to reserve cargo for a single
1942 * consist in a station which is not allowed to load yet because its
1943 * load_unload_ticks is still not 0.
1944 */
1945 if (last_loading == nullptr) return;
1946
1947 for (Vehicle *v : st->loading_vehicles) {
1948 if (!v->vehstatus.Any({VehState::Stopped, VehState::Crashed})) LoadUnloadVehicle(v);
1949 if (v == last_loading) break;
1950 }
1951
1952 /* Call the production machinery of industries */
1955 }
1957}
1958
1962static const IntervalTimer<TimerGameCalendar> _calendar_inflation_monthly({TimerGameCalendar::Trigger::Month, TimerGameCalendar::Priority::Company}, [](auto)
1963{
1964 if (_settings_game.economy.inflation) {
1965 AddInflation();
1967 }
1968});
1969
1973static const IntervalTimer<TimerGameEconomy> _economy_companies_monthly({ TimerGameEconomy::Trigger::Month, TimerGameEconomy::Priority::Company }, [](auto)
1974{
1977 HandleEconomyFluctuations();
1978});
1979
1980static void DoAcquireCompany(Company *c, bool hostile_takeover)
1981{
1982 CompanyID ci = c->index;
1983
1984 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_MERGER_TITLE, c, Company::Get(_current_company));
1985 EncodedString headline = hostile_takeover
1986 ? GetEncodedString(STR_NEWS_MERGER_TAKEOVER_TITLE, cni->company_name, cni->other_company_name)
1987 : GetEncodedString(STR_NEWS_COMPANY_MERGER_DESCRIPTION, cni->company_name, cni->other_company_name, c->bankrupt_value);
1988 AddCompanyNewsItem(std::move(headline), std::move(cni));
1989 AI::BroadcastNewEvent(new ScriptEventCompanyMerger(ci, _current_company));
1990 Game::NewEvent(new ScriptEventCompanyMerger(ci, _current_company));
1991
1993
1994 if (c->is_ai) AI::Stop(c->index);
1995
2002
2003 delete c;
2004}
2005
2016CommandCost CmdBuyCompany(DoCommandFlags flags, CompanyID target_company, bool hostile_takeover)
2017{
2018 Company *c = Company::GetIfValid(target_company);
2019 if (c == nullptr) return CMD_ERROR;
2020
2021 /* If you do a hostile takeover but the company went bankrupt, buy it via bankruptcy rules. */
2022 if (hostile_takeover && c->bankrupt_asked.Test(_current_company)) hostile_takeover = false;
2023
2024 /* Disable takeovers when not asked */
2025 if (!hostile_takeover && !c->bankrupt_asked.Test(_current_company)) return CMD_ERROR;
2026
2027 /* Only allow hostile takeover of AI companies and when in single player */
2028 if (hostile_takeover && !c->is_ai) return CMD_ERROR;
2029 if (hostile_takeover && _networking) return CMD_ERROR;
2030
2031 /* Disable taking over the local company in singleplayer mode */
2032 if (!_networking && _local_company == c->index) return CMD_ERROR;
2033
2034 /* Do not allow companies to take over themselves */
2035 if (target_company == _current_company) return CMD_ERROR;
2036
2037 /* Do not allow takeover if the resulting company would have too many vehicles. */
2038 if (!CheckTakeoverVehicleLimit(_current_company, target_company)) return CommandCost(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
2039
2040 /* Get the cost here as the company is deleted in DoAcquireCompany.
2041 * For bankruptcy this amount is calculated when the offer was made;
2042 * for hostile takeover you pay the current price. */
2043 CommandCost cost(EXPENSES_OTHER, hostile_takeover ? CalculateHostileTakeoverValue(c) : c->bankrupt_value);
2044
2045 if (flags.Test(DoCommandFlag::Execute)) {
2046 DoAcquireCompany(c, hostile_takeover);
2047 }
2048 return cost;
2049}
Base functions for all AIs.
Base for aircraft.
Functions related to autoreplacing.
void RemoveAllEngineReplacementForCompany(Company *c)
Remove all engine replacement settings for the given company.
Class for backupping variables and making sure they are restored later.
@ StopLoading
Don't load anymore during the next load cycle.
@ LoadingFinished
Vehicle has finished loading.
@ CargoUnloading
Vehicle is unloading cargo.
static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
Types related to cargoes...
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:21
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
Definition cargo_type.h:108
static const CargoType CARGO_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
Definition cargo_type.h:76
void ClearCargoDeliveryMonitoring(CompanyID company)
Clear all delivery cargo monitors.
void ClearCargoPickupMonitoring(CompanyID company)
Clear all pick-up cargo monitors.
void AddCargoDelivery(CargoType cargo_type, CompanyID company, uint32_t amount, Source src, const Station *st, IndustryID dest)
Cargo was delivered to its final destination, update the pickup and delivery maps.
Cargo transport monitoring declarations.
@ Passengers
Passengers.
Definition cargotype.h:50
bool IsCargoInClass(CargoType cargo, CargoClasses cc)
Does cargo c have cargo class cc?
Definition cargotype.h:235
static void BroadcastNewEvent(ScriptEvent *event, CompanyID skip_company=CompanyID::Invalid())
Broadcast a new event to all active AIs.
Definition ai_core.cpp:255
static void Stop(CompanyID company)
Stop a company to be controlled by an AI.
Definition ai_core.cpp:107
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
Common return value for all commands.
bool Succeeded() const
Did this command succeed?
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Money GetCost() const
The costs as made up to this moment.
Container for an encoded string, created by GetEncodedString.
uint32_t GetGRFID() const
Retrieve the GRF ID of the NewGRF the engine is tied to.
Definition engine.cpp:160
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
A sort-of mixin that implements 'at(pos)' and 'operator[](pos)' only for a specific enum class.
UnitID UseID(UnitID index)
Use a unit number.
Definition vehicle.cpp:1884
UnitID NextID() const
Find first unused unit number.
Definition vehicle.cpp:1869
static void NewEvent(class ScriptEvent *event)
Queue a new event for the game script.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
static void Run(Vehicle *v, bool allow_merge=true, bool is_full_loading=false)
Refresh all links the given vehicle will visit.
Definition refresh.cpp:26
uint TotalCount() const
Returns total count of cargo at the station, including cargo which is already reserved for loading.
uint Load(uint max_move, VehicleCargoList *dest, std::span< const StationID > next, TileIndex current_tile)
Loads cargo onto a vehicle.
static Year year
Current year, starting at 0.
static constexpr TimerGame< struct Calendar >::Year ORIGINAL_MAX_YEAR
static constexpr TimerGame< struct Calendar >::Year ORIGINAL_BASE_YEAR
static Date date
Current date in days (day counter).
static Month month
Current month (0..11).
A sort-of mixin that implements 'at(pos)' and 'operator[](pos)' only for a specific type.
uint Return(uint max_move, StationCargoList *dest, StationID next_station, TileIndex current_tile)
Returns reserved cargo to the station and removes it from the cache.
uint ReservedCount() const
Returns sum of reserved cargo.
uint RemainingCount() const
Returns the sum of cargo to be kept in the vehicle at the current station.
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ QueryCost
query cost only, don't build.
@ Execute
execute the given command
@ Bankrupt
company bankrupts, skip money check, skip vehicle on tile check in some cases
int CompanyServiceInterval(const Company *c, VehicleType type)
Get the service interval for the given company and vehicle type.
static void SubtractMoneyFromCompany(Company *c, const CommandCost &cost)
Deduct costs of a command from the money of a company.
void CompanyAdminUpdate(const Company *company)
Called whenever company related information changes in order to notify admins.
Money GetAvailableMoney(CompanyID company)
Get the amount of money that a company has available, or INT64_MAX if there is no such valid company.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
bool CheckTakeoverVehicleLimit(CompanyID cbig, CompanyID csmall)
Can company cbig buy company csmall without exceeding vehicle limits?
void SetLocalCompany(CompanyID new_company)
Sets the local company and updates the settings that are set on a per-company basis to reflect the co...
CompanyID _current_company
Company currently doing an action.
Command definitions related to companies.
Functions related to companies.
bool IsLocalCompany()
Is the current company the local company?
GUI Functions related to companies.
void CloseCompanyWindows(CompanyID company)
Close all windows of a company.
Definition window.cpp:1238
@ Delete
Delete a company.
static constexpr CompanyID COMPANY_SPECTATOR
The client is spectating.
static const uint MAX_HISTORY_QUARTERS
The maximum number of quarters kept as performance's history.
static constexpr Owner OWNER_NONE
The tile has no ownership.
static constexpr Owner INVALID_OWNER
An invalid owner.
@ Bankrupt
The company went belly-up.
Some simple functions to help with accessing containers.
bool include(Container &container, typename Container::const_reference &item)
Helper function to append an item to a container if it is not already contained.
static bool MayLoadUnderExclusiveRights(const Station *st, const Vehicle *v)
Test whether a vehicle can load cargo at a station even if exclusive transport rights are present.
Definition economy.cpp:1529
static void UpdateLoadUnloadTicks(Vehicle *front, const Station *st, int ticks)
Update the vehicle's load_unload_ticks, the time it will wait until it tries to load or unload again.
Definition economy.cpp:1591
int UpdateCompanyRatingAndValue(Company *c, bool update)
if update is set to true, the economy is updated with this score (also the house is updated,...
Definition economy.cpp:202
const EnumClassIndexContainer< std::array< ScoreInfo, to_underlying(ScoreID::End)>, ScoreID > _score_info
Score info, values used for computing the detailed performance rating.
Definition economy.cpp:91
static void ReserveConsist(Station *st, Vehicle *u, CargoArray *consist_capleft, std::span< const StationID > next_station)
Reserves cargo if the full load order and improved_load is set or if the current order allows autoref...
Definition economy.cpp:1561
void ChangeOwnershipOfCompanyItems(Owner old_owner, Owner new_owner)
Change the ownership of all the items of a company.
Definition economy.cpp:322
static void CompaniesPayInterest()
Let all companies pay the monthly interest on their loan.
Definition economy.cpp:804
static const IntervalTimer< TimerGameEconomy > _economy_companies_monthly({ TimerGameEconomy::Trigger::Month, TimerGameEconomy::Priority::Company }, [](auto) { CompaniesGenStatistics();CompaniesPayInterest();HandleEconomyFluctuations();})
Every economy month update of company economic data, plus economy fluctuations.
static const IntervalTimer< TimerGameCalendar > _calendar_inflation_monthly({TimerGameCalendar::Trigger::Month, TimerGameCalendar::Priority::Company}, [](auto) { if(_settings_game.economy.inflation) { AddInflation();RecomputePrices();} })
Every calendar month update of inflation.
void LoadUnloadStation(Station *st)
Load/unload the vehicles in this station according to the order they entered.
Definition economy.cpp:1923
void RecomputePrices()
Computes all prices, payments and maximum loan.
Definition economy.cpp:737
static uint DeliverGoodsToIndustry(const Station *st, CargoType cargo_type, uint num_pieces, IndustryID source, CompanyID company)
Transfer goods from station to industry.
Definition economy.cpp:1030
static void LoadUnloadVehicle(Vehicle *front)
Loads/unload the vehicle if possible.
Definition economy.cpp:1609
Money CalculateHostileTakeoverValue(const Company *c)
Calculate what you have to pay to take over a company.
Definition economy.cpp:177
static Money CalculateCompanyAssetValue(const Company *c)
Calculate the value of the assets of a company.
Definition economy.cpp:115
static SmallIndustryList _cargo_delivery_destinations
The industries we've currently brought cargo to.
Definition economy.cpp:1018
void PrepareUnload(Vehicle *front_v)
Prepare the vehicle to be unloaded.
Definition economy.cpp:1249
static uint GetLoadAmount(Vehicle *v)
Gets the amount of cargo the given vehicle can load in the current tick.
Definition economy.cpp:1292
static void HandleStationRefit(Vehicle *v, CargoArray &consist_capleft, Station *st, std::span< const StationID > next_station, CargoType new_cargo_type)
Refit a vehicle in a station.
Definition economy.cpp:1469
void SetPriceBaseMultiplier(Price price, int factor)
Change a price base by the given factor.
Definition economy.cpp:873
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition economy.cpp:940
static void TriggerIndustryProduction(Industry *i)
Inform the industry about just delivered cargo DeliverGoodsToIndustry() silently incremented incoming...
Definition economy.cpp:1133
bool IterateVehicleParts(Vehicle *v, Taction action)
Iterate the articulated parts of a vehicle, also considering the special cases of "normal" aircraft a...
Definition economy.cpp:1337
static Money DeliverGoods(int num_pieces, CargoType cargo_type, StationID dest, uint distance, uint16_t periods_in_transit, Company *company, Source src)
Delivers goods to industries/towns and calculates the payment.
Definition economy.cpp:1085
Prices _price
Prices and also the fractional part.
Definition economy.cpp:106
static int32_t BigMulS(const int32_t a, const int32_t b, const uint8_t shift)
Multiply two integer values and shift the results to right.
Definition economy.cpp:81
void InitializeEconomy()
Resets economy to initial values.
Definition economy.cpp:925
static void CompanyCheckBankrupt(Company *c)
Check for bankruptcy of a company.
Definition economy.cpp:550
void ResetPriceBaseMultipliers()
Reset changes to the price base multipliers.
Definition economy.cpp:861
static void CompaniesGenStatistics()
Update the finances of all companies.
Definition economy.cpp:641
bool AddInflation(bool check_year)
Add monthly inflation.
Definition economy.cpp:699
CommandCost CmdBuyCompany(DoCommandFlags flags, CompanyID target_company, bool hostile_takeover)
Buy up another company.
Definition economy.cpp:2016
Money CalculateCompanyValue(const Company *c, bool including_loan)
Calculate the value of the company.
Definition economy.cpp:150
void StartupIndustryDailyChanges(bool init_counter)
Initialize the variables that will maintain the daily industry change system.
Definition economy.cpp:883
Base classes related to the economy.
Pool< CargoPayment, CargoPaymentID, 512 > CargoPaymentPool
Type of pool to store cargo payments in; little over 1 million.
CargoPaymentPool _cargo_payment_pool
The actual pool to store cargo payments in.
Command definitions related to the economy.
bool EconomyIsInRecession()
Is the economy in recession?
ScoreID
Score categories in the detailed performance rating.
@ Begin
The lowest valid value.
@ Delivered
Units of cargo delivered in the last four quaters.
@ MinIncome
Income in the quater with the lowest profit of the last 12 quaters.
@ Vehicles
Number of vehicles that turned profit last year.
@ End
Score ID end marker.
@ Stations
Number of recently-serviced stations.
@ Total
Total points out of possible points ,must always be the last entry.
@ Loan
The amount of money company can take as a loan.
@ MaxIncome
Income in the quater with the highest profit of the last 12 quaters.
@ MinProfit
The profit of the vehicle with the lowest income.
@ Money
Amount of money company has in the bank.
@ Cargo
Number of types of cargo delivered in the last four quaters.
static const int MIN_PRICE_MODIFIER
Maximum NewGRF price modifiers.
@ EXPENSES_PROPERTY
Property costs.
@ EXPENSES_OTHER
Other expenses.
@ EXPENSES_LOAN_INTEREST
Interest payments over the loan.
EnumClassIndexContainer< std::array< Money, to_underlying(Price::End)>, Price > Prices
Prices of everything.
@ PCAT_RUNNING
Price is affected by "vehicle running cost" difficulty setting.
@ PCAT_CONSTRUCTION
Price is affected by "construction cost" difficulty setting.
static const int LOAN_INTERVAL
The "steps" in loan size, in British Pounds!
static const uint64_t MAX_INFLATION
Maximum inflation (including fractional part) without causing overflows in int64_t price computations...
Price
Enumeration of all base prices for use with Prices.
@ Begin
The lowest valid value.
@ End
Price base end marker.
@ StationValue
Stations value and additional constant company running fee.
static constexpr int SCORE_MAX
The max score that can be in the performance history.
Base class for engines.
@ NoDefaultCargoMultiplier
Use the new capacity algorithm. The default cargotype of the vehicle does not affect capacity multipl...
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:21
Base functions for all Games.
Goal base class.
Base class and functions for all vehicles that move through ground.
void MarkTilesDirty(bool cargo_change) const
Marks the tiles of the station as dirty.
Definition station.cpp:250
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1554
virtual void MarkDirty()
Marks the vehicles to be redrawn and updates cached variables.
Base of all industries.
const IndustrySpec * GetIndustrySpec(IndustryType thistype)
Accessor for array _industry_specs.
@ CargoReceived
Cargo has been delivered.
@ CargoReceived
Trigger when cargo is received .
void ChangeTileOwner(TileIndex tile, Owner old_owner, Owner new_owner)
Change the owner of a tile.
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
constexpr To ClampTo(From value)
Clamp the given value down to lie within the requested type.
void ShowCostOrIncomeAnimation(int x, int y, int z, Money cost)
Display animated income or costs on the map.
Definition misc_gui.cpp:514
void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
Display animated feeder income.
Definition misc_gui.cpp:537
void UpdateFillingPercent(TextEffectID te_id, uint8_t percent, StringID string)
Update vehicle loading indicators.
Definition misc_gui.cpp:577
TextEffectID ShowFillingPercent(int x, int y, int z, uint8_t percent, StringID string)
Display vehicle loading indicators.
Definition misc_gui.cpp:562
bool _networking
are we in networking mode?
Definition network.cpp:67
bool _network_server
network-server is active
Definition network.cpp:68
Basic functions/variables used all over the place.
void NetworkClientsToSpectators(CompanyID cid)
Move the clients of a company to the spectators.
Network functions used by other parts of OpenTTD.
@ INVALID_CLIENT_ID
Client is not part of anything.
NewGRF handling of airport tiles.
@ ProfitCalc
custom profit calculation
@ Production256Ticks
call production callback every 256 ticks
@ ProductionCargoArrival
call production callback when cargo arrives at the industry
@ CBID_CARGO_PROFIT_CALC
Called to calculate the income of delivered cargo.
@ CBID_VEHICLE_LOAD_AMOUNT
Determine the amount of cargo to load per unit of time when using gradual loading.
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Cargo support for NewGRFs.
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
uint16_t GetVehicleCallback(CallbackID callback, uint32_t param1, uint32_t param2, EngineID engine, const Vehicle *v, std::span< int32_t > regs100)
Evaluate a newgrf callback for vehicles.
Functions for NewGRF engines.
void IndustryProductionCallback(Industry *ind, int reason)
Get the industry production callback and apply it to the industry.
bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoType cargo_type)
Check whether an industry temporarily refuses to accept a certain cargo.
void TriggerIndustryRandomisation(Industry *ind, IndustryRandomTrigger trigger)
Trigger a random trigger for all industry tiles.
NewGRF handling of industry tiles.
@ PROP_VEHICLE_LOAD_AMOUNT
Loading speed.
void TriggerRoadStopRandomisation(BaseStation *st, TileIndex tile, StationRandomTrigger trigger, CargoType cargo_type)
Trigger road stop randomisation.
NewGRF definitions and structures for road stops.
bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event, bool force)
Checks whether a NewGRF wants to play a different vehicle sound effect.
Functions related to NewGRF provided sounds.
@ VSE_LOAD_UNLOAD
Whenever cargo payment is made for a vehicle.
void TriggerStationRandomisation(BaseStation *st, TileIndex trigger_tile, StationRandomTrigger trigger, CargoType cargo_type)
Trigger station randomisation.
Header file for NewGRF stations.
Functions related to news.
void AddNewsItem(EncodedString &&headline, NewsType type, NewsStyle style, NewsFlags flags, NewsReference ref1={}, NewsReference ref2={}, std::unique_ptr< NewsAllocatedData > &&data=nullptr, AdviceType advice_type=AdviceType::Invalid)
Add a new newsitem to be shown.
Definition news_gui.cpp:914
@ Economy
Economic changes (recession, industry up/dowm).
Definition news_type.h:37
@ Normal
Normal news item. (Newspaper with text only).
Definition news_type.h:80
Functions related to objects.
void UpdateCompanyHQ(TileIndex tile, uint score)
Update the CompanyHQ to the state associated with the given score.
@ Transfer
Transfer all cargo onto the platform.
Definition order_type.h:70
@ NoUnload
Totally no unloading will be done.
Definition order_type.h:71
@ Unload
Force unloading all cargo onto the platform, possibly not getting paid.
Definition order_type.h:69
@ NoLoad
Do not load anything.
Definition order_type.h:81
@ FullLoadAny
Full load a single cargo of the consist.
Definition order_type.h:80
Some methods of Pool are placed here in order to reduce compilation time and binary size.
#define INSTANTIATE_POOL_METHODS(name)
Force instantiation of pool methods so we don't get linker errors.
Table of all default price bases.
Money RailMaintenanceCost(RailType railtype, uint32_t num, uint32_t total_num)
Calculates the maintenance cost of a number of track bits.
Definition rail.h:484
Money SignalMaintenanceCost(uint32_t num)
Calculates the maintenance cost of a number of signals.
Definition rail.h:495
TrackBits GetTrackBits(Tile tile)
Gets the track bits of the given tile.
Definition rail_map.h:136
bool HasSignalOnTrack(Tile tile, Track track)
Checks for the presence of signals (either way) on the given track on the given rail tile.
Definition rail_map.h:475
bool HasSignals(Tile t)
Checks if a rail tile has signals.
Definition rail_map.h:72
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:25
@ RAILTYPE_BEGIN
Used for iterations.
Definition rail_type.h:26
@ RAILTYPE_END
Used for iterations.
Definition rail_type.h:31
Declaration of link refreshing utility.
Money RoadMaintenanceCost(RoadType roadtype, uint32_t num, uint32_t total_num)
Calculates the maintenance cost of a number of road bits.
Definition road_func.h:125
void UpdateLevelCrossing(TileIndex tile, bool sound=true, bool force_bar=false)
Update a level crossing to barred or open (crossing may include multiple adjacent tiles).
bool IsLevelCrossingTile(Tile t)
Return whether a tile is a level crossing tile.
Definition road_map.h:79
RoadType
The different roadtypes we support.
Definition road_type.h:23
@ ROADTYPE_END
Used for iterations.
Definition road_type.h:27
@ ROADTYPE_BEGIN
Used for iterations.
Definition road_type.h:24
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
void AddTrackToSignalBuffer(TileIndex tile, Track track, Owner owner)
Add track to signal update buffer.
Definition signal.cpp:596
void UpdateSignalsInBuffer()
Update signals in buffer Called from 'outside'.
Definition signal.cpp:580
Base class for signs.
Functions related to sound.
@ SND_14_CASHTILL
18 == 0x12 Income from cargo delivery
Definition sound_type.h:66
@ Industry
Source/destination is an industry.
Definition source_type.h:21
Money AirportMaintenanceCost(Owner owner)
Calculates the maintenance cost of all airports of a company.
Definition station.cpp:716
Base classes/functions for stations.
Money StationMaintenanceCost(uint32_t num)
Calculates the maintenance cost of a number of station tiles.
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
@ CargoTaken
Trigger station when cargo is completely taken.
@ VehicleLoads
Trigger platform when train loads/unloads.
@ CargoTaken
Trigger station when cargo is completely taken.
@ VehicleLoads
Trigger platform when train loads/unloads.
@ CargoTaken
Triggered when a cargo type is completely removed from the station (for all tiles at the same time).
Definition of base types and functions in a cross-platform compatible way.
StoryPage base class.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
bool IsNormalAircraft() const
Check if the aircraft type is a normal flying device; eg not a rotor or a shadow.
Definition aircraft.h:121
Class to backup a specific variable and restore it later.
void Restore()
Restore the variable.
TimerGameTick::Ticks current_order_time
How many ticks have passed since this order started.
VehicleFlags vehicle_flags
Used for gradual loading and other miscellaneous things (.
TimerGameTick::Ticks lateness_counter
How many ticks late (or early if negative) this vehicle is.
TileIndex xy
Base tile of the station.
Owner owner
The owner of this station.
Town * town
The town this station is associated with.
VehicleType type
Type of vehicle.
Class for storing amounts of cargo.
Definition cargo_type.h:115
Container for cargo from the same location and time.
Definition cargopacket.h:41
Money GetFeederShare() const
Gets the amount of money already paid to earlier vehicles in the feeder chain.
uint GetDistance(TileIndex current_tile) const
Get the current distance the cargo has traveled.
uint16_t GetPeriodsInTransit() const
Gets the number of cargo aging periods this cargo has been in transit.
Source GetSource() const
Gets the source of the packet for subsidy purposes.
Helper class to perform the cargo payment.
void PayFinalDelivery(CargoType cargo, const CargoPacket *cp, uint count, TileIndex current_tile)
Handle payment for final delivery of the given cargo packet.
Definition economy.cpp:1211
~CargoPayment()
Execute the actual payment to the coffers of the company.
Definition economy.cpp:1176
StationID current_station
NOSAVE: The current station.
Money PayTransfer(CargoType cargo, const CargoPacket *cp, uint count, TileIndex current_tile)
Handle payment for transfer of the given cargo packet.
Definition economy.cpp:1229
Vehicle * front
The front vehicle to do the payment of.
Money visual_transfer
The transfer credits to be shown.
Money visual_profit
The visual profit to show.
Money route_profit
The amount of money to add/remove from the bank account.
Specification of a cargo type.
Definition cargotype.h:74
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:138
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition cargotype.h:191
TownAcceptanceEffect town_acceptance_effect
The effect that delivering this cargo type has on towns. Also affects destination of subsidies.
Definition cargotype.h:86
CargoCallbackMasks callback_mask
Bitmask of cargo callbacks that have to be called.
Definition cargotype.h:89
bool IsValid() const
Tests for validity of this cargospec.
Definition cargotype.h:118
CargoArray delivered_cargo
The amount of delivered cargo.
TileIndex location_of_HQ
Northern tile of HQ; INVALID_TILE when there is none.
uint8_t months_of_bankruptcy
Number of months that the company is unable to pay its debts.
CompanyMask bankrupt_asked
which companies were asked about buying it?
int16_t bankrupt_timeout
If bigger than 0, amount of time to wait for an answer on an offer to buy this company.
CompanySettings settings
settings specific for each company
bool is_ai
If true, the company is (also) controlled by the computer (a NoAI program).
Money current_loan
Amount of money borrowed from the bank.
CompanyEconomyEntry cur_economy
Economic data of the company of this quarter.
std::array< CompanyEconomyEntry, MAX_HISTORY_QUARTERS > old_economy
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
Money money
Money owned by the company.
uint8_t num_valid_stat_ent
Number of valid statistical entries in old_economy.
VehicleDefaultSettings vehicle
default settings for vehicles
Money GetMaxLoan() const
Calculate the max allowed loan for this company.
Data of the economy.
EngineMiscFlags misc_flags
Miscellaneous flags.
VehicleCallbackMasks callback_mask
Bitmask of vehicle callbacks that have to be called.
Action for finalizing a refit.
Definition economy.cpp:1428
std::span< const StationID > next_station
Next hops to reserve cargo for.
Definition economy.cpp:1431
CargoArray & consist_capleft
Capacities left in the consist.
Definition economy.cpp:1429
bool do_reserve
If the vehicle should reserve.
Definition economy.cpp:1432
FinalizeRefitAction(CargoArray &consist_capleft, Station *st, std::span< const StationID > next_station, bool do_reserve)
Create a finalizing action.
Definition economy.cpp:1441
bool operator()(Vehicle *v)
Reserve cargo from the station and update the remaining consist capacities with the vehicle's remaini...
Definition economy.cpp:1450
Station * st
Station to reserve cargo from.
Definition economy.cpp:1430
Dynamic data of a loaded NewGRF.
Definition newgrf.h:117
PriceMultipliers price_base_multipliers
Price base multipliers as set by the grf.
Definition newgrf.h:162
Struct about goals, current and completed.
Definition goal_base.h:22
StationCargoList cargo
The cargo packets of cargo waiting in this station.
Stores station stats for a single cargo.
bool HasRating() const
Does this cargo have a rating at this station?
uint8_t last_speed
Maximum speed (up to 255) of the last vehicle that tried to load this cargo.
uint8_t last_age
Age in years (up to 255) of the last vehicle that tried to load this cargo.
uint8_t time_since_pickup
Number of rating-intervals (up to 255) since the last vehicle tried to load this cargo.
States status
Status of this cargo, see State.
@ Acceptance
Set when the station accepts the cargo currently for final deliveries.
@ EverAccepted
Set when a vehicle ever delivered cargo to the station for final delivery.
@ Rating
This indicates whether a cargo has a rating at the station.
@ AcceptedBigtick
Set when cargo was delivered for final delivery during the current STATION_ACCEPTANCE_TICKS interval.
@ CurrentMonth
Set when cargo was delivered for final delivery this month.
const GoodsEntryData & GetData() const
Get optional cargo packet/flow data.
GoodsEntryData & GetOrCreateData()
Get optional cargo packet/flow data.
uint AvailableCount() const
Returns sum of cargo still available for loading at the station.
uint16_t cached_total_length
Length of the whole vehicle (valid only for the first engine).
bool IsMultiheaded() const
Check if the vehicle is a multiheaded engine.
static void CountVehicle(const Vehicle *v, int delta)
Update num_vehicle when adding or removing a vehicle.
static void CountEngine(const Vehicle *v, int delta)
Update num_engines when adding/removing an engine.
static void UpdateAutoreplace(CompanyID company)
Update autoreplace_defined and autoreplace_finished of all statistics of a company.
Group data.
Definition group.h:74
Defines the data structure for constructing industry.
IndustryCallbackMasks callback_mask
Bitmask of industry callbacks that have to be called.
uint16_t input_cargo_multiplier[INDUSTRY_NUM_INPUTS][INDUSTRY_NUM_OUTPUTS]
Input cargo multipliers (multiply amount of incoming cargo for the produced cargoes).
Defines the internal data of a functional industry.
Definition industry.h:62
IndustryType type
type of industry.
Definition industry.h:115
Owner exclusive_supplier
Which company has exclusive rights to deliver cargo (INVALID_OWNER = anyone).
Definition industry.h:130
ProducedCargoes produced
produced cargo slots
Definition industry.h:110
AcceptedCargoes accepted
accepted cargo slots
Definition industry.h:111
uint8_t was_cargo_delivered
flag that indicate this has been the closest industry chosen for cargo delivery by a station....
Definition industry.h:119
AcceptedCargoes::iterator GetCargoAccepted(CargoType cargo)
Get accepted cargo slot for a specific cargo type.
Definition industry.h:202
Action to check if a vehicle has no stored cargo.
Definition economy.cpp:1355
bool operator()(const Vehicle *v)
Checks if the vehicle has stored cargo.
Definition economy.cpp:1361
static IterateWrapper Iterate()
Returns an iterable ensemble of all Tiles.
Definition map_func.h:366
static uint LogX()
Logarithm of the map size along the X side.
Definition map_func.h:243
static uint LogY()
Logarithm of the map size along the y side.
Definition map_func.h:253
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition order_base.h:67
CargoType GetRefitCargo() const
Get the cargo to to refit to.
Definition order_base.h:128
bool IsFullLoadOrder() const
Is this order a OrderLoadType::FullLoad or OrderLoadType::FullLoadAny?
Definition order_base.h:136
OrderUnloadType GetUnloadType() const
How must the consist be unloaded?
Definition order_base.h:152
OrderLoadType GetLoadType() const
How must the consist be loaded?
Definition order_base.h:146
uint16_t GetTimetabledWait() const
Get the time in ticks a vehicle should wait at the destination or 0 if it's not timetabled.
Definition order_base.h:283
bool IsRefit() const
Is this order a refit order.
Definition order_base.h:114
static Pool::IterateWrapper< Vehicle > Iterate(size_t from=0)
static Company * Get(auto index)
static Company * GetIfValid(auto index)
Refit preparation action.
Definition economy.cpp:1371
CargoTypes & refit_mask
Bitmask of possible refit cargoes.
Definition economy.cpp:1373
PrepareRefitAction(CargoArray &consist_capleft, CargoTypes &refit_mask)
Create a refit preparation action.
Definition economy.cpp:1380
CargoArray & consist_capleft
Capacities left in the consist.
Definition economy.cpp:1372
bool operator()(const Vehicle *v)
Prepares for refitting of a vehicle, subtracting its free capacity from consist_capleft and adding th...
Definition economy.cpp:1389
Action for returning reserved cargo.
Definition economy.cpp:1401
Station * st
Station to give the returned cargo to.
Definition economy.cpp:1402
bool operator()(Vehicle *v)
Return all reserved cargo from a vehicle.
Definition economy.cpp:1417
ReturnCargoAction(Station *st, StationID next_one)
Construct a cargo return action.
Definition economy.cpp:1410
StationID next_hop
Next hop the cargo should be assigned to.
Definition economy.cpp:1403
Data structure for storing how the score is computed for a single score id.
A location from where cargo can come from (or go to).
Definition source_type.h:32
SourceType type
Type of source_id.
Definition source_type.h:37
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
static Station * Get(auto index)
Station data structure.
uint GetPlatformLength(TileIndex tile, DiagDirection dir) const override
Determines the REMAINING length of a platform, starting at (and including) the given tile.
Definition station.cpp:292
IndustryList industries_near
Cached list of industries near the station that can accept cargo,.
CargoTypes always_accepted
Bitmask of always accepted cargo types (by houses, HQs, industry tiles when industry doesn't accept c...
std::array< GoodsEntry, NUM_CARGO > goods
Goods at this station.
Struct about stories, current and completed.
Definition story_base.h:162
Struct about subsidies, offered and awarded.
Town data structure.
Definition town.h:63
CompanyID exclusivity
which company has exclusivity
Definition town.h:86
uint8_t exclusive_counter
months till the exclusivity expires
Definition town.h:87
std::array< TransportedCargoStat< uint16_t >, NUM_TAE > received
Cargo statistics about received cargotypes.
Definition town.h:112
'Train' is either a loco or a wagon.
Definition train.h:97
Train * other_multiheaded_part
Link between the two ends of a multiheaded engine.
Definition train.h:105
uint16_t cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
uint16_t servint_aircraft
service interval for aircraft
uint16_t servint_roadveh
service interval for road vehicles
uint16_t servint_ships
service interval for ships
bool servint_ispercent
service intervals are in percents
uint16_t servint_trains
service interval for trains
Vehicle data structure.
CargoPayment * cargo_payment
The cargo payment we're currently in.
EngineID engine_type
The type of engine used for this vehicle.
int32_t z_pos
z coordinate.
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition vehicle.cpp:747
virtual TileIndex GetCargoTile() const
Tile to use for economic calculations when moving cargo into or out of this vehicle.
VehicleCargoList cargo
The cargo this vehicle is carrying.
uint16_t cargo_cap
total capacity
Vehicle * GetFirstEnginePart()
Get the first part of an articulated engine.
Money profit_this_year
Profit this year << 8, low 8 bits are fract.
bool HasArticulatedPart() const
Check if an engine has an articulated part.
VehStates vehstatus
Status.
void GetNextStoppingStation(std::vector< StationID > &next_station) const
Get the next station the vehicle will stop at.
CargoType cargo_type
type of cargo this vehicle is carrying
Vehicle * First() const
Get the first vehicle of this vehicle chain.
Order current_order
The current order (+ status, like: loading).
Vehicle * Next() const
Get the next vehicle of this vehicle.
int32_t y_pos
y coordinate.
int32_t x_pos
x coordinate.
OrderList * orders
Pointer to the order list for this vehicle.
VehicleCache vcache
Cache of often used vehicle values.
GroundVehicleCache * GetGroundVehicleCache()
Access the ground vehicle cache of the vehicle.
Definition vehicle.cpp:3186
uint16_t load_unload_ticks
Ticks to wait before starting next cycle.
uint16_t cur_speed
current speed
TextEffectID fill_percent_te_id
a text-effect id to a loading indicator object
Vehicle * Previous() const
Get the previous vehicle of this vehicle.
TileIndex tile
Current tile index.
StationID last_station_visited
The last station we stopped at.
TimerGameCalendar::Year build_year
Year the vehicle has been built.
Owner owner
Which company owns the vehicle?
Representation of a waypoint.
void RebuildSubsidisedSourceAndDestinationCache()
Perform a full rebuild of the subsidies cache.
Definition subsidy.cpp:103
bool CheckSubsidised(CargoType cargo_type, CompanyID company, Source src, const Station *st)
Tests whether given delivery is subsidised and possibly awards the subsidy to delivering company.
Definition subsidy.cpp:508
Subsidy base class.
Functions related to subsidies.
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
bool IsTileOwner(Tile tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition tile_map.h:214
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
@ Station
A tile of a station or airport.
Definition tile_type.h:54
@ Railway
A tile with railway.
Definition tile_type.h:50
Definition of Interval and OneShot timers.
Definition of the game-calendar-timer.
Definition of the game-economy-timer.
Base of the town class.
static constexpr int RATING_INITIAL
initial rating
Definition town_type.h:45
Track RemoveFirstTrack(TrackBits *tracks)
Removes first Track from TrackBits and returns it.
Definition track_func.h:131
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
@ TRACK_BIT_NONE
No track.
Definition track_type.h:36
Track
These are used to specify a single track.
Definition track_type.h:19
Base for the train class.
uint8_t CalcPercentVehicleFilled(const Vehicle *front, StringID *colour)
Calculates how full a vehicle is.
Definition vehicle.cpp:1505
Command definitions for vehicles.
Functions related to vehicles.
static const TimerGameEconomy::Date VEHICLE_PROFIT_MIN_AGE
Only vehicles older than this have a meaningful profit.
bool IsCompanyBuildableVehicleType(VehicleType type)
Is the given vehicle type buildable by a company?
WindowClass GetWindowClassForVehicleType(VehicleType vt)
Get WindowClass for vehicle list of given vehicle type.
Definition vehicle_gui.h:97
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
@ NewCargo
Affected vehicle only: Vehicle is loaded with cargo, after it was empty.
@ Empty
Front vehicle only: Entire consist is empty.
Functions related to water management.
Money CanalMaintenanceCost(uint32_t num)
Calculates the maintenance cost of a number of canal tiles.
Definition water.h:53
Base of waypoints.
void ChangeWindowOwner(Owner old_owner, Owner new_owner)
Change the owner of all the windows one company can take over from another company in the case of a c...
Definition window.cpp:1258
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting).
Definition window.cpp:3229
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:3321
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3199
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition window.cpp:3339
@ WC_PERFORMANCE_HISTORY
Performance history graph; Window numbers:
@ WC_COMPANY_LEAGUE
Company league window; Window numbers:
@ WC_COMPANY_INFRASTRUCTURE
Company infrastructure overview; Window numbers:
@ WC_PERFORMANCE_DETAIL
Performance detail window; Window numbers:
@ WC_PAYMENT_RATES
Payment rates graph; Window numbers:
@ WC_STATION_LIST
Station list; Window numbers:
@ WC_ROADVEH_LIST
Road vehicle list; Window numbers:
@ WC_REPLACE_VEHICLE
Replace vehicle window; Window numbers:
@ WC_SHIPS_LIST
Ships list; Window numbers:
@ WC_STATION_VIEW
Station view; Window numbers:
@ WC_OPERATING_PROFIT
Operating profit graph; Window numbers:
@ WC_CLIENT_LIST
Client list; Window numbers:
@ WC_TRAINS_LIST
Trains list; Window numbers:
@ WC_INDUSTRY_VIEW
Industry view; Window numbers:
@ WC_INCOME_GRAPH
Income graph; Window numbers:
@ WC_DELIVERED_CARGO
Delivered cargo graph; Window numbers:
@ WC_COMPANY_VALUE
Company value graph; Window numbers:
@ WC_VEHICLE_DETAILS
Vehicle details; Window numbers:
@ WC_BUILD_VEHICLE
Build vehicle; Window numbers:
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers: