OpenTTD Source 20250529-master-g10c159a79f
company_cmd.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10#include "stdafx.h"
11#include "company_base.h"
12#include "company_func.h"
13#include "company_gui.h"
14#include "core/backup_type.hpp"
15#include "town.h"
16#include "news_func.h"
17#include "command_func.h"
18#include "network/network.h"
22#include "ai/ai.hpp"
23#include "ai/ai_instance.hpp"
24#include "ai/ai_config.hpp"
26#include "window_func.h"
27#include "strings_func.h"
28#include "sound_func.h"
29#include "rail.h"
30#include "core/pool_func.hpp"
31#include "settings_func.h"
32#include "vehicle_base.h"
33#include "vehicle_func.h"
34#include "smallmap_gui.h"
35#include "game/game.hpp"
36#include "goal_base.h"
37#include "story_base.h"
38#include "company_cmd.h"
39#include "timer/timer.h"
42#include "timer/timer_window.h"
43
45
46#include "table/strings.h"
47
48#include "safeguards.h"
49
51void UpdateObjectColours(const Company *c);
52
58
61
62
67Company::Company(StringID name_1, bool is_ai)
68{
69 this->name_1 = name_1;
70 this->is_ai = is_ai;
71 this->terraform_limit = (uint32_t)_settings_game.construction.terraform_frame_burst << 16;
72 this->clear_limit = (uint32_t)_settings_game.construction.clear_frame_burst << 16;
73 this->tree_limit = (uint32_t)_settings_game.construction.tree_frame_burst << 16;
74 this->build_object_limit = (uint32_t)_settings_game.construction.build_object_frame_burst << 16;
75
76 InvalidateWindowData(WC_PERFORMANCE_DETAIL, 0, CompanyID::Invalid());
77}
78
81{
82 if (CleaningPool()) return;
83
85}
86
91void Company::PostDestructor(size_t index)
92{
97 /* If the currently shown error message has this company in it, then close it. */
99}
100
106{
107 if (this->max_loan == COMPANY_MAX_LOAN_DEFAULT) return _economy.max_loan;
108 return this->max_loan;
109}
110
117void SetLocalCompany(CompanyID new_company)
118{
119 /* company could also be COMPANY_SPECTATOR or OWNER_NONE */
120 assert(Company::IsValidID(new_company) || new_company == COMPANY_SPECTATOR || new_company == OWNER_NONE);
121
122 /* If actually changing to another company, several windows need closing */
123 bool switching_company = _local_company != new_company;
124
125 /* Delete the chat window, if you were team chatting. */
127
128 assert(IsLocalCompany());
129
130 _current_company = _local_company = new_company;
131
132 if (switching_company) {
134 /* Delete any construction windows... */
136 }
137
138 /* ... and redraw the whole screen. */
142}
143
150{
151 if (!Company::IsValidID(company)) return (TextColour)GetColourGradient(COLOUR_WHITE, SHADE_NORMAL) | TC_IS_PALETTE_COLOUR;
152 return (TextColour)GetColourGradient(_company_colours[company], SHADE_NORMAL) | TC_IS_PALETTE_COLOUR;
153}
154
164
171void DrawCompanyIcon(CompanyID c, int x, int y)
172{
173 DrawSprite(SPR_COMPANY_ICON, GetCompanyPalette(c), x, y);
174}
175
183{
184 if (!AreCompanyManagerFaceBitsValid(cmf, CMFV_GEN_ETHN, GE_WM)) return false;
185
187 bool has_moustache = !HasBit(ge, GENDER_FEMALE) && GetCompanyManagerFaceBits(cmf, CMFV_HAS_MOUSTACHE, ge) != 0;
188 bool has_tie_earring = !HasBit(ge, GENDER_FEMALE) || GetCompanyManagerFaceBits(cmf, CMFV_HAS_TIE_EARRING, ge) != 0;
189 bool has_glasses = GetCompanyManagerFaceBits(cmf, CMFV_HAS_GLASSES, ge) != 0;
190
191 if (!AreCompanyManagerFaceBitsValid(cmf, CMFV_EYE_COLOUR, ge)) return false;
192 for (CompanyManagerFaceVariable cmfv = CMFV_CHEEKS; cmfv < CMFV_END; cmfv++) {
193 switch (cmfv) {
194 case CMFV_MOUSTACHE: if (!has_moustache) continue; break;
195 case CMFV_LIPS:
196 case CMFV_NOSE: if (has_moustache) continue; break;
197 case CMFV_TIE_EARRING: if (!has_tie_earring) continue; break;
198 case CMFV_GLASSES: if (!has_glasses) continue; break;
199 default: break;
200 }
201 if (!AreCompanyManagerFaceBitsValid(cmf, cmfv, ge)) return false;
202 }
203
204 return true;
205}
206
208
215{
216 CompanyID cid = company->index;
218}
219
223static const IntervalTimer<TimerWindow> invalidate_company_windows_interval(std::chrono::milliseconds(1), [](auto) {
227 if (w != nullptr) {
233 }
235 }
237});
238
247{
248 if (_settings_game.difficulty.infinite_money) return INT64_MAX;
249 if (!Company::IsValidID(company)) return INT64_MAX;
250 return Company::Get(company)->money;
251}
252
264
272{
273 if (cost.GetCost() <= 0) return true;
275
277 if (c != nullptr && cost.GetCost() > c->money) {
278 cost.MakeError(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY);
279 if (IsLocalCompany()) {
280 cost.SetEncodedMessage(GetEncodedString(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY, cost.GetCost()));
281 }
282 return false;
283 }
284 return true;
285}
286
293{
294 if (cost.GetCost() == 0) return;
295 assert(cost.GetExpensesType() != INVALID_EXPENSES);
296
297 c->money -= cost.GetCost();
298 c->yearly_expenses[0][cost.GetExpensesType()] += cost.GetCost();
299
304 c->cur_economy.income -= cost.GetCost();
305 } else if (HasBit(1 << EXPENSES_TRAIN_RUN |
308 1 << EXPENSES_SHIP_RUN |
309 1 << EXPENSES_PROPERTY |
311 c->cur_economy.expenses -= cost.GetCost();
312 }
313
315}
316
322{
324 if (c != nullptr) SubtractMoneyFromAnyCompany(c, cost);
325}
326
333{
334 Company *c = Company::Get(company);
335 uint8_t m = c->money_fraction;
336 Money cost = cst.GetCost();
337
338 c->money_fraction = m - (uint8_t)cost;
339 cost >>= 8;
340 if (c->money_fraction > m) cost++;
341 if (cost != 0) SubtractMoneyFromAnyCompany(c, CommandCost(cst.GetExpensesType(), cost));
342}
343
344static constexpr void UpdateLandscapingLimit(uint32_t &limit, uint64_t per_64k_frames, uint64_t burst)
345{
346 limit = static_cast<uint32_t>(std::min<uint64_t>(limit + per_64k_frames, burst << 16));
347}
348
359
366std::array<StringParameter, 2> GetParamsForOwnedBy(Owner owner, TileIndex tile)
367{
368 if (owner == OWNER_TOWN) {
369 assert(tile != 0);
370 const Town *t = ClosestTownFromTile(tile, UINT_MAX);
371 return {STR_TOWN_NAME, t->index};
372 }
373
374 if (!Company::IsValidID(owner)) {
375 return {STR_COMPANY_SOMEONE, std::monostate{}};
376 }
377
378 return {STR_COMPANY_NAME, owner};
379}
380
390{
391 assert(owner < OWNER_END);
392 assert(owner != OWNER_TOWN || tile != 0);
393
394 if (owner == _current_company) return CommandCost();
395
396 CommandCost error{STR_ERROR_OWNED_BY};
397 if (IsLocalCompany()) {
398 auto params = GetParamsForOwnedBy(owner, tile);
399 error.SetEncodedMessage(GetEncodedStringWithArgs(STR_ERROR_OWNED_BY, params));
400 if (owner != OWNER_TOWN) error.SetErrorOwner(owner);
401 }
402 return error;
403}
404
413{
414 return CheckOwnership(GetTileOwner(tile), tile);
415}
416
422{
423 if (c->name_1 != STR_SV_UNNAMED) return;
424 if (c->last_build_coordinate == 0) return;
425
427
428 StringID str;
429 uint32_t strp;
430 std::string name;
431 if (t->name.empty() && IsInsideMM(t->townnametype, SPECSTR_TOWNNAME_START, SPECSTR_TOWNNAME_END)) {
432 str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_COMPANY_NAME_START;
433 strp = t->townnameparts;
434
435verify_name:;
436 /* No companies must have this name already */
437 for (const Company *cc : Company::Iterate()) {
438 if (cc->name_1 == str && cc->name_2 == strp) goto bad_town_name;
439 }
440
441 name = GetString(str, strp);
442 if (Utf8StringLength(name) >= MAX_LENGTH_COMPANY_NAME_CHARS) goto bad_town_name;
443
444set_name:;
445 c->name_1 = str;
446 c->name_2 = strp;
447
449 AI::BroadcastNewEvent(new ScriptEventCompanyRenamed(c->index, name));
450 Game::NewEvent(new ScriptEventCompanyRenamed(c->index, name));
451
452 if (c->is_ai) {
453 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_LAUNCH_TITLE, c);
454 EncodedString headline = GetEncodedString(STR_NEWS_COMPANY_LAUNCH_DESCRIPTION, cni->company_name, t->index);
455 AddNewsItem(std::move(headline),
457 }
458 return;
459 }
460bad_town_name:;
461
463 str = SPECSTR_ANDCO_NAME;
464 strp = c->president_name_2;
465 name = GetString(str, strp);
466 goto set_name;
467 } else {
468 str = SPECSTR_ANDCO_NAME;
469 strp = Random();
470 goto verify_name;
471 }
472}
473
475static const uint8_t _colour_sort[COLOUR_END] = {2, 2, 3, 2, 3, 2, 3, 2, 3, 2, 2, 2, 3, 1, 1, 1};
477static const Colours _similar_colour[COLOUR_END][2] = {
478 { COLOUR_BLUE, COLOUR_LIGHT_BLUE }, // COLOUR_DARK_BLUE
479 { COLOUR_GREEN, COLOUR_DARK_GREEN }, // COLOUR_PALE_GREEN
480 { INVALID_COLOUR, INVALID_COLOUR }, // COLOUR_PINK
481 { COLOUR_ORANGE, INVALID_COLOUR }, // COLOUR_YELLOW
482 { INVALID_COLOUR, INVALID_COLOUR }, // COLOUR_RED
483 { COLOUR_DARK_BLUE, COLOUR_BLUE }, // COLOUR_LIGHT_BLUE
484 { COLOUR_PALE_GREEN, COLOUR_DARK_GREEN }, // COLOUR_GREEN
485 { COLOUR_PALE_GREEN, COLOUR_GREEN }, // COLOUR_DARK_GREEN
486 { COLOUR_DARK_BLUE, COLOUR_LIGHT_BLUE }, // COLOUR_BLUE
487 { COLOUR_BROWN, COLOUR_ORANGE }, // COLOUR_CREAM
488 { COLOUR_PURPLE, INVALID_COLOUR }, // COLOUR_MAUVE
489 { COLOUR_MAUVE, INVALID_COLOUR }, // COLOUR_PURPLE
490 { COLOUR_YELLOW, COLOUR_CREAM }, // COLOUR_ORANGE
491 { COLOUR_CREAM, INVALID_COLOUR }, // COLOUR_BROWN
492 { COLOUR_WHITE, INVALID_COLOUR }, // COLOUR_GREY
493 { COLOUR_GREY, INVALID_COLOUR }, // COLOUR_WHITE
494};
495
500static Colours GenerateCompanyColour()
501{
502 Colours colours[COLOUR_END];
503
504 /* Initialize array */
505 for (uint i = 0; i < COLOUR_END; i++) colours[i] = static_cast<Colours>(i);
506
507 /* And randomize it */
508 for (uint i = 0; i < 100; i++) {
509 uint r = Random();
510 std::swap(colours[GB(r, 0, 4)], colours[GB(r, 4, 4)]);
511 }
512
513 /* Bubble sort it according to the values in table 1 */
514 for (uint i = 0; i < COLOUR_END; i++) {
515 for (uint j = 1; j < COLOUR_END; j++) {
516 if (_colour_sort[colours[j - 1]] < _colour_sort[colours[j]]) {
517 std::swap(colours[j - 1], colours[j]);
518 }
519 }
520 }
521
522 /* Move the colours that look similar to each company's colour to the side */
523 for (const Company *c : Company::Iterate()) {
524 Colours pcolour = c->colour;
525
526 for (uint i = 0; i < COLOUR_END; i++) {
527 if (colours[i] == pcolour) {
528 colours[i] = INVALID_COLOUR;
529 break;
530 }
531 }
532
533 for (uint j = 0; j < 2; j++) {
534 Colours similar = _similar_colour[pcolour][j];
535 if (similar == INVALID_COLOUR) break;
536
537 for (uint i = 1; i < COLOUR_END; i++) {
538 if (colours[i - 1] == similar) std::swap(colours[i - 1], colours[i]);
539 }
540 }
541 }
542
543 /* Return the first available colour */
544 for (uint i = 0; i < COLOUR_END; i++) {
545 if (colours[i] != INVALID_COLOUR) return colours[i];
546 }
547
548 NOT_REACHED();
549}
550
556{
557 for (;;) {
558restart:;
561
562 /* Reserve space for extra unicode character. We need to do this to be able
563 * to detect too long president name. */
564 std::string name = GetString(STR_PRESIDENT_NAME, c->index);
566
567 for (const Company *cc : Company::Iterate()) {
568 if (c != cc) {
569 std::string other_name = GetString(STR_PRESIDENT_NAME, cc->index);
570 if (name == other_name) goto restart;
571 }
572 }
573 return;
574 }
575}
576
583{
584 for (LiveryScheme scheme = LS_BEGIN; scheme < LS_END; scheme++) {
585 c->livery[scheme].in_use = 0;
586 c->livery[scheme].colour1 = c->colour;
587 c->livery[scheme].colour2 = c->colour;
588 }
589
590 for (Group *g : Group::Iterate()) {
591 if (g->owner == c->index) {
592 g->livery.in_use = 0;
593 g->livery.colour1 = c->colour;
594 g->livery.colour2 = c->colour;
595 }
596 }
597}
598
606Company *DoStartupNewCompany(bool is_ai, CompanyID company = CompanyID::Invalid())
607{
608 if (!Company::CanAllocateItem()) return nullptr;
609
610 /* we have to generate colour before this company is valid */
611 Colours colour = GenerateCompanyColour();
612
613 Company *c;
614 if (company == CompanyID::Invalid()) {
615 c = new Company(STR_SV_UNNAMED, is_ai);
616 } else {
617 if (Company::IsValidID(company)) return nullptr;
618 c = new (company) Company(STR_SV_UNNAMED, is_ai);
619 }
620
621 c->colour = colour;
622
625
626 /* Scale the initial loan based on the inflation rounded down to the loan interval. The maximum loan has already been inflation adjusted. */
627 c->money = c->current_loan = std::min<int64_t>((INITIAL_LOAN * _economy.inflation_prices >> 16) / LOAN_INTERVAL * LOAN_INTERVAL, _economy.max_loan);
628
633
634 /* If starting a player company in singleplayer and a favorite company manager face is selected, choose it. Otherwise, use a random face.
635 * In a network game, we'll choose the favorite face later in CmdCompanyCtrl to sync it to all clients. */
636 if (_company_manager_face != 0 && !is_ai && !_networking) {
638 } else {
640 }
641
644
646
652
653 if (is_ai && (!_networking || _network_server)) AI::StartNew(c->index);
654
655 AI::BroadcastNewEvent(new ScriptEventCompanyNew(c->index), c->index);
656 Game::NewEvent(new ScriptEventCompanyNew(c->index));
657
658 return c;
659}
660
662TimeoutTimer<TimerGameTick> _new_competitor_timeout({ TimerGameTick::Priority::COMPETITOR_TIMEOUT, 0 }, []() {
663 if (_game_mode == GM_MENU || !AI::CanStartNew()) return;
666
667 /* count number of competitors */
668 uint8_t n = 0;
669 for (const Company *c : Company::Iterate()) {
670 if (c->is_ai) n++;
671 }
672
674
675 /* Send a command to all clients to start up a new AI.
676 * Works fine for Multiplayer and Singleplayer */
678});
679
682{
683 /* Ensure the timeout is aborted, so it doesn't fire based on information of the last game. */
685}
686
692
700{
701 const Company *c1 = Company::Get(cbig);
702 const Company *c2 = Company::Get(csmall);
703
704 /* Do the combined vehicle counts stay within the limits? */
705 return c1->group_all[VEH_TRAIN].num_vehicle + c2->group_all[VEH_TRAIN].num_vehicle <= _settings_game.vehicle.max_trains &&
706 c1->group_all[VEH_ROAD].num_vehicle + c2->group_all[VEH_ROAD].num_vehicle <= _settings_game.vehicle.max_roadveh &&
707 c1->group_all[VEH_SHIP].num_vehicle + c2->group_all[VEH_SHIP].num_vehicle <= _settings_game.vehicle.max_ships &&
708 c1->group_all[VEH_AIRCRAFT].num_vehicle + c2->group_all[VEH_AIRCRAFT].num_vehicle <= _settings_game.vehicle.max_aircraft;
709}
710
721{
722 /* Amount of time out for each company to take over a company;
723 * Timeout is a quarter (3 months of 30 days) divided over the
724 * number of companies. The minimum number of days in a quarter
725 * is 90: 31 in January, 28 in February and 31 in March.
726 * Note that the company going bankrupt can't buy itself. */
727 static const int TAKE_OVER_TIMEOUT = 3 * 30 * Ticks::DAY_TICKS / (MAX_COMPANIES - 1);
728
729 assert(c->bankrupt_asked.Any());
730
731 /* We're currently asking some company to buy 'us' */
732 if (c->bankrupt_timeout != 0) {
733 c->bankrupt_timeout -= MAX_COMPANIES;
734 if (c->bankrupt_timeout > 0) return;
735 c->bankrupt_timeout = 0;
736
737 return;
738 }
739
740 /* Did we ask everyone for bankruptcy? If so, bail out. */
741 if (c->bankrupt_asked.All()) return;
742
743 Company *best = nullptr;
744 int32_t best_performance = -1;
745
746 /* Ask the company with the highest performance history first */
747 for (Company *c2 : Company::Iterate()) {
748 if (c2->bankrupt_asked.None() && // Don't ask companies going bankrupt themselves
749 !c->bankrupt_asked.Test(c2->index) &&
750 best_performance < c2->old_economy[1].performance_history &&
751 CheckTakeoverVehicleLimit(c2->index, c->index)) {
752 best_performance = c2->old_economy[1].performance_history;
753 best = c2;
754 }
755 }
756
757 /* Asked all companies? */
758 if (best_performance == -1) {
759 c->bankrupt_asked.Set();
760 return;
761 }
762
763 c->bankrupt_asked.Set(best->index);
764
765 c->bankrupt_timeout = TAKE_OVER_TIMEOUT;
766
767 AI::NewEvent(best->index, new ScriptEventCompanyAskMerger(c->index, c->bankrupt_value));
768 if (IsInteractiveCompany(best->index)) {
769 ShowBuyCompanyDialog(c->index, false);
770 }
771}
772
775{
776 if (_game_mode == GM_EDITOR) return;
777
779 if (c != nullptr) {
780 if (c->name_1 != 0) GenerateCompanyName(c);
782 }
783
784 if (_new_competitor_timeout.HasFired() && _game_mode != GM_MENU && AI::CanStartNew()) {
786 /* If the interval is zero, start as many competitors as needed then check every ~10 minutes if a company went bankrupt and needs replacing. */
787 if (timeout == 0) {
788 /* count number of competitors */
789 uint8_t num_ais = 0;
790 for (const Company *cc : Company::Iterate()) {
791 if (cc->is_ai) num_ais++;
792 }
793
794 size_t num_companies = Company::GetNumItems();
795 for (auto i = 0; i < _settings_game.difficulty.max_no_competitors; i++) {
796 if (_networking && num_companies++ >= _settings_client.network.max_companies) break;
797 if (num_ais++ >= _settings_game.difficulty.max_no_competitors) break;
799 }
800 timeout = 10 * 60 * Ticks::TICKS_PER_SECOND;
801 }
802 /* Randomize a bit when the AI is actually going to start; ranges from 87.5% .. 112.5% of indicated value. */
803 timeout += ScriptObject::GetRandomizer(OWNER_NONE).Next(timeout / 4) - timeout / 8;
804
805 _new_competitor_timeout.Reset({ TimerGameTick::Priority::COMPETITOR_TIMEOUT, static_cast<uint>(std::max(1, timeout)) });
806 }
807
808 _cur_company_tick_index = (_cur_company_tick_index + 1) % MAX_COMPANIES;
809}
810
815static const IntervalTimer<TimerGameEconomy> _economy_companies_yearly({TimerGameEconomy::YEAR, TimerGameEconomy::Priority::COMPANY}, [](auto)
816{
817 /* Copy statistics */
818 for (Company *c : Company::Iterate()) {
819 /* Move expenses to previous years. */
820 std::rotate(std::rbegin(c->yearly_expenses), std::rbegin(c->yearly_expenses) + 1, std::rend(c->yearly_expenses));
821 c->yearly_expenses[0].fill(0);
823 }
824
828 if (c->num_valid_stat_ent > 5 && c->old_economy[0].performance_history < c->old_economy[4].performance_history) {
830 } else {
832 }
833 }
834});
835
842{
843 this->company_name = GetString(STR_COMPANY_NAME, c->index);
844
845 if (other != nullptr) {
846 this->other_company_name = GetString(STR_COMPANY_NAME, other->index);
847 c = other;
848 }
849
850 this->president_name = GetString(STR_PRESIDENT_NAME_MANAGER, c->index);
851
852 this->title = title;
853 this->colour = c->colour;
854 this->face = c->face;
855
856}
857
862void CompanyAdminUpdate(const Company *company)
863{
865}
866
876
886{
888
889 switch (cca) {
890 case CCA_NEW: { // Create a new company
891 /* This command is only executed in a multiplayer game */
892 if (!_networking) return CMD_ERROR;
893
894 /* Has the network client a correct ClientID? */
895 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
896
898
899 /* Delete multiplayer progress bar */
901
902 Company *c = DoStartupNewCompany(false);
903
904 /* A new company could not be created, revert to being a spectator */
905 if (c == nullptr) {
906 /* We check for "ci != nullptr" as a client could have left by
907 * the time we execute this command. */
908 if (_network_server && ci != nullptr) {
911 }
912 break;
913 }
914
917
918 /* This is the client (or non-dedicated server) who wants a new company */
919 if (client_id == _network_own_client_id) {
922
923 /*
924 * If a favorite company manager face is selected, choose it. Otherwise, use a random face.
925 * Because this needs to be synchronised over the network, only the client knows
926 * its configuration and we are currently in the execution of a command, we have
927 * to circumvent the normal ::Post logic for commands and just send the command.
928 */
930
931 /* Now that we have a new company, broadcast our company settings to
932 * all clients so everything is in sync */
934
936 }
937 break;
938 }
939
940 case CCA_NEW_AI: { // Make a new AI company
941 if (company_id != CompanyID::Invalid() && company_id >= MAX_COMPANIES) return CMD_ERROR;
942
943 /* For network games, company deletion is delayed. */
944 if (!_networking && company_id != CompanyID::Invalid() && Company::IsValidID(company_id)) return CMD_ERROR;
945
946 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
947
948 /* For network game, just assume deletion happened. */
949 assert(company_id == CompanyID::Invalid() || !Company::IsValidID(company_id));
950
951 Company *c = DoStartupNewCompany(true, company_id);
952 if (c != nullptr) {
954 NetworkServerNewCompany(c, nullptr);
955 }
956 break;
957 }
958
959 case CCA_DELETE: { // Delete a company
960 if (reason >= CRR_END) return CMD_ERROR;
961
962 /* We can't delete the last existing company in singleplayer mode. */
963 if (!_networking && Company::GetNumItems() == 1) return CMD_ERROR;
964
965 Company *c = Company::GetIfValid(company_id);
966 if (c == nullptr) return CMD_ERROR;
967
968 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
969
970 /* Show the bankrupt news */
971 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_BANKRUPT_TITLE, c);
972 EncodedString headline = GetEncodedString(STR_NEWS_COMPANY_BANKRUPT_DESCRIPTION, cni->company_name);
973 AddCompanyNewsItem(std::move(headline), std::move(cni));
974
975 /* Remove the company */
977 if (c->is_ai) AI::Stop(c->index);
978
979 CompanyID c_index = c->index;
980 delete c;
981 AI::BroadcastNewEvent(new ScriptEventCompanyBankrupt(c_index));
982 Game::NewEvent(new ScriptEventCompanyBankrupt(c_index));
983 CompanyAdminRemove(c_index, (CompanyRemoveReason)reason);
984
987
988 break;
989 }
990
991 default: return CMD_ERROR;
992 }
993
997
998 return CommandCost();
999}
1000
1001static bool ExecuteAllowListCtrlAction(CompanyAllowListCtrlAction action, Company *c, const std::string &public_key)
1002{
1003 switch (action) {
1004 case CALCA_ADD:
1005 return c->allow_list.Add(public_key);
1006
1007 case CALCA_REMOVE:
1008 return c->allow_list.Remove(public_key);
1009
1010 default:
1011 NOT_REACHED();
1012 }
1013}
1014
1023{
1025 if (c == nullptr) return CMD_ERROR;
1026
1027 /* The public key length includes the '\0'. */
1028 if (public_key.size() != NETWORK_PUBLIC_KEY_LENGTH - 1) return CMD_ERROR;
1029
1030 switch (action) {
1031 case CALCA_ADD:
1032 case CALCA_REMOVE:
1033 break;
1034
1035 default:
1036 return CMD_ERROR;
1037 }
1038
1039 if (flags.Test(DoCommandFlag::Execute)) {
1040 if (ExecuteAllowListCtrlAction(action, c, public_key)) {
1043 }
1044 }
1045
1046 return CommandCost();
1047}
1048
1056{
1057 if (!IsValidCompanyManagerFace(cmf)) return CMD_ERROR;
1058
1059 if (flags.Test(DoCommandFlag::Execute)) {
1060 Company::Get(_current_company)->face = cmf;
1062 }
1063 return CommandCost();
1064}
1065
1072{
1073 for (int i = 1; i < LS_END; i++) {
1074 if (!HasBit(c->livery[i].in_use, 0)) c->livery[i].colour1 = c->livery[LS_DEFAULT].colour1;
1075 if (!HasBit(c->livery[i].in_use, 1)) c->livery[i].colour2 = c->livery[LS_DEFAULT].colour2;
1076 }
1078}
1079
1088CommandCost CmdSetCompanyColour(DoCommandFlags flags, LiveryScheme scheme, bool primary, Colours colour)
1089{
1090 if (scheme >= LS_END || (colour >= COLOUR_END && colour != INVALID_COLOUR)) return CMD_ERROR;
1091
1092 /* Default scheme can't be reset to invalid. */
1093 if (scheme == LS_DEFAULT && colour == INVALID_COLOUR) return CMD_ERROR;
1094
1096
1097 /* Ensure no two companies have the same primary colour */
1098 if (scheme == LS_DEFAULT && primary) {
1099 for (const Company *cc : Company::Iterate()) {
1100 if (cc != c && cc->colour == colour) return CMD_ERROR;
1101 }
1102 }
1103
1104 if (flags.Test(DoCommandFlag::Execute)) {
1105 if (primary) {
1106 if (scheme != LS_DEFAULT) AssignBit(c->livery[scheme].in_use, 0, colour != INVALID_COLOUR);
1107 if (colour == INVALID_COLOUR) colour = c->livery[LS_DEFAULT].colour1;
1108 c->livery[scheme].colour1 = colour;
1109
1110 /* If setting the first colour of the default scheme, adjust the
1111 * original and cached company colours too. */
1112 if (scheme == LS_DEFAULT) {
1115 c->colour = colour;
1117 }
1118 } else {
1119 if (scheme != LS_DEFAULT) AssignBit(c->livery[scheme].in_use, 1, colour != INVALID_COLOUR);
1120 if (colour == INVALID_COLOUR) colour = c->livery[LS_DEFAULT].colour2;
1121 c->livery[scheme].colour2 = colour;
1122
1123 if (scheme == LS_DEFAULT) {
1125 }
1126 }
1127
1128 if (c->livery[scheme].in_use != 0) {
1129 /* If enabling a scheme, set the default scheme to be in use too */
1130 c->livery[LS_DEFAULT].in_use = 1;
1131 } else {
1132 /* Else loop through all schemes to see if any are left enabled.
1133 * If not, disable the default scheme too. */
1134 c->livery[LS_DEFAULT].in_use = 0;
1135 for (scheme = LS_DEFAULT; scheme < LS_END; scheme++) {
1136 if (c->livery[scheme].in_use != 0) {
1137 c->livery[LS_DEFAULT].in_use = 1;
1138 break;
1139 }
1140 }
1141 }
1142
1143 ResetVehicleColourMap();
1145
1146 /* All graph related to companies use the company colour. */
1153 /* The smallmap owner view also stores the company colours. */
1156
1157 /* Company colour data is indirectly cached. */
1158 for (Vehicle *v : Vehicle::Iterate()) {
1159 if (v->owner == _current_company) v->InvalidateNewGRFCache();
1160 }
1161
1163 }
1164 return CommandCost();
1165}
1166
1172static bool IsUniqueCompanyName(const std::string &name)
1173{
1174 for (const Company *c : Company::Iterate()) {
1175 if (!c->name.empty() && c->name == name) return false;
1176 }
1177
1178 return true;
1179}
1180
1187CommandCost CmdRenameCompany(DoCommandFlags flags, const std::string &text)
1188{
1189 bool reset = text.empty();
1190
1191 if (!reset) {
1193 if (!IsUniqueCompanyName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
1194 }
1195
1196 if (flags.Test(DoCommandFlag::Execute)) {
1198 if (reset) {
1199 c->name.clear();
1200 } else {
1201 c->name = text;
1202 }
1205
1206 std::string new_name = GetString(STR_COMPANY_NAME, c->index);
1207 AI::BroadcastNewEvent(new ScriptEventCompanyRenamed(c->index, new_name));
1208 Game::NewEvent(new ScriptEventCompanyRenamed(c->index, new_name));
1209 }
1210
1211 return CommandCost();
1212}
1213
1219static bool IsUniquePresidentName(const std::string &name)
1220{
1221 for (const Company *c : Company::Iterate()) {
1222 if (!c->president_name.empty() && c->president_name == name) return false;
1223 }
1224
1225 return true;
1226}
1227
1234CommandCost CmdRenamePresident(DoCommandFlags flags, const std::string &text)
1235{
1236 bool reset = text.empty();
1237
1238 if (!reset) {
1240 if (!IsUniquePresidentName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
1241 }
1242
1243 if (flags.Test(DoCommandFlag::Execute)) {
1245
1246 if (reset) {
1247 c->president_name.clear();
1248 } else {
1249 c->president_name = text;
1250
1251 if (c->name_1 == STR_SV_UNNAMED && c->name.empty()) {
1253 }
1254 }
1255
1259
1260 std::string new_name = GetString(STR_PRESIDENT_NAME, c->index);
1261 AI::BroadcastNewEvent(new ScriptEventPresidentRenamed(c->index, new_name));
1262 Game::NewEvent(new ScriptEventPresidentRenamed(c->index, new_name));
1263 }
1264
1265 return CommandCost();
1266}
1267
1275{
1276 const VehicleDefaultSettings *vds = (c == nullptr) ? &_settings_client.company.vehicle : &c->settings.vehicle;
1277 switch (type) {
1278 default: NOT_REACHED();
1279 case VEH_TRAIN: return vds->servint_trains;
1280 case VEH_ROAD: return vds->servint_roadveh;
1281 case VEH_AIRCRAFT: return vds->servint_aircraft;
1282 case VEH_SHIP: return vds->servint_ships;
1283 }
1284}
1285
1291{
1292 uint32_t total = 0;
1293 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
1294 if (RoadTypeIsRoad(rt)) total += this->road[rt];
1295 }
1296 return total;
1297}
1298
1304{
1305 uint32_t total = 0;
1306 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
1307 if (RoadTypeIsTram(rt)) total += this->road[rt];
1308 }
1309 return total;
1310}
1311
1323{
1325
1327 CommandCost amount(EXPENSES_OTHER, std::min<Money>(money, 20000000LL));
1328
1329 /* You can only transfer funds that is in excess of your loan */
1330 if (c->money - c->current_loan < amount.GetCost() || amount.GetCost() < 0) return CommandCost(STR_ERROR_INSUFFICIENT_FUNDS);
1331 if (!Company::IsValidID(dest_company)) return CMD_ERROR;
1332
1333 if (flags.Test(DoCommandFlag::Execute)) {
1334 /* Add money to company */
1335 Backup<CompanyID> cur_company(_current_company, dest_company);
1337 cur_company.Restore();
1338
1339 if (_networking) {
1340 std::string dest_company_name = GetString(STR_COMPANY_NAME, dest_company);
1341 std::string from_company_name = GetString(STR_COMPANY_NAME, _current_company);
1342
1343 NetworkTextMessage(NETWORK_ACTION_GIVE_MONEY, GetDrawStringCompanyColour(_current_company), false, from_company_name, dest_company_name, amount.GetCost());
1344 }
1345 }
1346
1347 /* Subtract money from local-company */
1348 return amount;
1349}
1350
1361{
1362 for (Company *c : Company::Iterate()) {
1363 if (Company::IsHumanID(c->index)) {
1364 return c->index;
1365 }
1366 }
1367
1369 for (CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
1370 if (!Company::IsValidID(c)) {
1371 return c;
1372 }
1373 }
1374 }
1375
1376 return CompanyID::Begin();
1377}
Base functions for all AIs.
AIConfig stores the configuration settings of every AI.
The AIInstance tracks an AI.
Class for backupping variables and making sure they are restored later.
debug_inline constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T AssignBit(T &x, const uint8_t y, bool value)
Assigns a bit in a variable.
debug_inline static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
static void BroadcastNewEvent(ScriptEvent *event, CompanyID skip_company=CompanyID::Invalid())
Broadcast a new event to all active AIs.
Definition ai_core.cpp:255
static bool CanStartNew()
Is it possible to start a new AI company?
Definition ai_core.cpp:30
static void StartNew(CompanyID company)
Start a new AI company.
Definition ai_core.cpp:36
static void Stop(CompanyID company)
Stop a company to be controlled by an AI.
Definition ai_core.cpp:107
static void NewEvent(CompanyID company, ScriptEvent *event)
Queue a new event for an AI.
Definition ai_core.cpp:235
constexpr bool All(const Timpl &other) const
Test if all of the values are set.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
Common return value for all commands.
ExpensesType GetExpensesType() const
The expense type of the cost.
void MakeError(StringID message)
Makes this CommandCost behave like an error command.
Money GetCost() const
The costs as made up to this moment.
void SetEncodedMessage(EncodedString &&message)
Set the encoded message string.
Container for an encoded string, created by GetEncodedString.
Enum-as-bit-set wrapper.
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
bool Add(std::string_view key)
Add the given key to the authorized keys, when it is not already contained.
Definition network.cpp:190
bool Remove(std::string_view key)
Remove the given key from the authorized keys, when it is exists.
Definition network.cpp:206
A sort-of mixin that adds 'at(pos)' and 'operator[](pos)' implementations for 'ConvertibleThroughBase...
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
static constexpr TimerGameTick::Ticks TICKS_PER_SECOND
Estimation of how many ticks fit in a single second.
A timeout timer will fire once after the interval.
Definition timer.h:116
void Abort()
Abort the timer so it doesn't fire if it hasn't yet.
Definition timer.h:161
static Year year
Current year, starting at 0.
static Year year
Current year, starting at 0.
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Execute
execute the given command
Definition of stuff that is very close to a company, like the company struct itself.
void ClearEnginesHiddenFlagOfCompany(CompanyID cid)
Clear the 'hidden' flag for all engines of a new company.
Definition engine.cpp:1005
void UpdateObjectColours(const Company *c)
Updates the colour of the object whenever a company changes.
TimeoutTimer< TimerGameTick > _new_competitor_timeout({ TimerGameTick::Priority::COMPETITOR_TIMEOUT, 0 }, []() { if(_game_mode==GM_MENU||!AI::CanStartNew()) return;if(_networking &&Company::GetNumItems() >=_settings_client.network.max_companies) return;if(_settings_game.difficulty.competitors_interval==0) return;uint8_t n=0;for(const Company *c :Company::Iterate()) { if(c->is_ai) n++;} if(n >=_settings_game.difficulty.max_no_competitors) return;Command< CMD_COMPANY_CTRL >::Post(CCA_NEW_AI, CompanyID::Invalid(), CRR_NONE, INVALID_CLIENT_ID);})
Start a new competitor company if possible.
static void GenerateCompanyName(Company *c)
Generate the name of a company from the last build coordinate.
static bool IsValidCompanyManagerFace(CompanyManagerFace cmf)
Checks whether a company manager's face is a valid encoding.
void OnTick_Companies()
Called every tick for updating some company info.
static void SubtractMoneyFromAnyCompany(Company *c, const CommandCost &cost)
Deduct costs of a command from the money of a company.
std::array< StringParameter, 2 > GetParamsForOwnedBy(Owner owner, TileIndex tile)
Set the right DParams for STR_ERROR_OWNED_BY.
CommandCost CmdCompanyAllowListCtrl(DoCommandFlags flags, CompanyAllowListCtrlAction action, const std::string &public_key)
Add or remove the given public key to the allow list of this company.
Company * DoStartupNewCompany(bool is_ai, CompanyID company=CompanyID::Invalid())
Create a new company and sets all company variables default values.
void DrawCompanyIcon(CompanyID c, int x, int y)
Draw the icon of a company.
static Colours GenerateCompanyColour()
Generate a company colour.
static void GeneratePresidentName(Company *c)
Generate a random president name of a company.
static const Colours _similar_colour[COLOUR_END][2]
Similar colours, so we can try to prevent same coloured companies.
void ResetCompanyLivery(Company *c)
Reset the livery schemes to the company's primary colour.
void UpdateCompanyLiveries(Company *c)
Update liveries for a company.
CommandCost CheckTileOwnership(TileIndex tile)
Check whether the current owner owns the stuff on the given tile.
CommandCost CmdSetCompanyColour(DoCommandFlags flags, LiveryScheme scheme, bool primary, Colours colour)
Change the company's company-colour.
CommandCost CmdSetCompanyManagerFace(DoCommandFlags flags, CompanyManagerFace cmf)
Change the company manager's face.
CommandCost CmdCompanyCtrl(DoCommandFlags flags, CompanyCtrlAction cca, CompanyID company_id, CompanyRemoveReason reason, ClientID client_id)
Control the companies: add, delete, etc.
void InvalidateCompanyWindows(const Company *company)
Mark all finance windows owned by a company as needing a refresh.
int CompanyServiceInterval(const Company *c, VehicleType type)
Get the service interval for the given company and vehicle type.
PaletteID GetCompanyPalette(CompanyID company)
Get the palette for recolouring with a company colour.
bool CheckCompanyHasMoney(CommandCost &cost)
Verify whether the company can pay the bill.
CompanyID GetFirstPlayableCompanyID()
Get the index of the first available company.
static CompanyMask _dirty_company_finances
Bitmask of compamy finances that should be marked dirty.
TextColour GetDrawStringCompanyColour(CompanyID company)
Get the colour for DrawString-subroutines which matches the colour of the company.
Money GetAvailableMoneyForCommand()
This functions returns the money which can be used to execute a command.
void CompanyAdminUpdate(const Company *company)
Called whenever company related information changes in order to notify admins.
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
void CompanyAdminRemove(CompanyID company_id, CompanyRemoveReason reason)
Called whenever a company is removed in order to notify admins.
ReferenceThroughBaseContainer< std::array< Colours, MAX_COMPANIES > > _company_colours
NOSAVE: can be determined from company structs.
CommandCost CmdRenamePresident(DoCommandFlags flags, const std::string &text)
Change the name of the president.
void SubtractMoneyFromCompany(const CommandCost &cost)
Subtract money from the _current_company, if the company is valid.
CompanyPool _company_pool("Company")
Pool of companies.
static const IntervalTimer< TimerGameEconomy > _economy_companies_yearly({TimerGameEconomy::YEAR, TimerGameEconomy::Priority::COMPANY}, [](auto) { for(Company *c :Company::Iterate()) { std::rotate(std::rbegin(c->yearly_expenses), std::rbegin(c->yearly_expenses)+1, std::rend(c->yearly_expenses));c->yearly_expenses[0].fill(0);InvalidateWindowData(WC_FINANCES, c->index);} if(_settings_client.gui.show_finances &&_local_company !=COMPANY_SPECTATOR) { ShowCompanyFinances(_local_company);Company *c=Company::Get(_local_company);if(c->num_valid_stat_ent > 5 &&c->old_economy[0].performance_history< c->old_economy[4].performance_history) { if(_settings_client.sound.new_year) SndPlayFx(SND_01_BAD_YEAR);} else { if(_settings_client.sound.new_year) SndPlayFx(SND_00_GOOD_YEAR);} } })
A year has passed, update the economic data of all companies, and perhaps show the financial overview...
Money GetAvailableMoney(CompanyID company)
Get the amount of money that a company has available, or INT64_MAX if there is no such valid company.
void UpdateLandscapingLimits()
Update the landscaping limits per company.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
void InitializeCompanies()
Initialize the pool of companies.
uint _cur_company_tick_index
used to generate a name for one company that doesn't have a name yet per tick
void StartupCompanies()
Start of a new game.
bool CheckTakeoverVehicleLimit(CompanyID cbig, CompanyID csmall)
Can company cbig buy company csmall without exceeding vehicle limits?
CompanyManagerFace _company_manager_face
for company manager face storage in openttd.cfg
static bool IsUniqueCompanyName(const std::string &name)
Is the given name in use as name of a company?
void SetLocalCompany(CompanyID new_company)
Sets the local company and updates the settings that are set on a per-company basis to reflect the co...
static bool IsUniquePresidentName(const std::string &name)
Is the given name in use as president name of a company?
CompanyID _current_company
Company currently doing an action.
CommandCost CmdGiveMoney(DoCommandFlags flags, Money money, CompanyID dest_company)
Transfer funds (money) from one company to another.
static void HandleBankruptcyTakeover(Company *c)
Handle the bankruptcy take over of a company.
CommandCost CmdRenameCompany(DoCommandFlags flags, const std::string &text)
Change the name of the company.
void SubtractMoneyFromCompanyFract(CompanyID company, const CommandCost &cst)
Subtract money from a company, including the money fraction.
static const IntervalTimer< TimerWindow > invalidate_company_windows_interval(std::chrono::milliseconds(1), [](auto) { for(CompanyID cid :_dirty_company_finances) { if(cid==_local_company) SetWindowWidgetDirty(WC_STATUS_BAR, 0, WID_S_RIGHT);Window *w=FindWindowById(WC_FINANCES, cid);if(w !=nullptr) { w->SetWidgetDirty(WID_CF_EXPS_PRICE3);w->SetWidgetDirty(WID_CF_OWN_VALUE);w->SetWidgetDirty(WID_CF_LOAN_VALUE);w->SetWidgetDirty(WID_CF_BALANCE_VALUE);w->SetWidgetDirty(WID_CF_MAXLOAN_VALUE);} SetWindowWidgetDirty(WC_COMPANY, cid, WID_C_DESC_COMPANY_VALUE);} _dirty_company_finances.Reset();})
Refresh all company finance windows previously marked dirty.
static const uint8_t _colour_sort[COLOUR_END]
Sorting weights for the company colours.
Command definitions related to companies.
Functions related to companies.
bool IsInteractiveCompany(CompanyID company)
Is the user representing company?
void ChangeOwnershipOfCompanyItems(Owner old_owner, Owner new_owner)
Change the ownership of all the items of a company.
Definition economy.cpp:322
void ShowBuyCompanyDialog(CompanyID company, bool hostile_takeover)
Show the query to buy another company.
bool IsLocalCompany()
Is the current company the local company?
void ShowCompanyFinances(CompanyID company)
Open the finances window of a company.
GUI Functions related to companies.
void CloseCompanyWindows(CompanyID company)
Close all windows of a company.
Definition window.cpp:1210
Functionality related to the company manager's face.
uint GetCompanyManagerFaceBits(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge)
Make sure the table's size is right.
GenderEthnicity
The gender/race combinations that we have faces for.
@ GE_WM
A male of Caucasian origin (white)
@ GENDER_FEMALE
This bit set means a female, otherwise male.
void RandomCompanyManagerFaceBits(CompanyManagerFace &cmf, GenderEthnicity ge, bool adv, Randomizer &randomizer)
Make a random new face.
CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
bool AreCompanyManagerFaceBitsValid(CompanyManagerFace cmf, CompanyManagerFaceVariable cmfv, GenderEthnicity ge)
Checks whether the company manager's face bits have a valid range.
static const uint MAX_LENGTH_PRESIDENT_NAME_CHARS
The maximum length of a president name in characters including '\0'.
static const uint MAX_LENGTH_COMPANY_NAME_CHARS
The maximum length of a company name in characters including '\0'.
CompanyCtrlAction
The action to do with CMD_COMPANY_CTRL.
@ CCA_NEW_AI
Create a new AI company.
@ CCA_DELETE
Delete a company.
@ CCA_NEW
Create a new company.
static constexpr CompanyID COMPANY_SPECTATOR
The client is spectating.
static constexpr Owner OWNER_END
Last + 1 owner.
CompanyAllowListCtrlAction
The action to do with CMD_COMPANY_ALLOW_LIST_CTRL.
@ CALCA_REMOVE
Remove a public key.
@ CALCA_ADD
Create a public key.
static constexpr Owner OWNER_TOWN
A town owns the tile, or a town is expanding.
uint32_t CompanyManagerFace
Company manager face bits, info see in company_manager_face.h.
static constexpr Owner OWNER_NONE
The tile has no ownership.
static constexpr Owner INVALID_OWNER
An invalid owner.
CompanyRemoveReason
The reason why the company was removed.
@ CRR_END
Sentinel for end.
@ CRR_NONE
Dummy reason for actions that don't need one.
@ WID_CF_OWN_VALUE
Own funds, not including loan.
@ WID_CF_LOAN_VALUE
Loan.
@ WID_CF_BALANCE_VALUE
Bank balance value.
@ WID_CF_EXPS_PRICE3
Column for year Y expenses.
@ WID_CF_MAXLOAN_VALUE
Max loan widget.
@ WID_C_DESC_COMPANY_VALUE
Company value.
static const uint NETWORK_PUBLIC_KEY_LENGTH
The maximum length of the hexadecimal encoded public keys, in bytes including '\0'.
Definition config.h:101
@ EXPENSES_ROADVEH_RUN
Running costs road vehicles.
@ EXPENSES_TRAIN_RUN
Running costs trains.
@ EXPENSES_AIRCRAFT_REVENUE
Revenue from aircraft.
@ EXPENSES_AIRCRAFT_RUN
Running costs aircraft.
@ EXPENSES_ROADVEH_REVENUE
Revenue from road vehicles.
@ EXPENSES_PROPERTY
Property costs.
@ EXPENSES_OTHER
Other expenses.
@ EXPENSES_SHIP_REVENUE
Revenue from ships.
@ EXPENSES_LOAN_INTEREST
Interest payments over the loan.
@ EXPENSES_TRAIN_REVENUE
Revenue from trains.
@ EXPENSES_SHIP_RUN
Running costs ships.
@ INVALID_EXPENSES
Invalid expense type.
static const int LOAN_INTERVAL
The "steps" in loan size, in British Pounds!
static const int64_t INITIAL_LOAN
The size of loan for a new company, in British Pounds!
Base functions for all Games.
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition gfx.cpp:1024
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:302
@ TC_IS_PALETTE_COLOUR
Colour value is already a real palette colour index, not an index of a StringColour.
Definition gfx_type.h:325
Goal base class.
void UpdateCompanyGroupLiveries(const Company *c)
Update group liveries for a company.
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1535
@ Random
Randomise borders.
LiveryScheme
List of different livery schemes.
Definition livery.h:21
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
bool _networking
are we in networking mode?
Definition network.cpp:67
bool _network_server
network-server is active
Definition network.cpp:68
ClientID _network_own_client_id
Our client identifier.
Definition network.cpp:72
Basic functions/variables used all over the place.
void NetworkAdminCompanyUpdate(const Company *company)
Notify the admin network of company updates.
void NetworkAdminCompanyNew(const Company *company)
Notify the admin network of a new company.
void NetworkAdminCompanyRemove(CompanyID company_id, AdminCompanyRemoveReason bcrr)
Notify the admin network of a company to be removed (including the reason why).
Server part of the admin network protocol.
Base core network types and some helper functions to access them.
Network functions used by other parts of OpenTTD.
void NetworkServerNewCompany(const Company *company, NetworkClientInfo *ci)
Perform all the server specific administration of a new company.
void NetworkUpdateClientInfo(ClientID client_id)
Send updated client info of a particular client.
@ DESTTYPE_TEAM
Send message/notice to everyone playing the same company (Team)
ClientID
'Unique' identifier to be given to clients
@ INVALID_CLIENT_ID
Client is not part of anything.
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:902
@ CompanyInfo
Company info (new companies, bankruptcy messages)
@ Company
Company news item. (Newspaper with face)
uint8_t GetColourGradient(Colours colour, ColourShade shade)
Get colour gradient palette index.
Definition palette.cpp:388
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.
RailTypes GetCompanyRailTypes(CompanyID company, bool introduces)
Get the rail types the given company can build.
Definition rail.cpp:253
Rail specific functions.
Randomizer _random
Random used in the game state calculations.
RoadTypes GetCompanyRoadTypes(CompanyID company, bool introduces)
Get the road types the given company can build.
Definition road.cpp:198
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.
void SyncCompanySettings()
Sync all company settings in a multiplayer game.
void SetDefaultCompanySettings(CompanyID cid)
Set the company settings for a new company to their default values.
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
Functions related to setting/changing the settings.
void BuildOwnerLegend()
Completes the array for the owned property legend.
Smallmap GUI functions.
Functions related to sound.
@ SND_01_BAD_YEAR
40 == 0x28 New year: performance declined
Definition sound_type.h:87
@ SND_00_GOOD_YEAR
39 == 0x27 New year: performance improved
Definition sound_type.h:86
static PaletteID GetColourPalette(Colours colour)
Get recolour palette for a colour.
Definition sprite.h:184
Types related to the statusbar widgets.
@ WID_S_RIGHT
Right part; bank balance.
Definition of base types and functions in a cross-platform compatible way.
StoryPage base class.
size_t Utf8StringLength(std::string_view str)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition string.cpp:347
EncodedString GetEncodedStringWithArgs(StringID str, std::span< const StringParameter > params)
Encode a string with its parameters into an encoded string.
Definition strings.cpp:103
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:91
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:415
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
static constexpr StringID SPECSTR_COMPANY_NAME_START
Special strings for company names on the form "TownName transport".
static constexpr StringID SPECSTR_ANDCO_NAME
Special string for Surname & Co company names.
static constexpr StringID SPECSTR_PRESIDENT_NAME
Special string for the president's name.
static constexpr StringID SPECSTR_TOWNNAME_START
Special strings for town names.
Class to backup a specific variable and restore it later.
void Restore()
Restore the variable.
CompanySettings company
default values for per-company settings
NetworkSettings network
settings related to the network
SoundSettings sound
sound effect settings
GUISettings gui
settings related to the GUI
Money income
The amount of income.
Money expenses
The amount of expenses.
std::array< uint32_t, ROADTYPE_END > road
Count of company owned track bits for each road type.
uint32_t GetRoadTotal() const
Get total sum of all owned road bits.
uint32_t GetTramTotal() const
Get total sum of all owned tram bits.
uint32_t face
The face of the president.
Definition news_type.h:167
Colours colour
The colour related to the company.
Definition news_type.h:168
CompanyNewsInformation(StringID title, const struct Company *c, const struct Company *other=nullptr)
Fill the CompanyNewsInformation struct with the required data.
std::string president_name
The name of the president.
Definition news_type.h:163
std::string company_name
The name of the company.
Definition news_type.h:162
std::string other_company_name
The name of the company taking over this one.
Definition news_type.h:164
CompanyMask bankrupt_asked
which companies were asked about buying it?
std::string president_name
Name of the president if the user changed 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
NetworkAuthorizedKeys allow_list
Public keys of clients that are allowed to join this company.
uint32_t name_2
Parameter of name_1.
uint8_t money_fraction
Fraction of money of the company, too small to represent in money.
bool is_ai
If true, the company is (also) controlled by the computer (a NoAI program).
uint32_t president_name_2
Parameter of president_name_1.
StringID name_1
Name of the company if the user did not change it.
Money current_loan
Amount of money borrowed from the bank.
TimerGameCalendar::Year inaugurated_year_calendar
Calendar year of starting the company. Used to display proper Inauguration year while in wallclock mo...
TimerGameEconomy::Year inaugurated_year
Economy year of starting the company.
CompanyEconomyEntry cur_economy
Economic data of the company of this quarter.
Colours colour
Company colour.
std::array< CompanyEconomyEntry, MAX_HISTORY_QUARTERS > old_economy
Economic data of the company of the last MAX_HISTORY_QUARTERS quarters.
CompanyManagerFace face
Face description of the president.
Money max_loan
Max allowed amount of the loan or COMPANY_MAX_LOAN_DEFAULT.
std::array< Expenses, 3 > yearly_expenses
Expenses of the company for the last three years.
TileIndex last_build_coordinate
Coordinate of the last build thing by this company.
StringID president_name_1
Name of the president if the user did not change it.
std::string name
Name of the company if the user changed it.
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.
static bool IsHumanID(auto index)
Is this company a company not controlled by a NoAI program?
std::array< GroupStatistics, VEH_COMPANY_END > group_all
NOSAVE: Statistics for the ALL_GROUP group.
RoadTypes avail_roadtypes
Road types available to this company.
~Company()
Destructor.
RailTypes avail_railtypes
Rail types available to this company.
static void PostDestructor(size_t index)
Invalidating some stuff after removing item from the pool.
uint32_t clear_per_64k_frames
how many tiles may, over a long period, be cleared per 65536 frames?
uint32_t tree_per_64k_frames
how many trees may, over a long period, be planted per 65536 frames?
uint16_t terraform_frame_burst
how many tile heights may, over a short period, be terraformed?
uint16_t tree_frame_burst
how many trees may, over a short period, be planted?
uint16_t build_object_frame_burst
how many tiles may, over a short period, be purchased or have objects built on them?
uint32_t build_object_per_64k_frames
how many tiles may, over a long period, be purchased or have objects built on them per 65536 frames?
uint32_t terraform_per_64k_frames
how many tile heights may, over a long period, be terraformed per 65536 frames?
uint16_t clear_frame_burst
how many tiles may, over a short period, be cleared?
uint8_t max_no_competitors
the number of competitors (AIs)
bool infinite_money
whether spending money despite negative balance is allowed
uint16_t competitors_interval
the interval (in minutes) between adding competitors
bool give_money
allow giving other companies money
uint64_t inflation_prices
Cumulated inflation of prices since game start; 16 bit fractional part.
Money max_loan
NOSAVE: Maximum possible loan.
bool show_finances
show finances at end of year
EconomySettings economy
settings to change the economy
ConstructionSettings construction
construction of things in-game
DifficultySettings difficulty
settings related to the difficulty
VehicleSettings vehicle
options for vehicles
Group data.
Definition group.h:73
Container for all information known about a client.
static NetworkClientInfo * GetByClientID(ClientID client_id)
Return the CI given it's client-identifier.
Definition network.cpp:118
CompanyID client_playas
As which company is this client playing (CompanyID)
ClientID client_id
Client identifier (same as ClientState->client_id)
uint8_t max_companies
maximum amount of companies
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
static Titem * Get(auto index)
Returns Titem with given index.
static size_t GetNumItems()
Returns number of valid items in the pool.
Tindex index
Index of this pool item.
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
static bool CleaningPool()
Returns current state of pool cleaning - yes or no.
static Titem * GetIfValid(auto index)
Returns Titem with given index.
Base class for all pools.
bool new_year
Play sound on new year, summarising the performance during the last year.
Town data structure.
Definition town.h:52
std::string name
Custom town name. If empty, the town was not renamed and uses the generated name.
Definition town.h:61
Default settings for vehicles.
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
uint16_t servint_trains
service interval for trains
UnitID max_ships
max ships in game per company
UnitID max_trains
max trains in game per company
UnitID max_aircraft
max planes in game per company
UnitID max_roadveh
max trucks in game per company
Vehicle data structure.
Data structure for an opened window.
Definition window_gui.h:273
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:555
AdminCompanyRemoveReason
Reasons for removing a company - communicated to admins.
Definition tcp_admin.h:108
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
Definition of Interval and OneShot timers.
Definition of the game-economy-timer.
Definition of the tick-based game-timer.
Definition of the Window system.
Base of the town class.
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold.
Base class for all vehicles.
Functions related to vehicles.
VehicleType
Available vehicle types.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
void CloseConstructionWindows()
Close all windows that are used for construction of vehicle etc.
Definition window.cpp:3351
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1182
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:3265
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1140
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, WidgetID widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
Definition window.cpp:3160
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3147
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:3282
Window functions not directly related to making/drawing windows.
@ WN_NETWORK_STATUS_WINDOW_JOIN
Network join status.
Definition window_type.h:41
@ WC_PERFORMANCE_HISTORY
Performance history graph; Window numbers:
@ WC_COMPANY_LEAGUE
Company league window; Window numbers:
@ WC_SIGN_LIST
Sign list; Window numbers:
@ WC_PERFORMANCE_DETAIL
Performance detail window; Window numbers:
@ WC_GRAPH_LEGEND
Legend for graphs; Window numbers:
@ WC_LINKGRAPH_LEGEND
Linkgraph legend; Window numbers:
@ WC_STATUS_BAR
Statusbar (at the bottom of your screen); Window numbers:
Definition window_type.h:66
@ WC_SEND_NETWORK_MSG
Chatbox; Window numbers:
@ WC_ERRMSG
Error message; Window numbers:
@ WC_SCRIPT_SETTINGS
Script settings; Window numbers:
@ WC_SCRIPT_LIST
Scripts list; Window numbers:
@ WC_GOALS_LIST
Goals list; Window numbers:
@ WC_OPERATING_PROFIT
Operating profit graph; Window numbers:
@ WC_CLIENT_LIST
Client list; Window numbers:
@ WC_GAME_OPTIONS
Game options window; Window numbers:
@ WC_FINANCES
Finances of a company; Window numbers:
@ WC_INCOME_GRAPH
Income graph; Window numbers:
@ WC_SMALLMAP
Small map; Window numbers:
@ WC_DELIVERED_CARGO
Delivered cargo graph; Window numbers:
@ WC_COMPANY_VALUE
Company value graph; Window numbers:
@ WC_MAIN_TOOLBAR
Main toolbar (the long bar at the top); Window numbers:
Definition window_type.h:60
@ WC_COMPANY
Company view; Window numbers:
@ WC_NETWORK_STATUS_WINDOW
Network status window; Window numbers: