OpenTTD Source 20260604-master-ga892d8e848
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
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 == VehicleType::Train ||
131 v->type == VehicleType::Road ||
132 (v->type == VehicleType::Aircraft && Aircraft::From(v)->IsNormalAircraft()) ||
133 v->type == VehicleType::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
313 SetWindowDirty(WindowClass::PerformanceDetail, 0);
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 AutoRestoreBackup 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 for (Track track : SetTrackBitIterator(GetTrackBits(tile))) {
489 if (IsSignalPresent(tile, SignalOnTrack(track))) AddTrackToSignalBuffer(tile, track, new_owner);
490 }
491 } else if (IsLevelCrossingTile(tile) && IsTileOwner(tile, new_owner)) {
493 }
494 }
495 }
496
497 /* update signals in buffer */
499 }
500
501 /* Add airport infrastructure count of the old company to the new one. */
502 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.airport += Company::Get(old_owner)->infrastructure.airport;
503
504 /* convert owner of stations (including deleted ones, but excluding buoys) */
505 for (Station *st : Station::Iterate()) {
506 if (st->owner == old_owner) {
507 /* if a company goes bankrupt, set owner to OWNER_NONE so the sign doesn't disappear immediately
508 * also, drawing station window would cause reading invalid company's colour */
509 st->owner = new_owner == INVALID_OWNER ? OWNER_NONE : new_owner;
510 }
511 }
512
513 /* do the same for waypoints (we need to do this here so deleted waypoints are converted too) */
514 for (Waypoint *wp : Waypoint::Iterate()) {
515 if (wp->owner == old_owner) {
516 wp->owner = new_owner == INVALID_OWNER ? OWNER_NONE : new_owner;
517 }
518 }
519
520 for (Sign *si : Sign::Iterate()) {
521 if (si->owner == old_owner) si->owner = new_owner == INVALID_OWNER ? OWNER_NONE : new_owner;
522 }
523
524 /* Remove Game Script created Goals, CargoMonitors and Story pages. */
525 for (Goal *g : Goal::Iterate()) {
526 if (g->company == old_owner) delete g;
527 }
528
531
532 for (StoryPage *sp : StoryPage::Iterate()) {
533 if (sp->company == old_owner) delete sp;
534 }
535
536 /* Change colour of existing windows */
537 if (new_owner != INVALID_OWNER) ChangeWindowOwner(old_owner, new_owner);
538
540}
541
547{
548 /* If "Infinite money" setting is on, companies should not go bankrupt. */
549 if (_settings_game.difficulty.infinite_money) return;
550
551 /* If the company has money again, it does not go bankrupt */
552 if (c->money - c->current_loan >= -c->GetMaxLoan()) {
553 int previous_months_of_bankruptcy = CeilDiv(c->months_of_bankruptcy, 3);
556 if (previous_months_of_bankruptcy != 0) CompanyAdminUpdate(c);
557 return;
558 }
559
561
562 switch (c->months_of_bankruptcy) {
563 /* All the boring cases (months) with a bad balance where no action is taken */
564 case 0:
565 case 1:
566 case 2:
567 case 3:
568
569 case 5:
570 case 6:
571
572 case 8:
573 case 9:
574 break;
575
576 /* Warn about bankruptcy after 3 months */
577 case 4: {
578 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_IN_TROUBLE_TITLE, c);
579 EncodedString headline = GetEncodedString(STR_NEWS_COMPANY_IN_TROUBLE_DESCRIPTION, cni->company_name);
580 AddCompanyNewsItem(std::move(headline), std::move(cni));
581 AI::BroadcastNewEvent(new ScriptEventCompanyInTrouble(c->index));
582 Game::NewEvent(new ScriptEventCompanyInTrouble(c->index));
583 break;
584 }
585
586 /* Offer company for sale after 6 months */
587 case 7: {
588 /* Don't consider the loan */
589 Money val = CalculateCompanyValue(c, false);
590
591 c->bankrupt_value = val;
592 c->bankrupt_asked = CompanyMask{}.Set(c->index); // Don't ask the owner
593 c->bankrupt_timeout = 0;
594
595 /* The company assets should always have some value */
596 assert(c->bankrupt_value > 0);
597 break;
598 }
599
600 /* Bankrupt company after 6 months (if the company has no value) or latest
601 * after 9 months (if it still had value after 6 months) */
602 default:
603 case 10: {
604 if (!_networking && _local_company == c->index) {
605 /* If we are in singleplayer mode, leave the company playing. Eg. there
606 * is no THE-END, otherwise mark the client as spectator to make sure
607 * they are no longer in control of this company. However... when you
608 * join another company (cheat) the "unowned" company can bankrupt. */
609 c->bankrupt_asked.Set();
610 break;
611 }
612
613 /* Actually remove the company, but not when we're a network client.
614 * In case of network clients we will be getting a command from the
615 * server. It is done in this way as we are called from the
616 * StateGameLoop which can't change the current company, and thus
617 * updating the local company triggers an assert later on. In the
618 * case of a network game the command will be processed at a time
619 * that changing the current company is okay. In case of single
620 * player we are sure (the above check) that we are not the local
621 * company and thus we won't be moved. */
623 Command<Commands::CompanyControl>::Post(CompanyCtrlAction::Delete, c->index, CompanyRemoveReason::Bankrupt, INVALID_CLIENT_ID);
624 return;
625 }
626 break;
627 }
628 }
629
631}
632
638{
639 /* Check for bankruptcy each month */
640 for (Company *c : Company::Iterate()) {
642 }
643
644 /* Pay Infrastructure Maintenance, if enabled */
645 if (_settings_game.economy.infrastructure_maintenance) {
646 /* Improved monthly infrastructure costs. */
647 for (const Company *c : Company::Iterate()) {
649 uint32_t rail_total = c->infrastructure.GetRailTotal();
650 for (RailType rt = RAILTYPE_BEGIN; rt < RAILTYPE_END; rt++) {
651 if (c->infrastructure.rail[rt] != 0) cost.AddCost(RailMaintenanceCost(rt, c->infrastructure.rail[rt], rail_total));
652 }
653 cost.AddCost(SignalMaintenanceCost(c->infrastructure.signal));
654 uint32_t road_total = c->infrastructure.GetRoadTotal();
655 uint32_t tram_total = c->infrastructure.GetTramTotal();
656 for (RoadType rt = ROADTYPE_BEGIN; rt < ROADTYPE_END; rt++) {
657 if (c->infrastructure.road[rt] != 0) cost.AddCost(RoadMaintenanceCost(rt, c->infrastructure.road[rt], RoadTypeIsRoad(rt) ? road_total : tram_total));
658 }
659 cost.AddCost(CanalMaintenanceCost(c->infrastructure.water));
660 cost.AddCost(StationMaintenanceCost(c->infrastructure.station));
661 cost.AddCost(AirportMaintenanceCost(c->index));
662
663 SubtractMoneyFromCompany(c->index, cost);
664 }
665 }
666
667 /* Only run the economic statistics and update company stats every 3rd economy month (1st of quarter). */
668 if (!HasBit(1 << 0 | 1 << 3 | 1 << 6 | 1 << 9, TimerGameEconomy::month)) return;
669
670 for (Company *c : Company::Iterate()) {
671 /* Drop the oldest history off the end */
672 std::copy_backward(c->old_economy.data(), c->old_economy.data() + MAX_HISTORY_QUARTERS - 1, c->old_economy.data() + MAX_HISTORY_QUARTERS);
673 c->old_economy[0] = c->cur_economy;
674 c->cur_economy = {};
675
676 if (c->num_valid_stat_ent != MAX_HISTORY_QUARTERS) c->num_valid_stat_ent++;
677
679 if (c->block_preview != 0) c->block_preview--;
680 }
681
682 SetWindowDirty(WindowClass::IncomeGraph, 0);
683 SetWindowDirty(WindowClass::OperatingProfitGraph, 0);
684 SetWindowDirty(WindowClass::DeliveredCargoGraph, 0);
685 SetWindowDirty(WindowClass::PerformanceGraph, 0);
686 SetWindowDirty(WindowClass::CompanyValueGraph, 0);
687 SetWindowDirty(WindowClass::CompanyLeague, 0);
688}
689
695bool AddInflation(bool check_year)
696{
697 /* The cargo payment inflation differs from the normal inflation, so the
698 * relative amount of money you make with a transport decreases slowly over
699 * the 170 years. After a few hundred years we reach a level in which the
700 * games will become unplayable as the maximum income will be less than
701 * the minimum running cost.
702 *
703 * Furthermore there are a lot of inflation related overflows all over the
704 * place. Solving them is hardly possible because inflation will always
705 * reach the overflow threshold some day. So we'll just perform the
706 * inflation mechanism during the first 170 years (the amount of years that
707 * one had in the original TTD) and stop doing the inflation after that
708 * because it only causes problems that can't be solved nicely and the
709 * inflation doesn't add anything after that either; it even makes playing
710 * it impossible due to the diverging cost and income rates.
711 */
713
714 if (_economy.inflation_prices == MAX_INFLATION || _economy.inflation_payment == MAX_INFLATION) return true;
715
716 /* Approximation for (100 + infl_amount)% ** (1 / 12) - 100%
717 * scaled by 65536
718 * 12 -> months per year
719 * This is only a good approximation for small values
720 */
721 _economy.inflation_prices += (_economy.inflation_prices * _economy.infl_amount * 54) >> 16;
722 _economy.inflation_payment += (_economy.inflation_payment * _economy.infl_amount_pr * 54) >> 16;
723
724 if (_economy.inflation_prices > MAX_INFLATION) _economy.inflation_prices = MAX_INFLATION;
725 if (_economy.inflation_payment > MAX_INFLATION) _economy.inflation_payment = MAX_INFLATION;
726
727 return false;
728}
729
734{
735 /* Setup maximum loan as a rounded down multiple of LOAN_INTERVAL. */
736 _economy.max_loan = ((uint64_t)_settings_game.difficulty.max_loan * _economy.inflation_prices >> 16) / LOAN_INTERVAL * LOAN_INTERVAL;
737
738 /* Setup price bases */
739 for (Price i = Price::Begin; i < Price::End; i++) {
740 Money price = _price_base_specs[i].start_price;
741
742 /* Apply difficulty settings */
743 uint mod = 1;
744 switch (_price_base_specs[i].category) {
746 mod = _settings_game.difficulty.vehicle_costs;
747 break;
748
750 mod = _settings_game.difficulty.construction_cost;
751 break;
752
753 default: break;
754 }
755 switch (mod) {
756 case 0: price *= 6; break;
757 case 1: price *= 8; break; // normalised to 1 below
758 case 2: price *= 9; break;
759 default: NOT_REACHED();
760 }
761
762 /* Apply inflation */
763 price = (int64_t)price * _economy.inflation_prices;
764
765 /* Apply newgrf modifiers, remove fractional part of inflation, and normalise on medium difficulty. */
766 int shift = _price_base_multiplier[i] - 16 - 3;
767 if (shift >= 0) {
768 price <<= shift;
769 } else {
770 price >>= -shift;
771 }
772
773 /* Make sure the price does not get reduced to zero.
774 * Zero breaks quite a few commands that use a zero
775 * cost to see whether something got changed or not
776 * and based on that cause an error. When the price
777 * is zero that fails even when things are done. */
778 if (price == 0) {
779 price = Clamp(_price_base_specs[i].start_price, -1, 1);
780 /* No base price should be zero, but be sure. */
781 assert(price != 0);
782 }
783 /* Store value */
784 _price[i] = price;
785 }
786
787 /* Setup cargo payment */
788 for (CargoSpec *cs : CargoSpec::Iterate()) {
789 cs->current_payment = (cs->initial_payment * (int64_t)_economy.inflation_payment) >> 16;
790 }
791
792 SetWindowClassesDirty(WindowClass::BuildVehicle);
793 SetWindowClassesDirty(WindowClass::ReplaceVehicle);
794 SetWindowClassesDirty(WindowClass::VehicleDetails);
795 SetWindowClassesDirty(WindowClass::CompanyInfrastructure);
796 InvalidateWindowData(WindowClass::CargoPaymentRatesGraph, 0);
797}
798
801{
802 for (const Company *c : Company::Iterate()) {
803 /* Over a year the paid interest should be "loan * interest percentage",
804 * but... as that number is likely not dividable by 12 (pay each month),
805 * one needs to account for that in the monthly fee calculations.
806 *
807 * To easily calculate what one should pay "this" month, you calculate
808 * what (total) should have been paid up to this month and you subtract
809 * whatever has been paid in the previous months. This will mean one month
810 * it'll be a bit more and the other it'll be a bit less than the average
811 * monthly fee, but on average it will be exact.
812 *
813 * In order to prevent cheating or abuse (just not paying interest by not
814 * taking a loan) we make companies pay interest on negative cash as well,
815 * except if infinite money is enabled.
816 */
817 Money yearly_fee = c->current_loan * _economy.interest_rate / 100;
818 Money available_money = GetAvailableMoney(c->index);
819 if (available_money < 0) {
820 yearly_fee += -available_money * _economy.interest_rate / 100;
821 }
822 Money up_to_previous_month = yearly_fee * TimerGameEconomy::month / 12;
823 Money up_to_this_month = yearly_fee * (TimerGameEconomy::month + 1) / 12;
824
825 SubtractMoneyFromCompany(c->index, CommandCost(ExpensesType::LoanInterest, up_to_this_month - up_to_previous_month));
826
828 }
829}
830
831static void HandleEconomyFluctuations()
832{
833 if (_settings_game.difficulty.economy != 0) {
834 /* When economy is Fluctuating, decrease counter */
835 _economy.fluct--;
836 } else if (EconomyIsInRecession()) {
837 /* When it's Steady and we are in recession, end it now */
838 _economy.fluct = -12;
839 } else {
840 /* No need to do anything else in other cases */
841 return;
842 }
843
844 if (_economy.fluct == 0) {
845 _economy.fluct = -(int)GB(Random(), 0, 2);
846 AddNewsItem(GetEncodedString(STR_NEWS_BEGIN_OF_RECESSION), NewsType::Economy, NewsStyle::Normal, {});
847 } else if (_economy.fluct == -12) {
848 _economy.fluct = GB(Random(), 0, 8) + 312;
849 AddNewsItem(GetEncodedString(STR_NEWS_END_OF_RECESSION), NewsType::Economy, NewsStyle::Normal, {});
850 }
851}
852
853
858{
859 _price_base_multiplier.fill(0);
860}
861
869void SetPriceBaseMultiplier(Price price, int factor)
870{
871 assert(price < Price::End);
872 _price_base_multiplier[price] = Clamp(factor, MIN_PRICE_MODIFIER, MAX_PRICE_MODIFIER);
873}
874
879void StartupIndustryDailyChanges(bool init_counter)
880{
881 uint map_size = Map::LogX() + Map::LogY();
882 /* After getting map size, it needs to be scaled appropriately and divided by 31,
883 * which stands for the days in a month.
884 * Using just 31 will make it so that a monthly reset (based on the real number of days of that month)
885 * would not be needed.
886 * Since it is based on "fractional parts", the leftover days will not make much of a difference
887 * on the overall total number of changes performed */
888 _economy.industry_daily_increment = (1 << map_size) / 31;
889
890 if (init_counter) {
891 /* A new game or a savegame from an older version will require the counter to be initialized */
892 _economy.industry_daily_change_counter = 0;
893 }
894}
895
896void StartupEconomy()
897{
898 _economy.interest_rate = _settings_game.difficulty.initial_interest;
899 _economy.infl_amount = _settings_game.difficulty.initial_interest;
900 _economy.infl_amount_pr = std::max(0, _settings_game.difficulty.initial_interest - 1);
901 _economy.fluct = GB(Random(), 0, 8) + 168;
902
903 if (_settings_game.economy.inflation) {
904 /* Apply inflation that happened before our game start year. */
906 for (int i = 0; i < months; i++) {
907 AddInflation(false);
908 }
909 }
910
911 /* Set up prices */
913
914 StartupIndustryDailyChanges(true); // As we are starting a new game, initialize the counter too
915
916}
917
922{
923 _economy.inflation_prices = _economy.inflation_payment = 1 << 16;
926}
927
936Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
937{
938 if (index >= Price::End) return 0;
939
940 Money cost = _price[index] * cost_factor;
941 if (grf_file != nullptr) shift += grf_file->price_base_multipliers[index];
942
943 if (shift >= 0) {
944 cost <<= shift;
945 } else {
946 cost >>= -shift;
947 }
948
949 return cost;
950}
951
952Money GetTransportedGoodsIncome(uint num_pieces, uint dist, uint16_t transit_periods, CargoType cargo_type)
953{
954 const CargoSpec *cs = CargoSpec::Get(cargo_type);
955 if (!cs->IsValid()) {
956 /* User changed newgrfs and some vehicle still carries some cargo which is no longer available. */
957 return 0;
958 }
959
960 /* Scale transit periods according to the game setting. We also pass this scaled value to the NewGRF callback. */
961 transit_periods = ScaleByPercentage<uint16_t, uint32_t>(transit_periods, _settings_game.economy.cargo_aging_rate);
962
963 /* Use callback to calculate cargo profit, if available */
965 uint32_t var18 = ClampTo<uint16_t>(dist) | (ClampTo<uint8_t>(num_pieces) << 16) | (ClampTo<uint8_t>(transit_periods) << 24);
966 uint16_t callback = GetCargoCallback(CBID_CARGO_PROFIT_CALC, 0, var18, cs);
967 if (callback != CALLBACK_FAILED) {
968 int result = GB(callback, 0, 14);
969
970 /* Simulate a 15 bit signed value */
971 if (HasBit(callback, 14)) result -= 0x4000;
972
973 /* "The result should be a signed multiplier that gets multiplied
974 * by the amount of cargo moved and the price factor, then gets
975 * divided by 8192." */
976 return result * num_pieces * cs->current_payment / 8192;
977 }
978 }
979
980 static const int MIN_TIME_FACTOR = 31;
981 static const int MAX_TIME_FACTOR = 255;
982 static const int TIME_FACTOR_FRAC_BITS = 4;
983 static const int TIME_FACTOR_FRAC = 1 << TIME_FACTOR_FRAC_BITS;
984
985 const int periods1 = cs->transit_periods[0];
986 const int periods2 = cs->transit_periods[1];
987 const int periods_over_periods1 = std::max(transit_periods - periods1, 0);
988 const int periods_over_periods2 = std::max(periods_over_periods1 - periods2, 0);
989 int periods_over_max = MIN_TIME_FACTOR - MAX_TIME_FACTOR;
990 if (periods2 > -periods_over_max) {
991 periods_over_max += transit_periods - periods1;
992 } else {
993 periods_over_max += 2 * (transit_periods - periods1) - periods2;
994 }
995
996 /*
997 * The time factor is calculated based on the time it took
998 * (transit_periods) compared two cargo-depending values. The
999 * range is divided into four parts:
1000 *
1001 * - constant for fast transits
1002 * - linear decreasing with time with a slope of -1 for medium transports
1003 * - linear decreasing with time with a slope of -2 for slow transports
1004 * - after hitting MIN_TIME_FACTOR, the time factor will be asymptotically decreased to a limit of 1 with a scaled 1/(x+1) function.
1005 *
1006 */
1007 if (periods_over_max > 0) {
1008 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.
1009 return BigMulS(dist * time_factor * num_pieces, cs->current_payment, 21 + TIME_FACTOR_FRAC_BITS);
1010 } else {
1011 const int time_factor = std::max(MAX_TIME_FACTOR - periods_over_periods1 - periods_over_periods2, MIN_TIME_FACTOR);
1012 return BigMulS(dist * time_factor * num_pieces, cs->current_payment, 21);
1013 }
1014}
1015
1017static SmallIndustryList _cargo_delivery_destinations;
1018
1029static uint DeliverGoodsToIndustry(const Station *st, CargoType cargo_type, uint num_pieces, IndustryID source, CompanyID company)
1030{
1031 /* Find the nearest industrytile to the station sign inside the catchment area, whose industry accepts the cargo.
1032 * This fails in three cases:
1033 * 1) The station accepts the cargo because there are enough houses around it accepting the cargo.
1034 * 2) The industries in the catchment area temporarily reject the cargo, and the daily station loop has not yet updated station acceptance.
1035 * 3) The results of callbacks CBID_INDUSTRY_REFUSE_CARGO and CBID_INDTILE_CARGO_ACCEPTANCE are inconsistent. (documented behaviour)
1036 */
1037
1038 uint accepted = 0;
1039
1040 for (const auto &i : st->industries_near) {
1041 if (num_pieces == 0) break;
1042
1043 Industry *ind = i.industry;
1044 if (ind->index == source) continue;
1045
1046 auto it = ind->GetCargoAccepted(cargo_type);
1047 /* Check if matching cargo has been found */
1048 if (it == std::end(ind->accepted)) continue;
1049
1050 /* Check if industry temporarily refuses acceptance */
1051 if (IndustryTemporarilyRefusesCargo(ind, cargo_type)) continue;
1052
1053 if (ind->exclusive_supplier != INVALID_OWNER && ind->exclusive_supplier != st->owner) continue;
1054
1055 /* Insert the industry into _cargo_delivery_destinations, if not yet contained */
1057
1058 uint amount = std::min(num_pieces, 0xFFFFu - it->waiting);
1059 it->waiting += amount;
1060 it->GetOrCreateHistory()[THIS_MONTH].accepted += amount;
1061 it->last_accepted = TimerGameEconomy::date;
1062 num_pieces -= amount;
1063 accepted += amount;
1064
1065 /* Update the cargo monitor. */
1066 AddCargoDelivery(cargo_type, company, amount, {source, SourceType::Industry}, st, ind->index);
1067 }
1068
1069 return accepted;
1070}
1071
1084static Money DeliverGoods(int num_pieces, CargoType cargo_type, StationID dest, uint distance, uint16_t periods_in_transit, Company *company, Source src)
1085{
1086 assert(num_pieces > 0);
1087
1088 Station *st = Station::Get(dest);
1089
1090 /* Give the goods to the industry. */
1091 uint accepted_ind = DeliverGoodsToIndustry(st, cargo_type, num_pieces, src.type == SourceType::Industry ? src.ToIndustryID() : IndustryID::Invalid(), company->index);
1092
1093 /* If this cargo type is always accepted, accept all */
1094 uint accepted_total = st->always_accepted.Test(cargo_type) ? num_pieces : accepted_ind;
1095
1096 /* Update station statistics */
1097 if (accepted_total > 0) {
1099 }
1100
1101 /* Update company statistics */
1102 company->cur_economy.delivered_cargo[cargo_type] += accepted_total;
1103
1104 /* Increase town's counter for town effects */
1105 const CargoSpec *cs = CargoSpec::Get(cargo_type);
1106 st->town->received[cs->town_acceptance_effect].new_act += accepted_total;
1107 if (accepted_total - accepted_ind > 0) {
1108 /* Cargo not delivered to an industry must go to the town. */
1109 st->town->GetOrCreateCargoAccepted(cargo_type).history[THIS_MONTH].accepted += accepted_total - accepted_ind;
1110 }
1111
1112 /* Determine profit */
1113 Money profit = GetTransportedGoodsIncome(accepted_total, distance, periods_in_transit, cargo_type);
1114
1115 /* Update the cargo monitor. */
1116 AddCargoDelivery(cargo_type, company->index, accepted_total - accepted_ind, src, st);
1117
1118 /* Modify profit if a subsidy is in effect */
1119 if (CheckSubsidised(cargo_type, company->index, src, st)) {
1120 switch (_settings_game.difficulty.subsidy_multiplier) {
1121 case 0: profit += profit >> 1; break;
1122 case 1: profit *= 2; break;
1123 case 2: profit *= 3; break;
1124 default: profit *= 4; break;
1125 }
1126 }
1127
1128 return profit;
1129}
1130
1137{
1138 const IndustrySpec *indspec = GetIndustrySpec(i->type);
1139 IndustryCallbackMasks cbm = indspec->callback_mask;
1140
1141 i->was_cargo_delivered = true;
1142
1146 } else {
1147 SetWindowDirty(WindowClass::IndustryView, i->index);
1148 }
1149 } else {
1150 for (auto ita = std::begin(i->accepted); ita != std::end(i->accepted); ++ita) {
1151 if (ita->waiting == 0 || !IsValidCargoType(ita->cargo)) continue;
1152
1153 for (auto itp = std::begin(i->produced); itp != std::end(i->produced); ++itp) {
1154 if (!IsValidCargoType(itp->cargo)) continue;
1155 itp->waiting = ClampTo<uint16_t>(itp->waiting + (ita->waiting * indspec->input_cargo_multiplier[ita - std::begin(i->accepted)][itp - std::begin(i->produced)] / 256));
1156 }
1157
1158 ita->waiting = 0;
1159 }
1160 }
1161
1163 TriggerIndustryAnimation(i, IndustryAnimationTrigger::CargoReceived);
1164}
1165
1171CargoPayment::CargoPayment(CargoPaymentID index, Vehicle *front) :
1173 current_station(front->last_station_visited),
1174 front(front)
1175{
1176}
1177
1180{
1181 if (CleaningPool()) return;
1182
1183 this->front->cargo_payment = nullptr;
1184
1185 if (this->visual_profit == 0 && this->visual_transfer == 0) return;
1186
1187 AutoRestoreBackup cur_company(_current_company, this->front->owner);
1188
1189 SubtractMoneyFromCompany(_current_company, CommandCost(this->front->GetExpenseType(true), -this->route_profit));
1190 this->front->profit_this_year += (this->visual_profit + this->visual_transfer) << 8;
1191
1192 const Vehicle *moving_front = this->front->GetMovingFront();
1193 if (this->route_profit != 0 && IsLocalCompany() && !PlayVehicleSound(this->front, VSE_LOAD_UNLOAD)) {
1194 SndPlayVehicleFx(SND_14_CASHTILL, this->front);
1195 }
1196
1197 if (this->visual_transfer != 0) {
1198 ShowFeederIncomeAnimation(moving_front->x_pos, moving_front->y_pos,
1199 moving_front->z_pos, this->visual_transfer, -this->visual_profit);
1200 } else {
1201 ShowCostOrIncomeAnimation(moving_front->x_pos, moving_front->y_pos,
1202 moving_front->z_pos, -this->visual_profit);
1203 }
1204}
1205
1213void CargoPayment::PayFinalDelivery(CargoType cargo, const CargoPacket *cp, uint count, TileIndex current_tile)
1214{
1215 /* Handle end of route payment */
1216 Money profit = DeliverGoods(count, cargo, this->current_station, cp->GetDistance(current_tile), cp->GetPeriodsInTransit(), Company::Get(this->front->owner), cp->GetSource());
1217 this->route_profit += profit;
1218
1219 /* The vehicle's profit is whatever route profit there is minus feeder shares. */
1220 this->visual_profit += profit - cp->GetFeederShare(count);
1221}
1222
1231Money CargoPayment::PayTransfer(CargoType cargo, const CargoPacket *cp, uint count, TileIndex current_tile)
1232{
1233 /* Pay transfer vehicle the difference between the payment for the journey from
1234 * the source to the current point, and the sum of the previous transfer payments */
1235 Money profit = -cp->GetFeederShare(count) + GetTransportedGoodsIncome(
1236 count,
1237 cp->GetDistance(current_tile),
1238 cp->GetPeriodsInTransit(),
1239 cargo);
1240
1241 profit = profit * _settings_game.economy.feeder_payment_share / 100;
1242
1243 this->visual_transfer += profit; // accumulate transfer profits for whole vehicle
1244 return profit; // account for the (virtual) profit already made for the cargo packet
1245}
1246
1252{
1253 Station *curr_station = Station::Get(front_v->last_station_visited);
1254 curr_station->loading_vehicles.push_back(front_v);
1255
1256 /* At this moment loading cannot be finished */
1258
1259 /* Start unloading at the first possible moment */
1260 front_v->load_unload_ticks = 1;
1261
1262 assert(front_v->cargo_payment == nullptr);
1263 /* One CargoPayment per vehicle and the vehicle limit equals the
1264 * limit in number of CargoPayments. Can't go wrong. */
1267 front_v->cargo_payment = CargoPayment::Create(front_v);
1268
1269 std::vector<StationID> next_station;
1270 front_v->GetNextStoppingStation(next_station);
1271 if (front_v->orders == nullptr || front_v->current_order.GetUnloadType() != OrderUnloadType::NoUnload) {
1273 for (Vehicle *v = front_v; v != nullptr; v = v->Next()) {
1274 const GoodsEntry *ge = &st->goods[v->cargo_type];
1275 if (v->cargo_cap > 0 && v->cargo.TotalCount() > 0) {
1276 v->cargo.Stage(
1278 front_v->last_station_visited, next_station,
1279 front_v->current_order.GetUnloadType(), ge,
1280 v->cargo_type, front_v->cargo_payment,
1281 v->GetMovingFront()->GetCargoTile());
1282 if (v->cargo.UnloadCount() > 0) v->vehicle_flags.Set(VehicleFlag::CargoUnloading);
1283 }
1284 }
1285 }
1286}
1287
1294static uint GetLoadAmount(Vehicle *v)
1295{
1296 const Engine *e = v->GetEngine();
1297 uint load_amount = e->info.load_amount;
1298
1299 /* The default loadamount for mail is 1/4 of the load amount for passengers */
1300 bool air_mail = v->type == VehicleType::Aircraft && !Aircraft::From(v)->IsNormalAircraft();
1301 if (air_mail) load_amount = CeilDiv(load_amount, 4);
1302
1303 if (_settings_game.order.gradual_loading) {
1304 uint16_t cb_load_amount = CALLBACK_FAILED;
1305 if (e->GetGRF() != nullptr && e->GetGRF()->grf_version >= 8) {
1306 /* Use callback 36 */
1307 cb_load_amount = GetVehicleProperty(v, PROP_VEHICLE_LOAD_AMOUNT, CALLBACK_FAILED);
1309 /* Use callback 12 */
1310 cb_load_amount = GetVehicleCallback(CBID_VEHICLE_LOAD_AMOUNT, 0, 0, v->engine_type, v);
1311 }
1312 if (cb_load_amount != CALLBACK_FAILED) {
1313 if (e->GetGRF()->grf_version < 8) cb_load_amount = GB(cb_load_amount, 0, 8);
1314 if (cb_load_amount >= 0x100) {
1316 } else if (cb_load_amount != 0) {
1317 load_amount = cb_load_amount;
1318 }
1319 }
1320 }
1321
1322 /* Scale load amount the same as capacity */
1323 if (e->info.misc_flags.Test(EngineMiscFlag::NoDefaultCargoMultiplier) && !air_mail) load_amount = CeilDiv(load_amount * CargoSpec::Get(v->cargo_type)->multiplier, 0x100);
1324
1325 /* Zero load amount breaks a lot of things. */
1326 return std::max(1u, load_amount);
1327}
1328
1338template <class Taction>
1339bool IterateVehicleParts(Vehicle *v, Taction action)
1340{
1341 for (Vehicle *w = v; w != nullptr;
1342 w = w->HasArticulatedPart() ? w->GetNextArticulatedPart() : nullptr) {
1343 if (!action(w)) return false;
1344 if (w->type == VehicleType::Train) {
1345 Train *train = Train::From(w);
1346 if (train->IsMultiheaded() && !action(train->other_multiheaded_part)) return false;
1347 }
1348 }
1349 if (v->type == VehicleType::Aircraft && Aircraft::From(v)->IsNormalAircraft()) return action(v->Next());
1350 return true;
1351}
1352
1357{
1363 bool operator()(const Vehicle *v)
1364 {
1365 return v->cargo.StoredCount() == 0;
1366 }
1367};
1368
1373{
1375 CargoTypes &refit_mask;
1376
1384
1391 bool operator()(const Vehicle *v)
1392 {
1393 this->consist_capleft[v->cargo_type] -= v->cargo_cap - v->cargo.ReservedCount();
1394 this->refit_mask.Set(EngInfo(v->engine_type)->refit_mask);
1395 return true;
1396 }
1397};
1398
1403{
1405 StationID next_hop;
1406
1412 ReturnCargoAction(Station *st, StationID next_one) : st(st), next_hop(next_one) {}
1413
1420 {
1421 v->cargo.Return(UINT_MAX, &this->st->goods[v->cargo_type].GetOrCreateData().cargo, this->next_hop, v->GetCargoTile());
1422 return true;
1423 }
1424};
1425
1430{
1433 std::span<const StationID> next_station;
1435
1445
1453 {
1454 if (this->do_reserve) {
1455 this->st->goods[v->cargo_type].GetOrCreateData().cargo.Reserve(v->cargo_cap - v->cargo.RemainingCount(),
1456 &v->cargo, this->next_station, v->GetCargoTile());
1457 }
1458 this->consist_capleft[v->cargo_type] += v->cargo_cap - v->cargo.RemainingCount();
1459 return true;
1460 }
1461};
1462
1471static void HandleStationRefit(Vehicle *v, CargoArray &consist_capleft, Station *st, std::span<const StationID> next_station, CargoType new_cargo_type)
1472{
1473 Vehicle *v_start = v->GetFirstEnginePart();
1474 if (!IterateVehicleParts(v_start, IsEmptyAction())) return;
1475
1476 AutoRestoreBackup cur_company(_current_company, v->owner);
1477
1478 CargoTypes refit_mask = v->GetEngine()->info.refit_mask;
1479
1480 /* Remove old capacity from consist capacity and collect refit mask. */
1481 IterateVehicleParts(v_start, PrepareRefitAction(consist_capleft, refit_mask));
1482
1483 bool is_auto_refit = new_cargo_type == CARGO_AUTO_REFIT;
1484 if (is_auto_refit) {
1485 /* Get a refittable cargo type with waiting cargo for next_station or StationID::Invalid(). */
1486 new_cargo_type = v_start->cargo_type;
1487 for (CargoType cargo_type : refit_mask) {
1488 if (st->goods[cargo_type].HasData() && st->goods[cargo_type].GetData().cargo.HasCargoFor(next_station)) {
1489 /* Try to find out if auto-refitting would succeed. In case the refit is allowed,
1490 * the returned refit capacity will be greater than zero. */
1491 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.
1492 /* Try to balance different loadable cargoes between parts of the consist, so that
1493 * all of them can be loaded. Avoid a situation where all vehicles suddenly switch
1494 * to the first loadable cargo for which there is only one packet. If the capacities
1495 * are equal refit to the cargo of which most is available. This is important for
1496 * consists of only a single vehicle as those will generally have a consist_capleft
1497 * of 0 for all cargoes. */
1498 if (refit_capacity > 0 && (consist_capleft[cargo_type] < consist_capleft[new_cargo_type] ||
1499 (consist_capleft[cargo_type] == consist_capleft[new_cargo_type] &&
1500 st->goods[cargo_type].AvailableCount() > st->goods[new_cargo_type].AvailableCount()))) {
1501 new_cargo_type = cargo_type;
1502 }
1503 }
1504 }
1505 }
1506
1507 /* Refit if given a valid cargo. */
1508 if (new_cargo_type < NUM_CARGO && new_cargo_type != v_start->cargo_type) {
1509 /* StationID::Invalid() because in the DistributionType::Manual case that's correct and in the DT_(A)SYMMETRIC
1510 * cases the next hop of the vehicle doesn't really tell us anything if the cargo had been
1511 * "via any station" before reserving. We rather produce some more "any station" cargo than
1512 * misrouting it. */
1513 IterateVehicleParts(v_start, ReturnCargoAction(st, StationID::Invalid()));
1514 CommandCost cost = ExtractCommandCost(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.
1515 if (cost.Succeeded()) v->First()->profit_this_year -= cost.GetCost() << 8;
1516 }
1517
1518 /* Add new capacity to consist capacity and reserve cargo */
1519 IterateVehicleParts(v_start, FinalizeRefitAction(consist_capleft, st, next_station,
1520 is_auto_refit || v->First()->current_order.IsFullLoadOrder()));
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 != VehicleType::Train || !Train::From(v)->IsRearDualheaded()) &&
1575 (v->type != VehicleType::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 == VehicleType::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->GetMovingFront()->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 const Vehicle *moving_front = front->GetMovingFront();
1631 if (front->type == VehicleType::Train && (!IsTileType(moving_front->tile, TileType::Station) || GetStationIndex(moving_front->tile) != st->index)) {
1632 /* The train reversed in the station. Take the "easy" way
1633 * out and let the train just leave as it always did. */
1635 front->load_unload_ticks = 1;
1636 return;
1637 }
1638
1639 int new_load_unload_ticks = 0;
1640 bool dirty_vehicle = false;
1641 bool dirty_station = false;
1642
1643 bool completely_emptied = true;
1644 bool anything_unloaded = false;
1645 bool anything_loaded = false;
1646 CargoTypes full_load_amount{};
1647 CargoTypes cargo_not_full{};
1648 CargoTypes cargo_full{};
1649 CargoTypes reservation_left{};
1650
1651 front->cur_speed = 0;
1652
1653 CargoPayment *payment = front->cargo_payment;
1654
1655 uint artic_part = 0; // Articulated part we are currently trying to load. (not counting parts without capacity)
1656 for (Vehicle *v = front; v != nullptr; v = v->Next()) {
1657 if (v == front || !v->Previous()->HasArticulatedPart()) artic_part = 0;
1658 if (v->cargo_cap == 0) continue;
1659 artic_part++;
1660
1661 GoodsEntry *ge = &st->goods[v->cargo_type];
1662
1663 if (v->vehicle_flags.Test(VehicleFlag::CargoUnloading) && front->current_order.GetUnloadType() != OrderUnloadType::NoUnload) {
1664 uint cargo_count = v->cargo.UnloadCount();
1665 uint amount_unloaded = _settings_game.order.gradual_loading ? std::min(cargo_count, GetLoadAmount(v)) : cargo_count;
1666 bool remaining = false; // Are there cargo entities in this vehicle that can still be unloaded here?
1667
1668 if (!ge->status.Test(GoodsEntry::State::Acceptance) && v->cargo.ActionCount(VehicleCargoList::MoveToAction::Deliver) > 0) {
1669 /* The station does not accept our goods anymore. */
1671 /* Transfer instead of delivering. */
1672 v->cargo.Reassign<VehicleCargoList::MoveToAction::Deliver, VehicleCargoList::MoveToAction::Transfer>(
1673 v->cargo.ActionCount(VehicleCargoList::MoveToAction::Deliver));
1674 } else {
1675 uint new_remaining = v->cargo.RemainingCount() + v->cargo.ActionCount(VehicleCargoList::MoveToAction::Deliver);
1676 if (v->cargo_cap < new_remaining) {
1677 /* Return some of the reserved cargo to not overload the vehicle. */
1678 v->cargo.Return(new_remaining - v->cargo_cap, &ge->GetOrCreateData().cargo, StationID::Invalid(), v->GetCargoTile());
1679 }
1680
1681 /* Keep instead of delivering. This may lead to no cargo being unloaded, so ...*/
1682 v->cargo.Reassign<VehicleCargoList::MoveToAction::Deliver, VehicleCargoList::MoveToAction::Keep>(
1683 v->cargo.ActionCount(VehicleCargoList::MoveToAction::Deliver));
1684
1685 /* ... say we unloaded something, otherwise we'll think we didn't unload
1686 * something and we didn't load something, so we must be finished
1687 * at this station. Setting the unloaded means that we will get a
1688 * retry for loading in the next cycle. */
1689 anything_unloaded = true;
1690 }
1691 }
1692
1693 if (v->cargo.ActionCount(VehicleCargoList::MoveToAction::Transfer) > 0) {
1694 /* Mark the station dirty if we transfer, but not if we only deliver. */
1695 dirty_station = true;
1696
1697 if (!ge->HasRating()) {
1698 /* Upon transferring cargo, make sure the station has a rating. Fake a pickup for the
1699 * first unload to prevent the cargo from quickly decaying after the initial drop. */
1700 ge->time_since_pickup = 0;
1702 }
1703 }
1704
1705 assert(payment != nullptr);
1706 amount_unloaded = v->cargo.Unload(amount_unloaded, &ge->GetOrCreateData().cargo, v->cargo_type, payment, v->GetCargoTile());
1707 remaining = v->cargo.UnloadCount() > 0;
1708 if (amount_unloaded > 0) {
1709 dirty_vehicle = true;
1710 anything_unloaded = true;
1711 new_load_unload_ticks += amount_unloaded;
1712
1713 /* Deliver goods to the station */
1714 st->time_since_unload = 0;
1715 }
1716
1717 if (_settings_game.order.gradual_loading && remaining) {
1718 completely_emptied = false;
1719 } else {
1720 /* We have finished unloading (cargo count == 0) */
1721 v->vehicle_flags.Reset(VehicleFlag::CargoUnloading);
1722 }
1723
1724 continue;
1725 }
1726
1727 /* Do not pick up goods when we have no-load set or loading is stopped. */
1729
1730 /* This order has a refit, if this is the first vehicle part carrying cargo and the whole vehicle is empty, try refitting. */
1731 if (front->current_order.IsRefit() && artic_part == 1) {
1732 HandleStationRefit(v, consist_capleft, st, next_station, front->current_order.GetRefitCargo());
1733 ge = &st->goods[v->cargo_type];
1734 }
1735
1736 /* As we're loading here the following link can carry the full capacity of the vehicle. */
1737 v->refit_cap = v->cargo_cap;
1738
1739 /* update stats */
1740 int t;
1741 switch (front->type) {
1742 case VehicleType::Train:
1743 case VehicleType::Ship:
1744 t = front->vcache.cached_max_speed;
1745 break;
1746
1747 case VehicleType::Road:
1748 t = front->vcache.cached_max_speed / 2;
1749 break;
1750
1752 t = Aircraft::From(front)->GetSpeedOldUnits(); // Convert to old units.
1753 break;
1754
1755 default: NOT_REACHED();
1756 }
1757
1758 /* if last speed is 0, we treat that as if no vehicle has ever visited the station. */
1761
1762 assert(v->cargo_cap >= v->cargo.StoredCount());
1763 /* Capacity available for loading more cargo. */
1764 uint cap_left = v->cargo_cap - v->cargo.StoredCount();
1765
1766 if (cap_left > 0) {
1767 /* If vehicle can load cargo, reset time_since_pickup. */
1768 ge->time_since_pickup = 0;
1769
1770 /* If there's goods waiting at the station, and the vehicle
1771 * has capacity for it, load it on the vehicle. */
1772 if ((v->cargo.ActionCount(VehicleCargoList::MoveToAction::Load) > 0 || ge->AvailableCount() > 0) && MayLoadUnderExclusiveRights(st, v)) {
1773 if (v->cargo.StoredCount() == 0) TriggerVehicleRandomisation(v, VehicleRandomTrigger::NewCargo);
1774 if (_settings_game.order.gradual_loading) cap_left = std::min(cap_left, GetLoadAmount(v));
1775
1776 uint loaded = ge->GetOrCreateData().cargo.Load(cap_left, &v->cargo, next_station, v->GetCargoTile());
1777 if (v->cargo.ActionCount(VehicleCargoList::MoveToAction::Load) > 0) {
1778 /* Remember if there are reservations left so that we don't stop
1779 * loading before they're loaded. */
1780 reservation_left.Set(v->cargo_type);
1781 }
1782
1783 /* Store whether the maximum possible load amount was loaded or not.*/
1784 if (loaded == cap_left) {
1785 full_load_amount.Set(v->cargo_type);
1786 } else {
1787 full_load_amount.Reset(v->cargo_type);
1788 }
1789
1790 /* TODO: Regarding this, when we do gradual loading, we
1791 * should first unload all vehicles and then start
1792 * loading them. Since this will cause
1793 * VEHICLE_TRIGGER_EMPTY to be called at the time when
1794 * the whole vehicle chain is really totally empty, the
1795 * completely_emptied assignment can then be safely
1796 * removed; that's how TTDPatch behaves too. --pasky */
1797 if (loaded > 0) {
1798 completely_emptied = false;
1799 anything_loaded = true;
1800
1801 st->time_since_load = 0;
1802 st->last_vehicle_type = v->type;
1803
1804 if (ge->GetData().cargo.TotalCount() == 0) {
1806 TriggerStationAnimation(st, st->xy, StationAnimationTrigger::CargoTaken, v->cargo_type);
1807 TriggerAirportAnimation(st, AirportAnimationTrigger::CargoTaken, v->cargo_type);
1809 TriggerRoadStopAnimation(st, st->xy, StationAnimationTrigger::CargoTaken, v->cargo_type);
1810 }
1811
1812 new_load_unload_ticks += loaded;
1813
1814 dirty_vehicle = dirty_station = true;
1815 }
1816 }
1817 }
1818
1819 if (v->cargo.StoredCount() >= v->cargo_cap) {
1820 cargo_full.Set(v->cargo_type);
1821 } else {
1822 cargo_not_full.Set(v->cargo_type);
1823 }
1824 }
1825
1826 if (anything_loaded || anything_unloaded) {
1827 if (front->type == VehicleType::Train) {
1829 TriggerStationAnimation(st, moving_front->tile, StationAnimationTrigger::VehicleLoads);
1830 } else if (front->type == VehicleType::Road) {
1832 TriggerRoadStopAnimation(st, front->tile, StationAnimationTrigger::VehicleLoads);
1833 }
1834 }
1835
1836 /* Only set completely_emptied, if we just unloaded all remaining cargo */
1837 completely_emptied &= anything_unloaded;
1838
1839 if (!anything_unloaded) delete payment;
1840
1842 if (anything_loaded || anything_unloaded) {
1843 if (_settings_game.order.gradual_loading) {
1844 /* The time it takes to load one 'slice' of cargo or passengers depends
1845 * on the vehicle type - the values here are those found in TTDPatch */
1846 constexpr VehicleTypeIndexArray<const uint> gradual_loading_wait_time = { 40, 20, 10, 20 };
1847
1848 new_load_unload_ticks = gradual_loading_wait_time[front->type];
1849 }
1850 /* We loaded less cargo than possible for all cargo types and it's not full
1851 * load and we're not supposed to wait any longer: stop loading. */
1852 if (!anything_unloaded && full_load_amount.None() && reservation_left.None() && !front->current_order.IsFullLoadOrder() &&
1853 front->current_order_time >= std::max(front->current_order.GetTimetabledWait() - front->lateness_counter, 0)) {
1855 }
1856
1857 UpdateLoadUnloadTicks(front, st, new_load_unload_ticks);
1858 } else {
1859 UpdateLoadUnloadTicks(front, st, 20); // We need the ticks for link refreshing.
1860 bool finished_loading = true;
1861 if (front->current_order.IsFullLoadOrder()) {
1863 /* if the aircraft carries passengers and is NOT full, then
1864 * continue loading, no matter how much mail is in */
1865 if ((front->type == VehicleType::Aircraft && IsCargoInClass(front->cargo_type, CargoClass::Passengers) && front->cargo_cap > front->cargo.StoredCount()) ||
1866 (cargo_not_full.Any() && cargo_full.Reset(cargo_not_full).None())) { // There are still non-full cargoes
1867 finished_loading = false;
1868 }
1869 } else if (cargo_not_full.Any()) {
1870 finished_loading = false;
1871 }
1872
1873 /* Refresh next hop stats if we're full loading to make the links
1874 * known to the distribution algorithm and allow cargo to be sent
1875 * along them. Otherwise the vehicle could wait for cargo
1876 * indefinitely if it hasn't visited the other links yet, or if the
1877 * links die while it's loading. */
1878 if (!finished_loading) LinkRefresher::Run(front, true, true);
1879 }
1880
1881 front->vehicle_flags.Set(VehicleFlag::LoadingFinished, finished_loading);
1882 }
1883
1884 /* Calculate the loading indicator fill percent and display
1885 * In the Game Menu do not display indicators
1886 * If _settings_client.gui.loading_indicators == 2, show indicators (bool can be promoted to int as 0 or 1 - results in 2 > 0,1 )
1887 * if _settings_client.gui.loading_indicators == 1, _local_company must be the owner or must be a spectator to show ind., so 1 > 0
1888 * if _settings_client.gui.loading_indicators == 0, do not display indicators ... 0 is never greater than anything
1889 */
1890 if (_game_mode != GameMode::Menu && (_settings_client.gui.loading_indicators > (uint)(front->owner != _local_company && _local_company != COMPANY_SPECTATOR))) {
1891 StringID percent_up_down = STR_NULL;
1892 int percent = CalcPercentVehicleFilled(front, &percent_up_down);
1893 if (front->fill_percent_te_id == INVALID_TE_ID) {
1894 front->fill_percent_te_id = ShowFillingPercent(moving_front->x_pos, moving_front->y_pos, moving_front->z_pos + 20, percent, percent_up_down);
1895 } else {
1896 UpdateFillingPercent(front->fill_percent_te_id, percent, percent_up_down);
1897 }
1898 }
1899
1900 if (completely_emptied) {
1901 /* Make sure the vehicle is marked dirty, since we need to update the NewGRF
1902 * properties such as weight, power and TE whenever the trigger runs. */
1903 dirty_vehicle = true;
1904 TriggerVehicleRandomisation(front, VehicleRandomTrigger::Empty);
1905 }
1906
1907 if (dirty_vehicle) {
1909 SetWindowDirty(WindowClass::VehicleDetails, front->index);
1910 front->MarkDirty();
1911 }
1912 if (dirty_station) {
1913 st->MarkTilesDirty(true);
1914 SetWindowDirty(WindowClass::StationView, st->index);
1915 SetWindowDirty(WindowClass::StationList, st->owner);
1916 }
1917}
1918
1925{
1926 /* No vehicle is here... */
1927 if (st->loading_vehicles.empty()) return;
1928
1929 Vehicle *last_loading = nullptr;
1930
1931 /* Check if anything will be loaded at all. Otherwise we don't need to reserve either. */
1932 for (Vehicle *v : st->loading_vehicles) {
1933 if (v->vehstatus.Any({VehState::Stopped, VehState::Crashed})) continue;
1934
1935 assert(v->load_unload_ticks != 0);
1936 if (--v->load_unload_ticks == 0) last_loading = v;
1937 }
1938
1939 /* We only need to reserve and load/unload up to the last loading vehicle.
1940 * Anything else will be forgotten anyway after returning from this function.
1941 *
1942 * Especially this means we do _not_ need to reserve cargo for a single
1943 * consist in a station which is not allowed to load yet because its
1944 * load_unload_ticks is still not 0.
1945 */
1946 if (last_loading == nullptr) return;
1947
1948 for (Vehicle *v : st->loading_vehicles) {
1949 if (!v->vehstatus.Any({VehState::Stopped, VehState::Crashed})) LoadUnloadVehicle(v);
1950 if (v == last_loading) break;
1951 }
1952
1953 /* Call the production machinery of industries */
1956 }
1958}
1959
1963static const IntervalTimer<TimerGameCalendar> _calendar_inflation_monthly({TimerGameCalendar::Trigger::Month, TimerGameCalendar::Priority::Company}, [](auto)
1964{
1965 if (_settings_game.economy.inflation) {
1966 AddInflation();
1968 }
1969});
1970
1974static const IntervalTimer<TimerGameEconomy> _economy_companies_monthly({ TimerGameEconomy::Trigger::Month, TimerGameEconomy::Priority::Company }, [](auto)
1975{
1978 HandleEconomyFluctuations();
1979});
1980
1981static void DoAcquireCompany(Company *c, bool hostile_takeover)
1982{
1983 CompanyID ci = c->index;
1984
1985 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_MERGER_TITLE, c, Company::Get(_current_company));
1986 EncodedString headline = hostile_takeover
1987 ? GetEncodedString(STR_NEWS_MERGER_TAKEOVER_TITLE, cni->company_name, cni->other_company_name)
1988 : GetEncodedString(STR_NEWS_COMPANY_MERGER_DESCRIPTION, cni->company_name, cni->other_company_name, c->bankrupt_value);
1989 AddCompanyNewsItem(std::move(headline), std::move(cni));
1990 AI::BroadcastNewEvent(new ScriptEventCompanyMerger(ci, _current_company));
1991 Game::NewEvent(new ScriptEventCompanyMerger(ci, _current_company));
1992
1994
1995 if (c->is_ai) AI::Stop(c->index);
1996
1998 InvalidateWindowClassesData(WindowClass::TrainList, 0);
1999 InvalidateWindowClassesData(WindowClass::ShipList, 0);
2000 InvalidateWindowClassesData(WindowClass::RoadVehicleList, 0);
2001 InvalidateWindowClassesData(WindowClass::AircraftList, 0);
2002 InvalidateWindowData(WindowClass::NetworkClientList, 0);
2003
2004 delete c;
2005}
2006
2017CommandCost CmdBuyCompany(DoCommandFlags flags, CompanyID target_company, bool hostile_takeover)
2018{
2019 Company *c = Company::GetIfValid(target_company);
2020 if (c == nullptr) return CMD_ERROR;
2021
2022 /* If you do a hostile takeover but the company went bankrupt, buy it via bankruptcy rules. */
2023 if (hostile_takeover && c->bankrupt_asked.Test(_current_company)) hostile_takeover = false;
2024
2025 /* Disable takeovers when not asked */
2026 if (!hostile_takeover && !c->bankrupt_asked.Test(_current_company)) return CMD_ERROR;
2027
2028 /* Only allow hostile takeover of AI companies and when in single player */
2029 if (hostile_takeover && !c->is_ai) return CMD_ERROR;
2030 if (hostile_takeover && _networking) return CMD_ERROR;
2031
2032 /* Disable taking over the local company in singleplayer mode */
2033 if (!_networking && _local_company == c->index) return CMD_ERROR;
2034
2035 /* Do not allow companies to take over themselves */
2036 if (target_company == _current_company) return CMD_ERROR;
2037
2038 /* Do not allow takeover if the resulting company would have too many vehicles. */
2039 if (!CheckTakeoverVehicleLimit(_current_company, target_company)) return CommandCost(STR_ERROR_TOO_MANY_VEHICLES_IN_GAME);
2040
2041 /* Get the cost here as the company is deleted in DoAcquireCompany.
2042 * For bankruptcy this amount is calculated when the offer was made;
2043 * for hostile takeover you pay the current price. */
2044 CommandCost cost(ExpensesType::Other, hostile_takeover ? CalculateHostileTakeoverValue(c) : c->bankrupt_value);
2045
2046 if (flags.Test(DoCommandFlag::Execute)) {
2047 DoAcquireCompany(c, hostile_takeover);
2048 }
2049 return cost;
2050}
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 bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Types related to cargoes...
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
Definition cargo_type.h:110
static constexpr CargoType CARGO_AUTO_REFIT
Automatically choose cargo type when doing auto refitting.
Definition cargo_type.h:78
CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:22
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:51
bool IsCargoInClass(CargoType cargo, CargoClasses cc)
Does cargo c have cargo class cc?
Definition cargotype.h:236
static void BroadcastNewEvent(ScriptEvent *event, CompanyID skip_company=CompanyID::Invalid())
Broadcast a new event to all active AIs.
Definition ai_core.cpp:240
static void Stop(CompanyID company)
Stop a company to be controlled by an AI.
Definition ai_core.cpp:103
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr bool None() const
Test if none of the values are 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:182
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
UnitID UseID(UnitID index)
Use a unit number.
Definition vehicle.cpp:1888
UnitID NextID() const
Find first unused unit number.
Definition vehicle.cpp:1873
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.
CommandCost & ExtractCommandCost(Tret &ret)
Extract the CommandCost from a command proc result.
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 SetLocalCompany(CompanyID new_company, bool switching_game)
Sets the local company and updates the settings that are set on a per-company basis to reflect the co...
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?
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
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:800
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:1924
void RecomputePrices()
Computes all prices, payments and maximum loan.
Definition economy.cpp:733
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:1029
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:1017
void PrepareUnload(Vehicle *front_v)
Prepare the vehicle to be unloaded.
Definition economy.cpp:1251
static uint GetLoadAmount(Vehicle *v)
Gets the amount of cargo the given vehicle can load in the current tick.
Definition economy.cpp:1294
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:1471
void SetPriceBaseMultiplier(Price price, int factor)
Change a price base by the given factor.
Definition economy.cpp:869
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition economy.cpp:936
static void TriggerIndustryProduction(Industry *i)
Inform the industry about just delivered cargo DeliverGoodsToIndustry() silently incremented incoming...
Definition economy.cpp:1136
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:1339
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:1084
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:921
static void CompanyCheckBankrupt(Company *c)
Check for bankruptcy of a company.
Definition economy.cpp:546
void ResetPriceBaseMultipliers()
Reset changes to the price base multipliers.
Definition economy.cpp:857
static void CompaniesGenStatistics()
Update the finances of all companies.
Definition economy.cpp:637
bool AddInflation(bool check_year)
Add monthly inflation.
Definition economy.cpp:695
CommandCost CmdBuyCompany(DoCommandFlags flags, CompanyID target_company, bool hostile_takeover)
Buy up another company.
Definition economy.cpp:2017
const EnumIndexArray< ScoreInfo, ScoreID, ScoreID::End > _score_info
Score info, values used for computing the detailed performance rating.
Definition economy.cpp:91
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:879
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 quarter.
@ MinIncome
Income in the quarter with the lowest profit of the last 12 quarters.
@ 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 quarter with the highest profit of the last 12 quarters.
@ 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 quarter.
static const int MIN_PRICE_MODIFIER
Maximum NewGRF price modifiers.
EnumIndexArray< Money, Price, Price::End > Prices
Prices of everything.
@ LoanInterest
Interest payments over the loan.
@ Property
Property costs.
@ Other
Other expenses.
@ Construction
Price is affected by "construction cost" difficulty setting.
@ Running
Price is affected by "vehicle running 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...
EnumClassIndexContainer< std::array< T, to_underlying(N)>, Index > EnumIndexArray
A typedef for EnumClassIndexContainer using std::array as the backing container type.
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:1553
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 T ScaleByPercentage(U num, uint16_t percentage)
Scale a number by the required percentage.
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:508
void ShowFeederIncomeAnimation(int x, int y, int z, Money transfer, Money income)
Display animated feeder income.
Definition misc_gui.cpp:531
void UpdateFillingPercent(TextEffectID te_id, uint8_t percent, StringID string)
Update vehicle loading indicators.
Definition misc_gui.cpp:571
TextEffectID ShowFillingPercent(int x, int y, int z, uint8_t percent, StringID string)
Display vehicle loading indicators.
Definition misc_gui.cpp:556
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:917
@ 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.
@ Menu
In the main menu.
Definition openttd.h:19
@ 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 IsSignalPresent(Tile t, uint8_t signalbit)
Checks whether the given signals is present.
Definition rail_map.h:463
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:107
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
uint8_t SignalOnTrack(Track track)
Maps a Track to the bits that store the status of the two signals that can be present on the given tr...
Definition signal_func.h:48
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 upon destruction of this object to prevent stack v...
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:117
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:1213
~CargoPayment()
Execute the actual payment to the coffers of the company.
Definition economy.cpp:1179
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:1231
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:75
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:139
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition cargotype.h:192
TownAcceptanceEffect town_acceptance_effect
The effect that delivering this cargo type has on towns. Also affects destination of subsidies.
Definition cargotype.h:87
CargoCallbackMasks callback_mask
Bitmask of cargo callbacks that have to be called.
Definition cargotype.h:90
bool IsValid() const
Tests for validity of this cargospec.
Definition cargotype.h:119
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:1430
std::span< const StationID > next_station
Next hops to reserve cargo for.
Definition economy.cpp:1433
CargoArray & consist_capleft
Capacities left in the consist.
Definition economy.cpp:1431
bool do_reserve
If the vehicle should reserve.
Definition economy.cpp:1434
FinalizeRefitAction(CargoArray &consist_capleft, Station *st, std::span< const StationID > next_station, bool do_reserve)
Create a finalizing action.
Definition economy.cpp:1443
bool operator()(Vehicle *v)
Reserve cargo from the station and update the remaining consist capacities with the vehicle's remaini...
Definition economy.cpp:1452
Station * st
Station to reserve cargo from.
Definition economy.cpp:1432
Dynamic data of a loaded NewGRF.
Definition newgrf.h:119
PriceMultipliers price_base_multipliers
Price base multipliers as set by the grf.
Definition newgrf.h:164
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:1357
bool operator()(const Vehicle *v)
Checks if the vehicle has stored cargo.
Definition economy.cpp:1363
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:1373
CargoTypes & refit_mask
Bitmask of possible refit cargoes.
Definition economy.cpp:1375
PrepareRefitAction(CargoArray &consist_capleft, CargoTypes &refit_mask)
Create a refit preparation action.
Definition economy.cpp:1382
CargoArray & consist_capleft
Capacities left in the consist.
Definition economy.cpp:1374
bool operator()(const Vehicle *v)
Prepares for refitting of a vehicle, subtracting its free capacity from consist_capleft and adding th...
Definition economy.cpp:1391
Action for returning reserved cargo.
Definition economy.cpp:1403
Station * st
Station to give the returned cargo to.
Definition economy.cpp:1404
bool operator()(Vehicle *v)
Return all reserved cargo from a vehicle.
Definition economy.cpp:1419
ReturnCargoAction(Station *st, StationID next_one)
Construct a cargo return action.
Definition economy.cpp:1412
StationID next_hop
Next hop the cargo should be assigned to.
Definition economy.cpp:1405
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.
HistoryData< AcceptedHistory > history
Histor data of accepted cargo.
Definition town.h:117
Town data structure.
Definition town.h:63
AcceptedCargo & GetOrCreateCargoAccepted(CargoType cargo)
Get or create the storage for an accepted cargo.
Definition town.h:159
CompanyID exclusivity
which company has exclusivity
Definition town.h:86
uint8_t exclusive_counter
months till the exclusivity expires
Definition town.h:87
EnumIndexArray< TransportedCargoStat< uint16_t >, TownAcceptanceEffect, TownAcceptanceEffect::End > received
Cargo statistics about received cargotypes.
Definition town.h:132
'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:748
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.
Vehicle * GetMovingFront() const
Get the moving front of the vehicle chain.
VehicleCache vcache
Cache of often used vehicle values.
GroundVehicleCache * GetGroundVehicleCache()
Access the ground vehicle cache of the vehicle.
Definition vehicle.cpp:3211
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:493
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
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:1503
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
@ Ship
Ship vehicle type.
@ Aircraft
Aircraft vehicle type.
@ Road
Road vehicle type.
@ 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.
EnumIndexArray< T, VehicleType, Tend > VehicleTypeIndexArray
Array with VehicleType as index.
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:3230
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:3322
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3200
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:3340