OpenTTD Source 20250818-master-g1850ad1aa2
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"
32#include "settings_func.h"
33#include "vehicle_base.h"
34#include "vehicle_func.h"
35#include "smallmap_gui.h"
36#include "game/game.hpp"
37#include "goal_base.h"
38#include "story_base.h"
39#include "company_cmd.h"
40#include "timer/timer.h"
43#include "timer/timer_window.h"
44
46
47#include "table/strings.h"
48#include "table/company_face.h"
49
50#include "safeguards.h"
51
53void UpdateObjectColours(const Company *c);
54
60
63
64
69Company::Company(StringID name_1, bool is_ai)
70{
71 this->name_1 = name_1;
72 this->is_ai = is_ai;
73 this->terraform_limit = (uint32_t)_settings_game.construction.terraform_frame_burst << 16;
74 this->clear_limit = (uint32_t)_settings_game.construction.clear_frame_burst << 16;
75 this->tree_limit = (uint32_t)_settings_game.construction.tree_frame_burst << 16;
76 this->build_object_limit = (uint32_t)_settings_game.construction.build_object_frame_burst << 16;
77
78 InvalidateWindowData(WC_PERFORMANCE_DETAIL, 0, CompanyID::Invalid());
79}
80
83{
84 if (CleaningPool()) return;
85
87}
88
93void Company::PostDestructor(size_t index)
94{
99 /* If the currently shown error message has this company in it, then close it. */
101}
102
108{
109 if (this->max_loan == COMPANY_MAX_LOAN_DEFAULT) return _economy.max_loan;
110 return this->max_loan;
111}
112
119void SetLocalCompany(CompanyID new_company)
120{
121 /* company could also be COMPANY_SPECTATOR or OWNER_NONE */
122 assert(Company::IsValidID(new_company) || new_company == COMPANY_SPECTATOR || new_company == OWNER_NONE);
123
124 /* If actually changing to another company, several windows need closing */
125 bool switching_company = _local_company != new_company;
126
127 /* Delete the chat window, if you were team chatting. */
129
130 assert(IsLocalCompany());
131
132 _current_company = _local_company = new_company;
133
134 if (switching_company) {
136 /* Delete any construction windows... */
138 }
139
140 /* ... and redraw the whole screen. */
145 ResetVehicleColourMap();
146}
147
154{
155 if (!Company::IsValidID(company)) return GetColourGradient(COLOUR_WHITE, SHADE_NORMAL).ToTextColour();
156 return GetColourGradient(_company_colours[company], SHADE_NORMAL).ToTextColour();
157}
158
168
175void DrawCompanyIcon(CompanyID c, int x, int y)
176{
177 DrawSprite(SPR_COMPANY_ICON, GetCompanyPalette(c), x, y);
178}
179
187{
188 if (cmf.style >= GetNumCompanyManagerFaceStyles()) return false;
189
190 /* Test if each enabled part is valid. */
191 FaceVars vars = GetCompanyManagerFaceVars(cmf.style);
192 for (uint var : SetBitIterator(GetActiveFaceVars(cmf, vars))) {
193 if (!vars[var].IsValid(cmf)) return false;
194 }
195
196 return true;
197}
198
200
207{
208 CompanyID cid = company->index;
210}
211
215static const IntervalTimer<TimerWindow> invalidate_company_windows_interval(std::chrono::milliseconds(1), [](auto) {
219 if (w != nullptr) {
225 }
227 }
229});
230
239{
240 if (_settings_game.difficulty.infinite_money) return INT64_MAX;
241 if (!Company::IsValidID(company)) return INT64_MAX;
242 return Company::Get(company)->money;
243}
244
256
264{
265 if (cost.GetCost() <= 0) return true;
267
269 if (c != nullptr && cost.GetCost() > c->money) {
270 cost.MakeError(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY);
271 if (IsLocalCompany()) {
272 cost.SetEncodedMessage(GetEncodedString(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY, cost.GetCost()));
273 }
274 return false;
275 }
276 return true;
277}
278
285{
286 if (cost.GetCost() == 0) return;
287 assert(cost.GetExpensesType() != INVALID_EXPENSES);
288
289 c->money -= cost.GetCost();
290 c->yearly_expenses[0][cost.GetExpensesType()] += cost.GetCost();
291
296 c->cur_economy.income -= cost.GetCost();
297 } else if (HasBit(1 << EXPENSES_TRAIN_RUN |
300 1 << EXPENSES_SHIP_RUN |
301 1 << EXPENSES_PROPERTY |
303 c->cur_economy.expenses -= cost.GetCost();
304 }
305
307}
308
314{
316 if (c != nullptr) SubtractMoneyFromAnyCompany(c, cost);
317}
318
325{
326 Company *c = Company::Get(company);
327 uint8_t m = c->money_fraction;
328 Money cost = cst.GetCost();
329
330 c->money_fraction = m - (uint8_t)cost;
331 cost >>= 8;
332 if (c->money_fraction > m) cost++;
333 if (cost != 0) SubtractMoneyFromAnyCompany(c, CommandCost(cst.GetExpensesType(), cost));
334}
335
336static constexpr void UpdateLandscapingLimit(uint32_t &limit, uint64_t per_64k_frames, uint64_t burst)
337{
338 limit = static_cast<uint32_t>(std::min<uint64_t>(limit + per_64k_frames, burst << 16));
339}
340
351
358std::array<StringParameter, 2> GetParamsForOwnedBy(Owner owner, TileIndex tile)
359{
360 if (owner == OWNER_TOWN) {
361 assert(tile != 0);
362 const Town *t = ClosestTownFromTile(tile, UINT_MAX);
363 return {STR_TOWN_NAME, t->index};
364 }
365
366 if (!Company::IsValidID(owner)) {
367 return {STR_COMPANY_SOMEONE, std::monostate{}};
368 }
369
370 return {STR_COMPANY_NAME, owner};
371}
372
382{
383 assert(owner < OWNER_END);
384 assert(owner != OWNER_TOWN || tile != 0);
385
386 if (owner == _current_company) return CommandCost();
387
388 CommandCost error{STR_ERROR_OWNED_BY};
389 if (IsLocalCompany()) {
390 auto params = GetParamsForOwnedBy(owner, tile);
391 error.SetEncodedMessage(GetEncodedStringWithArgs(STR_ERROR_OWNED_BY, params));
392 if (owner != OWNER_TOWN) error.SetErrorOwner(owner);
393 }
394 return error;
395}
396
405{
406 return CheckOwnership(GetTileOwner(tile), tile);
407}
408
414{
415 if (c->name_1 != STR_SV_UNNAMED) return;
416 if (c->last_build_coordinate == 0) return;
417
419
420 StringID str;
421 uint32_t strp;
422 std::string name;
423 if (t->name.empty() && IsInsideMM(t->townnametype, SPECSTR_TOWNNAME_START, SPECSTR_TOWNNAME_END)) {
424 str = t->townnametype - SPECSTR_TOWNNAME_START + SPECSTR_COMPANY_NAME_START;
425 strp = t->townnameparts;
426
427verify_name:;
428 /* No companies must have this name already */
429 for (const Company *cc : Company::Iterate()) {
430 if (cc->name_1 == str && cc->name_2 == strp) goto bad_town_name;
431 }
432
433 name = GetString(str, strp);
434 if (Utf8StringLength(name) >= MAX_LENGTH_COMPANY_NAME_CHARS) goto bad_town_name;
435
436set_name:;
437 c->name_1 = str;
438 c->name_2 = strp;
439
441 AI::BroadcastNewEvent(new ScriptEventCompanyRenamed(c->index, name));
442 Game::NewEvent(new ScriptEventCompanyRenamed(c->index, name));
443
444 if (c->is_ai) {
445 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_LAUNCH_TITLE, c);
446 EncodedString headline = GetEncodedString(STR_NEWS_COMPANY_LAUNCH_DESCRIPTION, cni->company_name, t->index);
447 AddNewsItem(std::move(headline),
449 }
450 return;
451 }
452bad_town_name:;
453
455 str = SPECSTR_ANDCO_NAME;
456 strp = c->president_name_2;
457 name = GetString(str, strp);
458 goto set_name;
459 } else {
460 str = SPECSTR_ANDCO_NAME;
461 strp = Random();
462 goto verify_name;
463 }
464}
465
467static const uint8_t _colour_sort[COLOUR_END] = {2, 2, 3, 2, 3, 2, 3, 2, 3, 2, 2, 2, 3, 1, 1, 1};
469static const Colours _similar_colour[COLOUR_END][2] = {
470 { COLOUR_BLUE, COLOUR_LIGHT_BLUE }, // COLOUR_DARK_BLUE
471 { COLOUR_GREEN, COLOUR_DARK_GREEN }, // COLOUR_PALE_GREEN
472 { INVALID_COLOUR, INVALID_COLOUR }, // COLOUR_PINK
473 { COLOUR_ORANGE, INVALID_COLOUR }, // COLOUR_YELLOW
474 { INVALID_COLOUR, INVALID_COLOUR }, // COLOUR_RED
475 { COLOUR_DARK_BLUE, COLOUR_BLUE }, // COLOUR_LIGHT_BLUE
476 { COLOUR_PALE_GREEN, COLOUR_DARK_GREEN }, // COLOUR_GREEN
477 { COLOUR_PALE_GREEN, COLOUR_GREEN }, // COLOUR_DARK_GREEN
478 { COLOUR_DARK_BLUE, COLOUR_LIGHT_BLUE }, // COLOUR_BLUE
479 { COLOUR_BROWN, COLOUR_ORANGE }, // COLOUR_CREAM
480 { COLOUR_PURPLE, INVALID_COLOUR }, // COLOUR_MAUVE
481 { COLOUR_MAUVE, INVALID_COLOUR }, // COLOUR_PURPLE
482 { COLOUR_YELLOW, COLOUR_CREAM }, // COLOUR_ORANGE
483 { COLOUR_CREAM, INVALID_COLOUR }, // COLOUR_BROWN
484 { COLOUR_WHITE, INVALID_COLOUR }, // COLOUR_GREY
485 { COLOUR_GREY, INVALID_COLOUR }, // COLOUR_WHITE
486};
487
492static Colours GenerateCompanyColour()
493{
494 Colours colours[COLOUR_END];
495
496 /* Initialize array */
497 for (uint i = 0; i < COLOUR_END; i++) colours[i] = static_cast<Colours>(i);
498
499 /* And randomize it */
500 for (uint i = 0; i < 100; i++) {
501 uint r = Random();
502 std::swap(colours[GB(r, 0, 4)], colours[GB(r, 4, 4)]);
503 }
504
505 /* Bubble sort it according to the values in table 1 */
506 for (uint i = 0; i < COLOUR_END; i++) {
507 for (uint j = 1; j < COLOUR_END; j++) {
508 if (_colour_sort[colours[j - 1]] < _colour_sort[colours[j]]) {
509 std::swap(colours[j - 1], colours[j]);
510 }
511 }
512 }
513
514 /* Move the colours that look similar to each company's colour to the side */
515 for (const Company *c : Company::Iterate()) {
516 Colours pcolour = c->colour;
517
518 for (uint i = 0; i < COLOUR_END; i++) {
519 if (colours[i] == pcolour) {
520 colours[i] = INVALID_COLOUR;
521 break;
522 }
523 }
524
525 for (uint j = 0; j < 2; j++) {
526 Colours similar = _similar_colour[pcolour][j];
527 if (similar == INVALID_COLOUR) break;
528
529 for (uint i = 1; i < COLOUR_END; i++) {
530 if (colours[i - 1] == similar) std::swap(colours[i - 1], colours[i]);
531 }
532 }
533 }
534
535 /* Return the first available colour */
536 for (uint i = 0; i < COLOUR_END; i++) {
537 if (colours[i] != INVALID_COLOUR) return colours[i];
538 }
539
540 NOT_REACHED();
541}
542
548{
549 for (;;) {
550restart:;
553
554 /* Reserve space for extra unicode character. We need to do this to be able
555 * to detect too long president name. */
556 std::string name = GetString(STR_PRESIDENT_NAME, c->index);
558
559 for (const Company *cc : Company::Iterate()) {
560 if (c != cc) {
561 std::string other_name = GetString(STR_PRESIDENT_NAME, cc->index);
562 if (name == other_name) goto restart;
563 }
564 }
565 return;
566 }
567}
568
575{
576 for (LiveryScheme scheme = LS_BEGIN; scheme < LS_END; scheme++) {
577 c->livery[scheme].in_use = 0;
578 c->livery[scheme].colour1 = c->colour;
579 c->livery[scheme].colour2 = c->colour;
580 }
581
582 for (Group *g : Group::Iterate()) {
583 if (g->owner == c->index) {
584 g->livery.in_use = 0;
585 g->livery.colour1 = c->colour;
586 g->livery.colour2 = c->colour;
587 }
588 }
589}
590
598Company *DoStartupNewCompany(bool is_ai, CompanyID company = CompanyID::Invalid())
599{
600 if (!Company::CanAllocateItem()) return nullptr;
601
602 /* we have to generate colour before this company is valid */
603 Colours colour = GenerateCompanyColour();
604
605 Company *c;
606 if (company == CompanyID::Invalid()) {
607 c = new Company(STR_SV_UNNAMED, is_ai);
608 } else {
609 if (Company::IsValidID(company)) return nullptr;
610 c = new (company) Company(STR_SV_UNNAMED, is_ai);
611 }
612
613 c->colour = colour;
614
617
618 /* Scale the initial loan based on the inflation rounded down to the loan interval. The maximum loan has already been inflation adjusted. */
619 c->money = c->current_loan = std::min<int64_t>((INITIAL_LOAN * _economy.inflation_prices >> 16) / LOAN_INTERVAL * LOAN_INTERVAL, _economy.max_loan);
620
625
626 /* If starting a player company in singleplayer and a favorite company manager face is selected, choose it. Otherwise, use a random face.
627 * In a network game, we'll choose the favorite face later in CmdCompanyCtrl to sync it to all clients. */
628 bool randomise_face = true;
629 if (!_company_manager_face.empty() && !is_ai && !_networking) {
631 if (cmf.has_value()) {
632 randomise_face = false;
633 c->face = std::move(*cmf);
634 }
635 }
636 if (randomise_face) RandomiseCompanyManagerFace(c->face, _random);
637
640
642
648
649 if (is_ai && (!_networking || _network_server)) AI::StartNew(c->index);
650
651 AI::BroadcastNewEvent(new ScriptEventCompanyNew(c->index), c->index);
652 Game::NewEvent(new ScriptEventCompanyNew(c->index));
653
654 return c;
655}
656
658TimeoutTimer<TimerGameTick> _new_competitor_timeout({ TimerGameTick::Priority::COMPETITOR_TIMEOUT, 0 }, []() {
659 if (_game_mode == GM_MENU || !AI::CanStartNew()) return;
662
663 /* count number of competitors */
664 uint8_t n = 0;
665 for (const Company *c : Company::Iterate()) {
666 if (c->is_ai) n++;
667 }
668
670
671 /* Send a command to all clients to start up a new AI.
672 * Works fine for Multiplayer and Singleplayer */
674});
675
678{
679 /* Ensure the timeout is aborted, so it doesn't fire based on information of the last game. */
681}
682
688
696{
697 const Company *c1 = Company::Get(cbig);
698 const Company *c2 = Company::Get(csmall);
699
700 /* Do the combined vehicle counts stay within the limits? */
701 return c1->group_all[VEH_TRAIN].num_vehicle + c2->group_all[VEH_TRAIN].num_vehicle <= _settings_game.vehicle.max_trains &&
702 c1->group_all[VEH_ROAD].num_vehicle + c2->group_all[VEH_ROAD].num_vehicle <= _settings_game.vehicle.max_roadveh &&
703 c1->group_all[VEH_SHIP].num_vehicle + c2->group_all[VEH_SHIP].num_vehicle <= _settings_game.vehicle.max_ships &&
704 c1->group_all[VEH_AIRCRAFT].num_vehicle + c2->group_all[VEH_AIRCRAFT].num_vehicle <= _settings_game.vehicle.max_aircraft;
705}
706
717{
718 /* Amount of time out for each company to take over a company;
719 * Timeout is a quarter (3 months of 30 days) divided over the
720 * number of companies. The minimum number of days in a quarter
721 * is 90: 31 in January, 28 in February and 31 in March.
722 * Note that the company going bankrupt can't buy itself. */
723 static const int TAKE_OVER_TIMEOUT = 3 * 30 * Ticks::DAY_TICKS / (MAX_COMPANIES - 1);
724
725 assert(c->bankrupt_asked.Any());
726
727 /* We're currently asking some company to buy 'us' */
728 if (c->bankrupt_timeout != 0) {
729 c->bankrupt_timeout -= MAX_COMPANIES;
730 if (c->bankrupt_timeout > 0) return;
731 c->bankrupt_timeout = 0;
732
733 return;
734 }
735
736 /* Did we ask everyone for bankruptcy? If so, bail out. */
737 if (c->bankrupt_asked.All()) return;
738
739 Company *best = nullptr;
740 int32_t best_performance = -1;
741
742 /* Ask the company with the highest performance history first */
743 for (Company *c2 : Company::Iterate()) {
744 if (c2->bankrupt_asked.None() && // Don't ask companies going bankrupt themselves
745 !c->bankrupt_asked.Test(c2->index) &&
746 best_performance < c2->old_economy[1].performance_history &&
747 CheckTakeoverVehicleLimit(c2->index, c->index)) {
748 best_performance = c2->old_economy[1].performance_history;
749 best = c2;
750 }
751 }
752
753 /* Asked all companies? */
754 if (best_performance == -1) {
755 c->bankrupt_asked.Set();
756 return;
757 }
758
759 c->bankrupt_asked.Set(best->index);
760
761 c->bankrupt_timeout = TAKE_OVER_TIMEOUT;
762
763 AI::NewEvent(best->index, new ScriptEventCompanyAskMerger(c->index, c->bankrupt_value));
764 if (IsInteractiveCompany(best->index)) {
765 ShowBuyCompanyDialog(c->index, false);
766 }
767}
768
771{
772 if (_game_mode == GM_EDITOR) return;
773
775 if (c != nullptr) {
776 if (c->name_1 != 0) GenerateCompanyName(c);
778 }
779
780 if (_new_competitor_timeout.HasFired() && _game_mode != GM_MENU && AI::CanStartNew()) {
782 /* If the interval is zero, start as many competitors as needed then check every ~10 minutes if a company went bankrupt and needs replacing. */
783 if (timeout == 0) {
784 /* count number of competitors */
785 uint8_t num_ais = 0;
786 for (const Company *cc : Company::Iterate()) {
787 if (cc->is_ai) num_ais++;
788 }
789
790 size_t num_companies = Company::GetNumItems();
791 for (auto i = 0; i < _settings_game.difficulty.max_no_competitors; i++) {
792 if (_networking && num_companies++ >= _settings_client.network.max_companies) break;
793 if (num_ais++ >= _settings_game.difficulty.max_no_competitors) break;
795 }
796 timeout = 10 * 60 * Ticks::TICKS_PER_SECOND;
797 }
798 /* Randomize a bit when the AI is actually going to start; ranges from 87.5% .. 112.5% of indicated value. */
799 timeout += ScriptObject::GetRandomizer(OWNER_NONE).Next(timeout / 4) - timeout / 8;
800
801 _new_competitor_timeout.Reset({ TimerGameTick::Priority::COMPETITOR_TIMEOUT, static_cast<uint>(std::max(1, timeout)) });
802 }
803
804 _cur_company_tick_index = (_cur_company_tick_index + 1) % MAX_COMPANIES;
805}
806
811static const IntervalTimer<TimerGameEconomy> _economy_companies_yearly({TimerGameEconomy::YEAR, TimerGameEconomy::Priority::COMPANY}, [](auto)
812{
813 /* Copy statistics */
814 for (Company *c : Company::Iterate()) {
815 /* Move expenses to previous years. */
816 std::rotate(std::rbegin(c->yearly_expenses), std::rbegin(c->yearly_expenses) + 1, std::rend(c->yearly_expenses));
817 c->yearly_expenses[0].fill(0);
819 }
820
824 if (c->num_valid_stat_ent > 5 && c->old_economy[0].performance_history < c->old_economy[4].performance_history) {
826 } else {
828 }
829 }
830});
831
838{
839 this->company_name = GetString(STR_COMPANY_NAME, c->index);
840
841 if (other != nullptr) {
842 this->other_company_name = GetString(STR_COMPANY_NAME, other->index);
843 c = other;
844 }
845
846 this->president_name = GetString(STR_PRESIDENT_NAME_MANAGER, c->index);
847
848 this->title = title;
849 this->colour = c->colour;
850 this->face = c->face;
851
852}
853
858void CompanyAdminUpdate(const Company *company)
859{
861}
862
872
882{
884
885 switch (cca) {
886 case CCA_NEW: { // Create a new company
887 /* This command is only executed in a multiplayer game */
888 if (!_networking) return CMD_ERROR;
889
890 /* Has the network client a correct ClientID? */
891 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
892
894
895 /* Delete multiplayer progress bar */
897
898 Company *c = DoStartupNewCompany(false);
899
900 /* A new company could not be created, revert to being a spectator */
901 if (c == nullptr) {
902 /* We check for "ci != nullptr" as a client could have left by
903 * the time we execute this command. */
904 if (_network_server && ci != nullptr) {
907 }
908 break;
909 }
910
913
914 /* This is the client (or non-dedicated server) who wants a new company */
915 if (client_id == _network_own_client_id) {
918
919 /*
920 * If a favorite company manager face is selected, choose it. Otherwise, use a random face.
921 * Because this needs to be synchronised over the network, only the client knows
922 * its configuration and we are currently in the execution of a command, we have
923 * to circumvent the normal ::Post logic for commands and just send the command.
924 */
925 if (!_company_manager_face.empty()) {
927 if (cmf.has_value()) {
928 Command<CMD_SET_COMPANY_MANAGER_FACE>::SendNet(STR_NULL, c->index, cmf->bits, cmf->style);
929 }
930 }
931
932 /* Now that we have a new company, broadcast our company settings to
933 * all clients so everything is in sync */
935
937 }
938 break;
939 }
940
941 case CCA_NEW_AI: { // Make a new AI company
942 if (company_id != CompanyID::Invalid() && company_id >= MAX_COMPANIES) return CMD_ERROR;
943
944 /* For network games, company deletion is delayed. */
945 if (!_networking && company_id != CompanyID::Invalid() && Company::IsValidID(company_id)) return CMD_ERROR;
946
947 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
948
949 /* For network game, just assume deletion happened. */
950 assert(company_id == CompanyID::Invalid() || !Company::IsValidID(company_id));
951
952 Company *c = DoStartupNewCompany(true, company_id);
953 if (c != nullptr) {
955 NetworkServerNewCompany(c, nullptr);
956 }
957 break;
958 }
959
960 case CCA_DELETE: { // Delete a company
961 if (reason >= CRR_END) return CMD_ERROR;
962
963 /* We can't delete the last existing company in singleplayer mode. */
964 if (!_networking && Company::GetNumItems() == 1) return CMD_ERROR;
965
966 Company *c = Company::GetIfValid(company_id);
967 if (c == nullptr) return CMD_ERROR;
968
969 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
970
971 /* Show the bankrupt news */
972 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_BANKRUPT_TITLE, c);
973 EncodedString headline = GetEncodedString(STR_NEWS_COMPANY_BANKRUPT_DESCRIPTION, cni->company_name);
974 AddCompanyNewsItem(std::move(headline), std::move(cni));
975
976 /* Remove the company */
978 if (c->is_ai) AI::Stop(c->index);
979
980 CompanyID c_index = c->index;
981 delete c;
982 AI::BroadcastNewEvent(new ScriptEventCompanyBankrupt(c_index));
983 Game::NewEvent(new ScriptEventCompanyBankrupt(c_index));
984 CompanyAdminRemove(c_index, (CompanyRemoveReason)reason);
985
988
989 break;
990 }
991
992 default: return CMD_ERROR;
993 }
994
998
999 return CommandCost();
1000}
1001
1002static bool ExecuteAllowListCtrlAction(CompanyAllowListCtrlAction action, Company *c, const std::string &public_key)
1003{
1004 switch (action) {
1005 case CALCA_ADD:
1006 return c->allow_list.Add(public_key);
1007
1008 case CALCA_REMOVE:
1009 return c->allow_list.Remove(public_key);
1010
1011 default:
1012 NOT_REACHED();
1013 }
1014}
1015
1024{
1026 if (c == nullptr) return CMD_ERROR;
1027
1028 /* The public key length includes the '\0'. */
1029 if (public_key.size() != NETWORK_PUBLIC_KEY_LENGTH - 1) return CMD_ERROR;
1030
1031 switch (action) {
1032 case CALCA_ADD:
1033 case CALCA_REMOVE:
1034 break;
1035
1036 default:
1037 return CMD_ERROR;
1038 }
1039
1040 if (flags.Test(DoCommandFlag::Execute)) {
1041 if (ExecuteAllowListCtrlAction(action, c, public_key)) {
1044 }
1045 }
1046
1047 return CommandCost();
1048}
1049
1057CommandCost CmdSetCompanyManagerFace(DoCommandFlags flags, uint32_t bits, uint style)
1058{
1059 CompanyManagerFace tmp_face{style, bits, {}};
1060 if (!IsValidCompanyManagerFace(tmp_face)) return CMD_ERROR;
1061
1062 if (flags.Test(DoCommandFlag::Execute)) {
1064 SetCompanyManagerFaceStyle(cmf, style);
1065 cmf.bits = tmp_face.bits;
1066
1068 }
1069 return CommandCost();
1070}
1071
1078{
1079 for (int i = 1; i < LS_END; i++) {
1080 if (!HasBit(c->livery[i].in_use, 0)) c->livery[i].colour1 = c->livery[LS_DEFAULT].colour1;
1081 if (!HasBit(c->livery[i].in_use, 1)) c->livery[i].colour2 = c->livery[LS_DEFAULT].colour2;
1082 }
1084}
1085
1094CommandCost CmdSetCompanyColour(DoCommandFlags flags, LiveryScheme scheme, bool primary, Colours colour)
1095{
1096 if (scheme >= LS_END || (colour >= COLOUR_END && colour != INVALID_COLOUR)) return CMD_ERROR;
1097
1098 /* Default scheme can't be reset to invalid. */
1099 if (scheme == LS_DEFAULT && colour == INVALID_COLOUR) return CMD_ERROR;
1100
1102
1103 /* Ensure no two companies have the same primary colour */
1104 if (scheme == LS_DEFAULT && primary) {
1105 for (const Company *cc : Company::Iterate()) {
1106 if (cc != c && cc->colour == colour) return CMD_ERROR;
1107 }
1108 }
1109
1110 if (flags.Test(DoCommandFlag::Execute)) {
1111 if (primary) {
1112 if (scheme != LS_DEFAULT) AssignBit(c->livery[scheme].in_use, 0, colour != INVALID_COLOUR);
1113 if (colour == INVALID_COLOUR) colour = c->livery[LS_DEFAULT].colour1;
1114 c->livery[scheme].colour1 = colour;
1115
1116 /* If setting the first colour of the default scheme, adjust the
1117 * original and cached company colours too. */
1118 if (scheme == LS_DEFAULT) {
1121 c->colour = colour;
1123 }
1124 } else {
1125 if (scheme != LS_DEFAULT) AssignBit(c->livery[scheme].in_use, 1, colour != INVALID_COLOUR);
1126 if (colour == INVALID_COLOUR) colour = c->livery[LS_DEFAULT].colour2;
1127 c->livery[scheme].colour2 = colour;
1128
1129 if (scheme == LS_DEFAULT) {
1131 }
1132 }
1133
1134 if (c->livery[scheme].in_use != 0) {
1135 /* If enabling a scheme, set the default scheme to be in use too */
1136 c->livery[LS_DEFAULT].in_use = 1;
1137 } else {
1138 /* Else loop through all schemes to see if any are left enabled.
1139 * If not, disable the default scheme too. */
1140 c->livery[LS_DEFAULT].in_use = 0;
1141 for (scheme = LS_DEFAULT; scheme < LS_END; scheme++) {
1142 if (c->livery[scheme].in_use != 0) {
1143 c->livery[LS_DEFAULT].in_use = 1;
1144 break;
1145 }
1146 }
1147 }
1148
1149 ResetVehicleColourMap();
1151
1152 /* All graph related to companies use the company colour. */
1159 /* The smallmap owner view also stores the company colours. */
1162
1163 /* Company colour data is indirectly cached. */
1164 for (Vehicle *v : Vehicle::Iterate()) {
1165 if (v->owner == _current_company) v->InvalidateNewGRFCache();
1166 }
1167
1169 }
1170 return CommandCost();
1171}
1172
1178static bool IsUniqueCompanyName(const std::string &name)
1179{
1180 for (const Company *c : Company::Iterate()) {
1181 if (!c->name.empty() && c->name == name) return false;
1182 }
1183
1184 return true;
1185}
1186
1193CommandCost CmdRenameCompany(DoCommandFlags flags, const std::string &text)
1194{
1195 bool reset = text.empty();
1196
1197 if (!reset) {
1199 if (!IsUniqueCompanyName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
1200 }
1201
1202 if (flags.Test(DoCommandFlag::Execute)) {
1204 if (reset) {
1205 c->name.clear();
1206 } else {
1207 c->name = text;
1208 }
1211
1212 std::string new_name = GetString(STR_COMPANY_NAME, c->index);
1213 AI::BroadcastNewEvent(new ScriptEventCompanyRenamed(c->index, new_name));
1214 Game::NewEvent(new ScriptEventCompanyRenamed(c->index, new_name));
1215 }
1216
1217 return CommandCost();
1218}
1219
1225static bool IsUniquePresidentName(const std::string &name)
1226{
1227 for (const Company *c : Company::Iterate()) {
1228 if (!c->president_name.empty() && c->president_name == name) return false;
1229 }
1230
1231 return true;
1232}
1233
1240CommandCost CmdRenamePresident(DoCommandFlags flags, const std::string &text)
1241{
1242 bool reset = text.empty();
1243
1244 if (!reset) {
1246 if (!IsUniquePresidentName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
1247 }
1248
1249 if (flags.Test(DoCommandFlag::Execute)) {
1251
1252 if (reset) {
1253 c->president_name.clear();
1254 } else {
1255 c->president_name = text;
1256
1257 if (c->name_1 == STR_SV_UNNAMED && c->name.empty()) {
1259 }
1260 }
1261
1265
1266 std::string new_name = GetString(STR_PRESIDENT_NAME, c->index);
1267 AI::BroadcastNewEvent(new ScriptEventPresidentRenamed(c->index, new_name));
1268 Game::NewEvent(new ScriptEventPresidentRenamed(c->index, new_name));
1269 }
1270
1271 return CommandCost();
1272}
1273
1281{
1282 const VehicleDefaultSettings *vds = (c == nullptr) ? &_settings_client.company.vehicle : &c->settings.vehicle;
1283 switch (type) {
1284 default: NOT_REACHED();
1285 case VEH_TRAIN: return vds->servint_trains;
1286 case VEH_ROAD: return vds->servint_roadveh;
1287 case VEH_AIRCRAFT: return vds->servint_aircraft;
1288 case VEH_SHIP: return vds->servint_ships;
1289 }
1290}
1291
1297{
1298 uint32_t total = 0;
1299 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
1300 if (RoadTypeIsRoad(rt)) total += this->road[rt];
1301 }
1302 return total;
1303}
1304
1310{
1311 uint32_t total = 0;
1312 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
1313 if (RoadTypeIsTram(rt)) total += this->road[rt];
1314 }
1315 return total;
1316}
1317
1329{
1331
1333 CommandCost amount(EXPENSES_OTHER, std::min<Money>(money, 20000000LL));
1334
1335 /* You can only transfer funds that is in excess of your loan */
1336 if (c->money - c->current_loan < amount.GetCost() || amount.GetCost() < 0) return CommandCost(STR_ERROR_INSUFFICIENT_FUNDS);
1337 if (!Company::IsValidID(dest_company)) return CMD_ERROR;
1338
1339 if (flags.Test(DoCommandFlag::Execute)) {
1340 /* Add money to company */
1341 Backup<CompanyID> cur_company(_current_company, dest_company);
1343 cur_company.Restore();
1344
1345 if (_networking) {
1346 std::string dest_company_name = GetString(STR_COMPANY_NAME, dest_company);
1347 std::string from_company_name = GetString(STR_COMPANY_NAME, _current_company);
1348
1349 NetworkTextMessage(NETWORK_ACTION_GIVE_MONEY, GetDrawStringCompanyColour(_current_company), false, from_company_name, dest_company_name, amount.GetCost());
1350 }
1351 }
1352
1353 /* Subtract money from local-company */
1354 return amount;
1355}
1356
1367{
1368 for (Company *c : Company::Iterate()) {
1369 if (Company::IsHumanID(c->index)) {
1370 return c->index;
1371 }
1372 }
1373
1375 for (CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
1376 if (!Company::IsValidID(c)) {
1377 return c;
1378 }
1379 }
1380 }
1381
1382 return CompanyID::Begin();
1383}
1384
1385static std::vector<FaceSpec> _faces;
1386
1391{
1392 _faces.clear();
1393 _faces.assign(std::begin(_original_faces), std::end(_original_faces));
1394}
1395
1401{
1402 return static_cast<uint>(std::size(_faces));
1403}
1404
1410const FaceSpec *GetCompanyManagerFaceSpec(uint style_index)
1411{
1412 if (style_index < GetNumCompanyManagerFaceStyles()) return &_faces[style_index];
1413 return nullptr;
1414}
1415
1421std::optional<uint> FindCompanyManagerFaceLabel(std::string_view label)
1422{
1423 auto it = std::ranges::find(_faces, label, &FaceSpec::label);
1424 if (it == std::end(_faces)) return std::nullopt;
1425
1426 return static_cast<uint>(std::distance(std::begin(_faces), it));
1427}
1428
1434FaceVars GetCompanyManagerFaceVars(uint style)
1435{
1436 const FaceSpec *spec = GetCompanyManagerFaceSpec(style);
1437 if (spec == nullptr) return {};
1438 return spec->GetFaceVars();
1439}
1440
1448{
1449 const FaceSpec *spec = GetCompanyManagerFaceSpec(style);
1450 assert(spec != nullptr);
1451
1452 cmf.style = style;
1453 cmf.style_label = spec->label;
1454}
1455
1467
1475uint32_t MaskCompanyManagerFaceBits(const CompanyManagerFace &cmf, FaceVars vars)
1476{
1477 CompanyManagerFace face{};
1478
1479 for (auto var : SetBitIterator(GetActiveFaceVars(cmf, vars))) {
1480 vars[var].SetBits(face, vars[var].GetBits(cmf));
1481 }
1482
1483 return face.bits;
1484}
1485
1492{
1493 uint32_t masked_face_bits = MaskCompanyManagerFaceBits(cmf, GetCompanyManagerFaceVars(cmf.style));
1494 return fmt::format("{}:{}", cmf.style_label, masked_face_bits);
1495}
1496
1502std::optional<CompanyManagerFace> ParseCompanyManagerFaceCode(std::string_view str)
1503{
1504 if (str.empty()) return std::nullopt;
1505
1507 StringConsumer consumer{str};
1508 if (consumer.FindChar(':') != StringConsumer::npos) {
1509 auto label = consumer.ReadUntilChar(':', StringConsumer::SKIP_ONE_SEPARATOR);
1510
1511 /* Read numeric part and ensure it's valid. */
1512 auto bits = consumer.TryReadIntegerBase<uint32_t>(10, true);
1513 if (!bits.has_value() || consumer.AnyBytesLeft()) return std::nullopt;
1514
1515 /* Ensure style laberl is valid. */
1516 auto style = FindCompanyManagerFaceLabel(label);
1517 if (!style.has_value()) return std::nullopt;
1518
1519 SetCompanyManagerFaceStyle(cmf, *style);
1520 cmf.bits = *bits;
1521 } else {
1522 /* No ':' included, treat as numeric-only. This allows old-style codes to be entered. */
1523 auto bits = ParseInteger(str, 10, true);
1524 if (!bits.has_value()) return std::nullopt;
1525
1526 /* Old codes use bits 0..1 to represent face style. These map directly to the default face styles. */
1527 SetCompanyManagerFaceStyle(cmf, GB(*bits, 0, 2));
1528 cmf.bits = *bits;
1529 }
1530
1531 /* Force the face bits to be valid. */
1532 FaceVars vars = GetCompanyManagerFaceVars(cmf.style);
1534 cmf.bits = MaskCompanyManagerFaceBits(cmf, vars);
1535
1536 return cmf;
1537}
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
Parse data from a string / buffer.
std::string_view ReadUntilChar(char c, SeparatorUsage sep)
Read data until the first occurrence of 8-bit char 'c', and advance reader.
@ SKIP_ONE_SEPARATOR
Read and discard one separator, do not include it in the result.
static constexpr size_type npos
Special value for "end of data".
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.
A sort-of mixin that implements 'at(pos)' and 'operator[](pos)' only for a specific type.
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.
std::optional< CompanyManagerFace > ParseCompanyManagerFaceCode(std::string_view str)
Parse a face code into a company manager face.
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.
const FaceSpec * GetCompanyManagerFaceSpec(uint style_index)
Get the definition of a company manager face style.
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.
FaceVars GetCompanyManagerFaceVars(uint style)
Get the face variables for a face style.
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.
void RandomiseCompanyManagerFace(CompanyManagerFace &cmf, Randomizer &randomizer)
Completely randomise a company manager face, including style.
CommandCost CmdSetCompanyManagerFace(DoCommandFlags flags, uint32_t bits, uint style)
Change the company manager's face.
void ResetFaces()
Reset company manager face styles to default.
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.
uint32_t MaskCompanyManagerFaceBits(const CompanyManagerFace &cmf, FaceVars vars)
Mask company manager face bits to ensure they are all within range.
std::string _company_manager_face
for company manager face storage in openttd.cfg
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.
TypedIndexContainer< std::array< Colours, MAX_COMPANIES >, CompanyID > _company_colours
NOSAVE: can be determined from company structs.
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 CmdCompanyCtrl(DoCommandFlags flags, CompanyCtrlAction cca, CompanyID company_id, CompanyRemoveReason reason, ClientID client_id)
Control the companies: add, delete, etc.
static std::vector< FaceSpec > _faces
All company manager face styles.
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.
void SetCompanyManagerFaceStyle(CompanyManagerFace &cmf, uint style)
Set a company face style.
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.
std::optional< uint > FindCompanyManagerFaceLabel(std::string_view label)
Find a company manager face style by label.
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.
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...
uint GetNumCompanyManagerFaceStyles()
Get the number of company manager face styles.
std::string FormatCompanyManagerFaceCode(const CompanyManagerFace &cmf)
Get a face code representation of a company manager face.
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?
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.
This file contains all definitions for default company faces.
static FaceSpec _original_faces[]
Original face styles.
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:1212
Functionality related to the company manager's face.
void RandomiseCompanyManagerFaceBits(CompanyManagerFace &cmf, FaceVars vars, Randomizer &randomizer)
Make a random new face without changing the face style.
uint64_t GetActiveFaceVars(const CompanyManagerFace &cmf, FaceVars vars)
Get a bitmask of currently active face variables.
void ScaleAllCompanyManagerFaceBits(CompanyManagerFace &cmf, FaceVars vars)
Scales all company manager's face bits to the correct scope.
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.
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:1032
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:308
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:1543
@ 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)
PixelColour 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:188
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
Parse strings.
static std::optional< T > ParseInteger(std::string_view arg, int base=10, bool clamp=false)
Change a string into its number representation.
EncodedString GetEncodedStringWithArgs(StringID str, std::span< const StringParameter > params)
Encode a string with its parameters into an encoded string.
Definition strings.cpp:102
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
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 bits
Company manager face bits, meaning is dependent on style.
uint style
Company manager face style.
std::string style_label
Face style label.
CompanyManagerFace face
The face of the president.
Definition news_type.h:168
Colours colour
The colour related to the company.
Definition news_type.h:169
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:164
std::string company_name
The name of the company.
Definition news_type.h:163
std::string other_company_name
The name of the company taking over this one.
Definition news_type.h:165
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.
Structure to encapsulate the pseudo random number generators.
uint32_t Next()
Generate the next pseudo random number.
Iterable ensemble of each set bit in a value.
bool new_year
Play sound on new year, summarising the performance during the last year.
Town data structure.
Definition town.h:53
std::string name
Custom town name. If empty, the town was not renamed and uses the generated name.
Definition town.h:62
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:556
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:3353
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:1184
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:3267
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1142
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:3162
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3149
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:3284
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_COMPANY_COLOUR
Company colour selection; 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: