OpenTTD Source 20260512-master-g20b387b91f
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
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
52void ClearEnginesHiddenFlagOfCompany(CompanyID cid);
53void UpdateObjectColours(const Company *c);
54
55CompanyID _local_company;
60
61CompanyPool _company_pool("Company");
63
64
70Company::Company(CompanyID index, StringID name_1, bool is_ai) : CompanyPool::PoolItem<&_company_pool>(index)
71{
72 this->name_1 = name_1;
73 this->is_ai = is_ai;
74 this->terraform_limit = (uint32_t)_settings_game.construction.terraform_frame_burst << 16;
75 this->clear_limit = (uint32_t)_settings_game.construction.clear_frame_burst << 16;
76 this->tree_limit = (uint32_t)_settings_game.construction.tree_frame_burst << 16;
77 this->build_object_limit = (uint32_t)_settings_game.construction.build_object_frame_burst << 16;
78
79 InvalidateWindowData(WC_PERFORMANCE_DETAIL, 0, CompanyID::Invalid());
80}
81
84{
85 if (CleaningPool()) return;
86
88}
89
95{
100 /* If the currently shown error message has this company in it, then close it. */
102}
103
109{
110 if (this->max_loan == COMPANY_MAX_LOAN_DEFAULT) return _economy.max_loan;
111 return this->max_loan;
112}
113
120void SetLocalCompany(CompanyID new_company)
121{
122 /* company could also be COMPANY_SPECTATOR or OWNER_NONE */
123 assert(Company::IsValidID(new_company) || new_company == COMPANY_SPECTATOR || new_company == OWNER_NONE);
124
125 /* If actually changing to another company, several windows need closing */
126 bool switching_company = _local_company != new_company;
127
128 /* Delete the chat window, if you were team chatting. */
130
131 assert(IsLocalCompany());
132
133 _current_company = _local_company = new_company;
134
135 if (switching_company) {
138 /* Delete any construction windows... */
140 /* Update the default rail based on most used */
142 }
143
144 /* ... and redraw the whole screen. */
149 ResetVehicleColourMap();
150}
151
158{
159 if (!Company::IsValidID(company)) return GetColourGradient(Colours::White, Shade::Normal).ToTextColour();
160 return GetColourGradient(_company_colours[company], Shade::Normal).ToTextColour();
161}
162
168PaletteID GetCompanyPalette(CompanyID company)
169{
170 return GetColourPalette(_company_colours[company]);
171}
172
179void DrawCompanyIcon(CompanyID c, int x, int y)
180{
181 DrawSprite(SPR_COMPANY_ICON, GetCompanyPalette(c), x, y);
182}
183
191{
192 if (cmf.style >= GetNumCompanyManagerFaceStyles()) return false;
193
194 /* Test if each enabled part is valid. */
195 FaceVars vars = GetCompanyManagerFaceVars(cmf.style);
196 for (uint var : SetBitIterator(GetActiveFaceVars(cmf, vars))) {
197 if (!vars[var].IsValid(cmf)) return false;
198 }
199
200 return true;
201}
202
204
211{
212 CompanyID cid = company->index;
214}
215
219static const IntervalTimer<TimerWindow> invalidate_company_windows_interval(std::chrono::milliseconds(1), [](auto) {
220 for (CompanyID cid : _dirty_company_finances) {
223 if (w != nullptr) {
229 }
231 }
233});
234
242Money GetAvailableMoney(CompanyID company)
243{
244 if (_settings_game.difficulty.infinite_money) return INT64_MAX;
245 if (!Company::IsValidID(company)) return INT64_MAX;
246 return Company::Get(company)->money;
247}
248
260
268{
269 if (cost.GetCost() <= 0) return true;
270 if (_settings_game.difficulty.infinite_money) return true;
271
273 if (c != nullptr && cost.GetCost() > c->money) {
274 cost.MakeError(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY);
275 if (IsLocalCompany()) {
276 cost.SetEncodedMessage(GetEncodedString(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY, cost.GetCost()));
277 }
278 return false;
279 }
280 return true;
281}
282
288static void SubtractMoneyFromCompany(Company *c, const CommandCost &cost)
289{
290 using ExpensesTypes = EnumBitSet<ExpensesType, uint16_t>;
291 static constexpr ExpensesTypes EXPENSESTYPES_INCOME{
296 };
297 static constexpr ExpensesTypes EXPENSESTYPES_EXPENSES{
304 };
305
306 if (cost.GetCost() == 0) return;
307 assert(cost.GetExpensesType() != ExpensesType::Invalid);
308
309 c->money -= cost.GetCost();
310 c->yearly_expenses[0][cost.GetExpensesType()] += cost.GetCost();
311
312 if (EXPENSESTYPES_INCOME.Test(cost.GetExpensesType())) {
313 c->cur_economy.income -= cost.GetCost();
314 } else if (EXPENSESTYPES_EXPENSES.Test(cost.GetExpensesType())) {
315 c->cur_economy.expenses -= cost.GetCost();
316 }
317
319}
320
326void SubtractMoneyFromCompany(CompanyID company, const CommandCost &cost)
327{
328 Company *c = Company::GetIfValid(company);
329 if (c != nullptr) SubtractMoneyFromCompany(c, cost);
330}
331
337void SubtractMoneyFromCompanyFract(CompanyID company, const CommandCost &cst)
338{
339 Company *c = Company::Get(company);
340 uint8_t m = c->money_fraction;
341 Money cost = cst.GetCost();
342
343 c->money_fraction = m - (uint8_t)cost;
344 cost >>= 8;
345 if (c->money_fraction > m) cost++;
346 if (cost != 0) SubtractMoneyFromCompany(c, CommandCost(cst.GetExpensesType(), cost));
347}
348
349static constexpr void UpdateLandscapingLimit(uint32_t &limit, uint64_t per_64k_frames, uint64_t burst)
350{
351 limit = static_cast<uint32_t>(std::min<uint64_t>(limit + per_64k_frames, burst << 16));
352}
353
356{
357 for (Company *c : Company::Iterate()) {
358 UpdateLandscapingLimit(c->terraform_limit, _settings_game.construction.terraform_per_64k_frames, _settings_game.construction.terraform_frame_burst);
359 UpdateLandscapingLimit(c->clear_limit, _settings_game.construction.clear_per_64k_frames, _settings_game.construction.clear_frame_burst);
360 UpdateLandscapingLimit(c->tree_limit, _settings_game.construction.tree_per_64k_frames, _settings_game.construction.tree_frame_burst);
361 UpdateLandscapingLimit(c->build_object_limit, _settings_game.construction.build_object_per_64k_frames, _settings_game.construction.build_object_frame_burst);
362 }
363}
364
372std::array<StringParameter, 2> GetParamsForOwnedBy(Owner owner, TileIndex tile)
373{
374 if (owner == OWNER_TOWN) {
375 assert(tile != 0);
376 const Town *t = ClosestTownFromTile(tile, UINT_MAX);
377 return {STR_TOWN_NAME, t->index};
378 }
379
380 if (!Company::IsValidID(owner)) {
381 return {STR_COMPANY_SOMEONE, std::monostate{}};
382 }
383
384 return {STR_COMPANY_NAME, owner};
385}
386
396{
397 assert(owner < OWNER_END);
398 assert(owner != OWNER_TOWN || tile != 0);
399
400 if (owner == _current_company) return CommandCost();
401
402 CommandCost error{STR_ERROR_OWNED_BY};
403 if (IsLocalCompany()) {
404 auto params = GetParamsForOwnedBy(owner, tile);
405 error.SetEncodedMessage(GetEncodedStringWithArgs(STR_ERROR_OWNED_BY, params));
406 if (owner != OWNER_TOWN) error.SetErrorOwner(owner);
407 }
408 return error;
409}
410
419{
420 return CheckOwnership(GetTileOwner(tile), tile);
421}
422
428{
429 if (c->name_1 != STR_SV_UNNAMED) return;
430 if (c->last_build_coordinate == 0) return;
431
433
434 StringID str;
435 uint32_t strp;
436 std::string name;
437 if (t->name.empty() && IsInsideMM(t->townnametype, SPECSTR_TOWNNAME_START, SPECSTR_TOWNNAME_END)) {
439 strp = t->townnameparts;
440
441verify_name:;
442 /* No companies must have this name already */
443 for (const Company *cc : Company::Iterate()) {
444 if (cc->name_1 == str && cc->name_2 == strp) goto bad_town_name;
445 }
446
447 name = GetString(str, strp);
448 if (Utf8StringLength(name) >= MAX_LENGTH_COMPANY_NAME_CHARS) goto bad_town_name;
449
450set_name:;
451 c->name_1 = str;
452 c->name_2 = strp;
453
455 AI::BroadcastNewEvent(new ScriptEventCompanyRenamed(c->index, name));
456 Game::NewEvent(new ScriptEventCompanyRenamed(c->index, name));
457
458 if (c->is_ai) {
459 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_LAUNCH_TITLE, c);
460 EncodedString headline = GetEncodedString(STR_NEWS_COMPANY_LAUNCH_DESCRIPTION, cni->company_name, t->index);
461 AddNewsItem(std::move(headline),
463 }
464 return;
465 }
466bad_town_name:;
467
469 str = SPECSTR_ANDCO_NAME;
470 strp = c->president_name_2;
471 name = GetString(str, strp);
472 goto set_name;
473 } else {
474 str = SPECSTR_ANDCO_NAME;
475 strp = Random();
476 goto verify_name;
477 }
478}
479
481static const EnumIndexArray<uint8_t, Colours, Colours::End> _colour_sort{2, 2, 3, 2, 3, 2, 3, 2, 3, 2, 2, 2, 3, 1, 1, 1};
483static const std::initializer_list<Colours> _similar_colour[to_underlying(Colours::End)] = {
484 {Colours::Blue, Colours::LightBlue }, // Colours::DarkBlue
485 {Colours::Green, Colours::DarkGreen }, // Colours::PaleGreen
486 {}, // Colours::Pink
487 {Colours::Orange}, // Colours::Yellow
488 {}, // Colours::Red
489 {Colours::DarkBlue, Colours::Blue }, // Colours::LightBlue
490 {Colours::PaleGreen, Colours::DarkGreen }, // Colours::Green
491 {Colours::PaleGreen, Colours::Green }, // Colours::DarkGreen
492 {Colours::DarkBlue, Colours::LightBlue }, // Colours::Blue
493 {Colours::Brown, Colours::Orange }, // Colours::Cream
494 {Colours::Purple}, // Colours::Mauve
495 {Colours::Mauve}, // Colours::Purple
496 {Colours::Yellow, Colours::Cream }, // Colours::Orange
497 {Colours::Cream}, // Colours::Brown
498 {Colours::White}, // Colours::Grey
499 {Colours::Grey}, // Colours::White
500};
501
507{
508 /* Initialize colour table. */
509 std::vector<Colours> colours(to_underlying(Colours::End));
510 std::iota(colours.begin(), colours.end(), Colours::Begin);
511
512 /* And randomize it */
513 for (uint i = 0; i < 100; i++) {
514 uint r = Random();
515 std::swap(colours[GB(r, 0, 4)], colours[GB(r, 4, 4)]);
516 }
517
518 /* Sort it according to the values in _colour_sort. */
519 std::ranges::stable_sort(colours, {}, [](auto &i) { return _colour_sort[i]; });
520
521 /* Move the colours that look similar to each company's colour to the side */
522 for (const Company *c : Company::Iterate()) {
523 /* This company's colour is not available at all. */
524 std::erase(colours, c->colour);
525
526 for (Colours similar : _similar_colour[to_underlying(c->colour)]) {
527 auto it = std::ranges::find(colours, similar);
528 if (it != colours.end()) std::rotate(it, it + 1, colours.end());
529 }
530 }
531
532 /* Return the first available colour */
533 return colours.at(0);
534}
535
541{
542 for (;;) {
543restart:;
544 c->president_name_2 = Random();
546
547 /* Reserve space for extra unicode character. We need to do this to be able
548 * to detect too long president name. */
549 std::string name = GetString(STR_PRESIDENT_NAME, c->index);
551
552 for (const Company *cc : Company::Iterate()) {
553 if (c != cc) {
554 std::string other_name = GetString(STR_PRESIDENT_NAME, cc->index);
555 if (name == other_name) goto restart;
556 }
557 }
558 return;
559 }
560}
561
568{
569 for (LiveryScheme scheme = LS_BEGIN; scheme < LS_END; scheme++) {
570 c->livery[scheme].in_use.Reset();
571 c->livery[scheme].colour1 = c->colour;
572 c->livery[scheme].colour2 = c->colour;
573 }
574
575 for (Group *g : Group::Iterate()) {
576 if (g->owner == c->index) {
577 g->livery.in_use.Reset();
578 g->livery.colour1 = c->colour;
579 g->livery.colour2 = c->colour;
580 }
581 }
582}
583
591Company *DoStartupNewCompany(bool is_ai, CompanyID company = CompanyID::Invalid())
592{
593 if (!Company::CanAllocateItem()) return nullptr;
594
595 /* we have to generate colour before this company is valid */
597
598 Company *c;
599 if (company == CompanyID::Invalid()) {
600 c = Company::Create(STR_SV_UNNAMED, is_ai);
601 } else {
602 if (Company::IsValidID(company)) return nullptr;
603 c = Company::CreateAtIndex(company, STR_SV_UNNAMED, is_ai);
604 }
605
606 c->colour = colour;
607
609 _company_colours[c->index] = c->colour;
610
611 /* Scale the initial loan based on the inflation rounded down to the loan interval. The maximum loan has already been inflation adjusted. */
612 c->money = c->current_loan = std::min<int64_t>((INITIAL_LOAN * _economy.inflation_prices >> 16) / LOAN_INTERVAL * LOAN_INTERVAL, _economy.max_loan);
613
618
619 /* If starting a player company in singleplayer and a favourite company manager face is selected, choose it. Otherwise, use a random face.
620 * In a network game, we'll choose the favourite face later in CmdCompanyCtrl to sync it to all clients. */
621 bool randomise_face = true;
622 if (!_company_manager_face.empty() && !is_ai && !_networking) {
624 if (cmf.has_value()) {
625 randomise_face = false;
626 c->face = std::move(*cmf);
627 }
628 }
629 if (randomise_face) RandomiseCompanyManagerFace(c->face, _random);
630
633
635
641
642 if (is_ai && (!_networking || _network_server)) AI::StartNew(c->index);
643
644 AI::BroadcastNewEvent(new ScriptEventCompanyNew(c->index), c->index);
645 Game::NewEvent(new ScriptEventCompanyNew(c->index));
646
647 return c;
648}
649
652 if (_game_mode == GM_MENU || !AI::CanStartNew()) return;
653 if (_networking && Company::GetNumItems() >= _settings_client.network.max_companies) return;
654 if (_settings_game.difficulty.competitors_interval == 0) return;
655
656 /* count number of competitors */
657 uint8_t n = 0;
658 for (const Company *c : Company::Iterate()) {
659 if (c->is_ai) n++;
660 }
661
662 if (n >= _settings_game.difficulty.max_no_competitors) return;
663
664 /* Send a command to all clients to start up a new AI.
665 * Works fine for Multiplayer and Singleplayer */
666 Command<Commands::CompanyControl>::Post(CompanyCtrlAction::NewAI, CompanyID::Invalid(), CompanyRemoveReason::None, INVALID_CLIENT_ID);
667});
668
671{
672 /* Ensure the timeout is aborted, so it doesn't fire based on information of the last game. */
674}
675
681
688bool CheckTakeoverVehicleLimit(CompanyID cbig, CompanyID csmall)
689{
690 const Company *c1 = Company::Get(cbig);
691 const Company *c2 = Company::Get(csmall);
692
693 /* Do the combined vehicle counts stay within the limits? */
694 return c1->group_all[VehicleType::Train].num_vehicle + c2->group_all[VehicleType::Train].num_vehicle <= _settings_game.vehicle.max_trains &&
695 c1->group_all[VehicleType::Road].num_vehicle + c2->group_all[VehicleType::Road].num_vehicle <= _settings_game.vehicle.max_roadveh &&
696 c1->group_all[VehicleType::Ship].num_vehicle + c2->group_all[VehicleType::Ship].num_vehicle <= _settings_game.vehicle.max_ships &&
697 c1->group_all[VehicleType::Aircraft].num_vehicle + c2->group_all[VehicleType::Aircraft].num_vehicle <= _settings_game.vehicle.max_aircraft;
698}
699
710{
711 /* Amount of time out for each company to take over a company;
712 * Timeout is a quarter (3 months of 30 days) divided over the
713 * number of companies. The minimum number of days in a quarter
714 * is 90: 31 in January, 28 in February and 31 in March.
715 * Note that the company going bankrupt can't buy itself. */
716 static const int TAKE_OVER_TIMEOUT = 3 * 30 * Ticks::DAY_TICKS / (MAX_COMPANIES - 1);
717
718 assert(c->bankrupt_asked.Any());
719
720 /* We're currently asking some company to buy 'us' */
721 if (c->bankrupt_timeout != 0) {
722 c->bankrupt_timeout -= MAX_COMPANIES;
723 if (c->bankrupt_timeout > 0) return;
724 c->bankrupt_timeout = 0;
725
726 return;
727 }
728
729 /* Did we ask everyone for bankruptcy? If so, bail out. */
730 if (c->bankrupt_asked.All()) return;
731
732 Company *best = nullptr;
733 int32_t best_performance = -1;
734
735 /* Ask the company with the highest performance history first */
736 for (Company *c2 : Company::Iterate()) {
737 if (c2->bankrupt_asked.None() && // Don't ask companies going bankrupt themselves
738 !c->bankrupt_asked.Test(c2->index) &&
739 best_performance < c2->old_economy[1].performance_history &&
740 CheckTakeoverVehicleLimit(c2->index, c->index)) {
741 best_performance = c2->old_economy[1].performance_history;
742 best = c2;
743 }
744 }
745
746 /* Asked all companies? */
747 if (best_performance == -1) {
748 c->bankrupt_asked.Set();
749 return;
750 }
751
752 c->bankrupt_asked.Set(best->index);
753
754 c->bankrupt_timeout = TAKE_OVER_TIMEOUT;
755
756 AI::NewEvent(best->index, new ScriptEventCompanyAskMerger(c->index, c->bankrupt_value));
757 if (IsInteractiveCompany(best->index)) {
758 ShowBuyCompanyDialog(c->index, false);
759 }
760}
761
764{
765 if (_game_mode == GM_EDITOR) return;
766
768 if (c != nullptr) {
769 if (c->name_1 != 0) GenerateCompanyName(c);
771 }
772
773 if (_new_competitor_timeout.HasFired() && _game_mode != GM_MENU && AI::CanStartNew()) {
774 int32_t timeout = _settings_game.difficulty.competitors_interval * 60 * Ticks::TICKS_PER_SECOND;
775 /* If the interval is zero, start as many competitors as needed then check every ~10 minutes if a company went bankrupt and needs replacing. */
776 if (timeout == 0) {
777 /* count number of competitors */
778 uint8_t num_ais = 0;
779 for (const Company *cc : Company::Iterate()) {
780 if (cc->is_ai) num_ais++;
781 }
782
783 size_t num_companies = Company::GetNumItems();
784 for (auto i = 0; i < _settings_game.difficulty.max_no_competitors; i++) {
785 if (_networking && num_companies++ >= _settings_client.network.max_companies) break;
786 if (num_ais++ >= _settings_game.difficulty.max_no_competitors) break;
787 Command<Commands::CompanyControl>::Post(CompanyCtrlAction::NewAI, CompanyID::Invalid(), {}, INVALID_CLIENT_ID);
788 }
789 timeout = 10 * 60 * Ticks::TICKS_PER_SECOND;
790 }
791 /* Randomize a bit when the AI is actually going to start; ranges from 87.5% .. 112.5% of indicated value. */
792 timeout += ScriptObject::GetRandomizer(OWNER_NONE).Next(timeout / 4) - timeout / 8;
793
794 _new_competitor_timeout.Reset({ TimerGameTick::Priority::CompetitorTimeout, static_cast<uint>(std::max(1, timeout)) });
795 }
796
797 _cur_company_tick_index = (_cur_company_tick_index + 1) % MAX_COMPANIES;
798}
799
804static const IntervalTimer<TimerGameEconomy> _economy_companies_yearly({TimerGameEconomy::Trigger::Year, TimerGameEconomy::Priority::Company}, [](auto)
805{
806 /* Copy statistics */
807 for (Company *c : Company::Iterate()) {
808 /* Move expenses to previous years. */
809 std::rotate(std::rbegin(c->yearly_expenses), std::rbegin(c->yearly_expenses) + 1, std::rend(c->yearly_expenses));
810 c->yearly_expenses[0].fill(0);
812 }
813
814 if (_settings_client.gui.show_finances && _local_company != COMPANY_SPECTATOR) {
817 if (c->num_valid_stat_ent > 5 && c->old_economy[0].performance_history < c->old_economy[4].performance_history) {
818 if (_settings_client.sound.new_year) SndPlayFx(SND_01_BAD_YEAR);
819 } else {
820 if (_settings_client.sound.new_year) SndPlayFx(SND_00_GOOD_YEAR);
821 }
822 }
823});
824
832{
833 this->company_name = GetString(STR_COMPANY_NAME, c->index);
834
835 if (other != nullptr) {
836 this->other_company_name = GetString(STR_COMPANY_NAME, other->index);
837 c = other;
838 }
839
840 this->president_name = GetString(STR_PRESIDENT_NAME_MANAGER, c->index);
841
842 this->title = title;
843 this->colour = c->colour;
844 this->face = c->face;
845
846}
847
852void CompanyAdminUpdate(const Company *company)
853{
855}
856
862void CompanyAdminRemove(CompanyID company_id, CompanyRemoveReason reason)
863{
865}
866
876CommandCost CmdCompanyCtrl(DoCommandFlags flags, CompanyCtrlAction cca, CompanyID company_id, CompanyRemoveReason reason, ClientID client_id)
877{
879
880 switch (cca) {
881 case CompanyCtrlAction::New: { // Create a new company
882 /* This command is only executed in a multiplayer game */
883 if (!_networking) return CMD_ERROR;
884
885 /* Has the network client a correct ClientID? */
886 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
887
889
890 /* Delete multiplayer progress bar */
892
893 Company *c = DoStartupNewCompany(false);
894
895 /* A new company could not be created, revert to being a spectator */
896 if (c == nullptr) {
897 /* We check for "ci != nullptr" as a client could have left by
898 * the time we execute this command. */
899 if (_network_server && ci != nullptr) {
902 }
903 break;
904 }
905
908
909 /* This is the client (or non-dedicated server) who wants a new company */
910 if (client_id == _network_own_client_id) {
912 SetLocalCompany(c->index);
913
914 /*
915 * If a favourite company manager face is selected, choose it. Otherwise, use a random face.
916 * Because this needs to be synchronised over the network, only the client knows
917 * its configuration and we are currently in the execution of a command, we have
918 * to circumvent the normal ::Post logic for commands and just send the command.
919 */
920 if (!_company_manager_face.empty()) {
922 if (cmf.has_value()) {
923 Command<Commands::SetCompanyManagerFace>::SendNet(STR_NULL, c->index, cmf->style, cmf->bits);
924 }
925 }
926
927 /* Now that we have a new company, broadcast our company settings to
928 * all clients so everything is in sync */
930
932 }
933 break;
934 }
935
936 case CompanyCtrlAction::NewAI: { // Make a new AI company
937 if (company_id != CompanyID::Invalid() && company_id >= MAX_COMPANIES) return CMD_ERROR;
938
939 /* For network games, company deletion is delayed. */
940 if (!_networking && company_id != CompanyID::Invalid() && Company::IsValidID(company_id)) return CMD_ERROR;
941
942 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
943
944 /* For network game, just assume deletion happened. */
945 assert(company_id == CompanyID::Invalid() || !Company::IsValidID(company_id));
946
947 Company *c = DoStartupNewCompany(true, company_id);
948 if (c != nullptr) {
950 NetworkServerNewCompany(c, nullptr);
951 }
952 break;
953 }
954
955 case CompanyCtrlAction::Delete: { // Delete a company
956 if (reason >= CompanyRemoveReason::End) return CMD_ERROR;
957
958 /* We can't delete the last existing company in singleplayer mode. */
959 if (!_networking && Company::GetNumItems() == 1) return CMD_ERROR;
960
961 Company *c = Company::GetIfValid(company_id);
962 if (c == nullptr) return CMD_ERROR;
963
964 if (!flags.Test(DoCommandFlag::Execute)) return CommandCost();
965
966 /* Show the bankrupt news */
967 auto cni = std::make_unique<CompanyNewsInformation>(STR_NEWS_COMPANY_BANKRUPT_TITLE, c);
968 EncodedString headline = GetEncodedString(STR_NEWS_COMPANY_BANKRUPT_DESCRIPTION, cni->company_name);
969 AddCompanyNewsItem(std::move(headline), std::move(cni));
970
971 /* Remove the company */
973 if (c->is_ai) AI::Stop(c->index);
974
975 CompanyID c_index = c->index;
976 delete c;
977 AI::BroadcastNewEvent(new ScriptEventCompanyBankrupt(c_index));
978 Game::NewEvent(new ScriptEventCompanyBankrupt(c_index));
979 CompanyAdminRemove(c_index, (CompanyRemoveReason)reason);
980
983
984 break;
985 }
986
987 default: return CMD_ERROR;
988 }
989
993
994 return CommandCost();
995}
996
997static bool ExecuteAllowListCtrlAction(CompanyAllowListCtrlAction action, Company *c, const std::string &public_key)
998{
999 switch (action) {
1001 return c->allow_list.Add(public_key);
1002
1004 return c->allow_list.Remove(public_key);
1005
1007 if (c->allow_any) return false;
1008 c->allow_any = true;
1009 return true;
1010
1012 if (!c->allow_any) return false;
1013 c->allow_any = false;
1014 return true;
1015
1016 default:
1017 NOT_REACHED();
1018 }
1019}
1020
1028CommandCost CmdCompanyAllowListCtrl(DoCommandFlags flags, CompanyAllowListCtrlAction action, const std::string &public_key)
1029{
1031 if (c == nullptr) return CMD_ERROR;
1032
1033 switch (action) {
1036 /* The public key length includes the '\0'. */
1037 if (public_key.size() != NETWORK_PUBLIC_KEY_LENGTH - 1) return CMD_ERROR;
1038 break;
1039
1042 if (public_key.size() != 0) return CMD_ERROR;
1043 break;
1044
1045 default:
1046 return CMD_ERROR;
1047 }
1048
1049 if (flags.Test(DoCommandFlag::Execute)) {
1050 if (ExecuteAllowListCtrlAction(action, c, public_key)) {
1053 }
1054 }
1055
1056 return CommandCost();
1057}
1058
1066CommandCost CmdSetCompanyManagerFace(DoCommandFlags flags, uint style, uint32_t bits)
1067{
1068 CompanyManagerFace tmp_face{style, bits, {}};
1069 if (!IsValidCompanyManagerFace(tmp_face)) return CMD_ERROR;
1070
1071 if (flags.Test(DoCommandFlag::Execute)) {
1073 SetCompanyManagerFaceStyle(cmf, style);
1074 cmf.bits = tmp_face.bits;
1075
1077 }
1078 return CommandCost();
1079}
1080
1087{
1088 for (int i = 1; i < LS_END; i++) {
1089 if (!c->livery[i].in_use.Test(Livery::Flag::Primary)) c->livery[i].colour1 = c->livery[LS_DEFAULT].colour1;
1090 if (!c->livery[i].in_use.Test(Livery::Flag::Secondary)) c->livery[i].colour2 = c->livery[LS_DEFAULT].colour2;
1091 }
1093}
1094
1103CommandCost CmdSetCompanyColour(DoCommandFlags flags, LiveryScheme scheme, bool primary, Colours colour)
1104{
1105 if (scheme >= LS_END || (colour >= Colours::End && colour != Colours::Invalid)) return CMD_ERROR;
1106
1107 /* Default scheme can't be reset to invalid. */
1108 if (scheme == LS_DEFAULT && colour == Colours::Invalid) return CMD_ERROR;
1109
1111
1112 /* Ensure no two companies have the same primary colour */
1113 if (scheme == LS_DEFAULT && primary) {
1114 for (const Company *cc : Company::Iterate()) {
1115 if (cc != c && cc->colour == colour) return CMD_ERROR;
1116 }
1117 }
1118
1119 if (flags.Test(DoCommandFlag::Execute)) {
1120 if (primary) {
1121 if (scheme != LS_DEFAULT) c->livery[scheme].in_use.Set(Livery::Flag::Primary, colour != Colours::Invalid);
1122 if (colour == Colours::Invalid) colour = c->livery[LS_DEFAULT].colour1;
1123 c->livery[scheme].colour1 = colour;
1124
1125 /* If setting the first colour of the default scheme, adjust the
1126 * original and cached company colours too. */
1127 if (scheme == LS_DEFAULT) {
1130 c->colour = colour;
1132 }
1133 } else {
1134 if (scheme != LS_DEFAULT) c->livery[scheme].in_use.Set(Livery::Flag::Secondary, colour != Colours::Invalid);
1135 if (colour == Colours::Invalid) colour = c->livery[LS_DEFAULT].colour2;
1136 c->livery[scheme].colour2 = colour;
1137
1138 if (scheme == LS_DEFAULT) {
1140 }
1141 }
1142
1143 if (c->livery[scheme].in_use.Any({Livery::Flag::Primary, Livery::Flag::Secondary})) {
1144 /* If enabling a scheme, set the default scheme to be in use too */
1145 c->livery[LS_DEFAULT].in_use.Set(Livery::Flag::Primary);
1146 } else {
1147 /* Else loop through all schemes to see if any are left enabled.
1148 * If not, disable the default scheme too. */
1149 c->livery[LS_DEFAULT].in_use.Reset({Livery::Flag::Primary, Livery::Flag::Secondary});
1150 for (scheme = LS_DEFAULT; scheme < LS_END; scheme++) {
1151 if (c->livery[scheme].in_use.Any({Livery::Flag::Primary, Livery::Flag::Secondary})) {
1152 c->livery[LS_DEFAULT].in_use.Set(Livery::Flag::Primary);
1153 break;
1154 }
1155 }
1156 }
1157
1158 ResetVehicleColourMap();
1160
1161 /* All graph related to companies use the company colour. */
1168 /* The smallmap owner view also stores the company colours. */
1171
1172 /* Company colour data is indirectly cached. */
1173 for (Vehicle *v : Vehicle::Iterate()) {
1174 if (v->owner == _current_company) v->InvalidateNewGRFCache();
1175 }
1176
1178 }
1179 return CommandCost();
1180}
1181
1187static bool IsUniqueCompanyName(const std::string &name)
1188{
1189 for (const Company *c : Company::Iterate()) {
1190 if (!c->name.empty() && c->name == name) return false;
1191 }
1192
1193 return true;
1194}
1195
1202CommandCost CmdRenameCompany(DoCommandFlags flags, const std::string &text)
1203{
1204 bool reset = text.empty();
1205
1206 if (!reset) {
1208 if (!IsUniqueCompanyName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
1209 }
1210
1211 if (flags.Test(DoCommandFlag::Execute)) {
1213 if (reset) {
1214 c->name.clear();
1215 } else {
1216 c->name = text;
1217 }
1218
1222
1223 std::string new_name = GetString(STR_COMPANY_NAME, c->index);
1224 AI::BroadcastNewEvent(new ScriptEventCompanyRenamed(c->index, new_name));
1225 Game::NewEvent(new ScriptEventCompanyRenamed(c->index, new_name));
1226 }
1227
1228 return CommandCost();
1229}
1230
1236static bool IsUniquePresidentName(const std::string &name)
1237{
1238 for (const Company *c : Company::Iterate()) {
1239 if (!c->president_name.empty() && c->president_name == name) return false;
1240 }
1241
1242 return true;
1243}
1244
1251CommandCost CmdRenamePresident(DoCommandFlags flags, const std::string &text)
1252{
1253 bool reset = text.empty();
1254
1255 if (!reset) {
1257 if (!IsUniquePresidentName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
1258 }
1259
1260 if (flags.Test(DoCommandFlag::Execute)) {
1262
1263 if (reset) {
1264 c->president_name.clear();
1265 } else {
1266 c->president_name = text;
1267
1268 if (c->name_1 == STR_SV_UNNAMED && c->name.empty()) {
1269 Command<Commands::RenameCompany>::Do(DoCommandFlag::Execute, text + " Transport");
1270 }
1271 }
1272
1276
1277 std::string new_name = GetString(STR_PRESIDENT_NAME, c->index);
1278 AI::BroadcastNewEvent(new ScriptEventPresidentRenamed(c->index, new_name));
1279 Game::NewEvent(new ScriptEventPresidentRenamed(c->index, new_name));
1280 }
1281
1282 return CommandCost();
1283}
1284
1292{
1293 const VehicleDefaultSettings *vds = (c == nullptr) ? &_settings_client.company.vehicle : &c->settings.vehicle;
1294 switch (type) {
1295 default: NOT_REACHED();
1296 case VehicleType::Train: return vds->servint_trains;
1297 case VehicleType::Road: return vds->servint_roadveh;
1298 case VehicleType::Aircraft: return vds->servint_aircraft;
1299 case VehicleType::Ship: return vds->servint_ships;
1300 }
1301}
1302
1309{
1310 uint32_t total = 0;
1311 for (RoadType rt : GetMaskForRoadTramType(rtt)) {
1312 total += this->road[rt];
1313 }
1314 return total;
1315}
1316
1327CommandCost CmdGiveMoney(DoCommandFlags flags, Money money, CompanyID dest_company)
1328{
1329 if (!_settings_game.economy.give_money) return CMD_ERROR;
1330
1332 CommandCost amount(ExpensesType::Other, std::min<Money>(money, 20000000LL));
1333
1334 /* You can only transfer funds that is in excess of your loan */
1335 if (c->money - c->current_loan < amount.GetCost() || amount.GetCost() < 0) return CommandCost(STR_ERROR_INSUFFICIENT_FUNDS);
1336 if (!Company::IsValidID(dest_company)) return CMD_ERROR;
1337
1338 if (flags.Test(DoCommandFlag::Execute)) {
1339 /* Add money to company */
1341
1342 if (_networking) {
1343 std::string dest_company_name = GetString(STR_COMPANY_NAME, dest_company);
1344 std::string from_company_name = GetString(STR_COMPANY_NAME, _current_company);
1345
1346 NetworkTextMessage(NetworkAction::GiveMoney, GetDrawStringCompanyColour(_current_company), false, from_company_name, dest_company_name, amount.GetCost());
1347 }
1348 }
1349
1350 /* Subtract money from local-company */
1351 return amount;
1352}
1353
1364{
1365 for (Company *c : Company::Iterate()) {
1366 if (Company::IsHumanID(c->index)) {
1367 return c->index;
1368 }
1369 }
1370
1372 for (CompanyID c = CompanyID::Begin(); c < MAX_COMPANIES; ++c) {
1373 if (!Company::IsValidID(c)) {
1374 return c;
1375 }
1376 }
1377 }
1378
1379 return CompanyID::Begin();
1380}
1381
1382static std::vector<FaceSpec> _faces;
1383
1388{
1389 _faces.clear();
1390 _faces.assign(std::begin(_original_faces), std::end(_original_faces));
1391}
1392
1398{
1399 return static_cast<uint>(std::size(_faces));
1400}
1401
1407const FaceSpec *GetCompanyManagerFaceSpec(uint style_index)
1408{
1409 if (style_index < GetNumCompanyManagerFaceStyles()) return &_faces[style_index];
1410 return nullptr;
1411}
1412
1418std::optional<uint> FindCompanyManagerFaceLabel(std::string_view label)
1419{
1420 auto it = std::ranges::find(_faces, label, &FaceSpec::label);
1421 if (it == std::end(_faces)) return std::nullopt;
1422
1423 return static_cast<uint>(std::distance(std::begin(_faces), it));
1424}
1425
1431FaceVars GetCompanyManagerFaceVars(uint style)
1432{
1433 const FaceSpec *spec = GetCompanyManagerFaceSpec(style);
1434 if (spec == nullptr) return {};
1435 return spec->GetFaceVars();
1436}
1437
1445{
1446 const FaceSpec *spec = GetCompanyManagerFaceSpec(style);
1447 assert(spec != nullptr);
1448
1449 cmf.style = style;
1450 cmf.style_label = spec->label;
1451}
1452
1464
1472uint32_t MaskCompanyManagerFaceBits(const CompanyManagerFace &cmf, FaceVars vars)
1473{
1474 CompanyManagerFace face{};
1475
1476 for (auto var : SetBitIterator(GetActiveFaceVars(cmf, vars))) {
1477 vars[var].SetBits(face, vars[var].GetBits(cmf));
1478 }
1479
1480 return face.bits;
1481}
1482
1489{
1490 uint32_t masked_face_bits = MaskCompanyManagerFaceBits(cmf, GetCompanyManagerFaceVars(cmf.style));
1491 return fmt::format("{}:{}", cmf.style_label, masked_face_bits);
1492}
1493
1499std::optional<CompanyManagerFace> ParseCompanyManagerFaceCode(std::string_view str)
1500{
1501 if (str.empty()) return std::nullopt;
1502
1504 StringConsumer consumer{str};
1505 if (consumer.FindChar(':') != StringConsumer::npos) {
1506 auto label = consumer.ReadUntilChar(':', StringConsumer::SKIP_ONE_SEPARATOR);
1507
1508 /* Read numeric part and ensure it's valid. */
1509 auto bits = consumer.TryReadIntegerBase<uint32_t>(10, true);
1510 if (!bits.has_value() || consumer.AnyBytesLeft()) return std::nullopt;
1511
1512 /* Ensure style label is valid. */
1513 auto style = FindCompanyManagerFaceLabel(label);
1514 if (!style.has_value()) return std::nullopt;
1515
1516 SetCompanyManagerFaceStyle(cmf, *style);
1517 cmf.bits = *bits;
1518 } else {
1519 /* No ':' included, treat as numeric-only. This allows old-style codes to be entered. */
1520 auto bits = ParseInteger(str, 10, true);
1521 if (!bits.has_value()) return std::nullopt;
1522
1523 /* Old codes use bits 0..1 to represent face style. These map directly to the default face styles. */
1524 SetCompanyManagerFaceStyle(cmf, GB(*bits, 0, 2));
1525 cmf.bits = *bits;
1526 }
1527
1528 /* Force the face bits to be valid. */
1529 FaceVars vars = GetCompanyManagerFaceVars(cmf.style);
1531 cmf.bits = MaskCompanyManagerFaceBits(cmf, vars);
1532
1533 return cmf;
1534}
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.
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:240
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:103
static void NewEvent(CompanyID company, ScriptEvent *event)
Queue a new event for an AI.
Definition ai_core.cpp:221
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 & 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.
void SetErrorOwner(Owner owner)
Set the 'owner' (the originator) of this error message.
Container for an encoded string, created by GetEncodedString.
Enum-as-bit-set wrapper.
static void NewEvent(class ScriptEvent *event)
Queue a new event for the game script.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
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::optional< T > TryReadIntegerBase(int base, bool clamp=false)
Try to read and parse an integer in number 'base', and then advance the reader.
std::string_view ReadUntilChar(char c, SeparatorUsage sep)
Read data until the first occurrence of 8-bit char 'c', and advance reader.
size_type FindChar(char c) const
Find first occurrence of 8-bit char 'c'.
@ SKIP_ONE_SEPARATOR
Read and discard one separator, do not include it in the result.
bool AnyBytesLeft() const noexcept
Check whether any bytes left to read.
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
static Year year
Current year, starting at 0.
static Year year
Current year, starting at 0.
@ CompetitorTimeout
Considering starting a new competitor/AI.
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.
uint _cur_company_tick_index
used to generate a name for one company that doesn't have a name yet per tick
void ClearEnginesHiddenFlagOfCompany(CompanyID cid)
Clear the 'hidden' flag for all engines of a new company.
Definition engine.cpp:1032
void UpdateObjectColours(const Company *c)
Updates the colour of the object whenever a company changes.
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 const IntervalTimer< TimerGameEconomy > _economy_companies_yearly({TimerGameEconomy::Trigger::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...
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.
std::array< StringParameter, 2 > GetParamsForOwnedBy(Owner owner, TileIndex tile)
Get the right StringParameters for STR_ERROR_OWNED_BY.
FaceVars GetCompanyManagerFaceVars(uint style)
Get the face variables for a face style.
TimeoutTimer< TimerGameTick > _new_competitor_timeout({ TimerGameTick::Priority::CompetitorTimeout, 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< Commands::CompanyControl >::Post(CompanyCtrlAction::NewAI, CompanyID::Invalid(), CompanyRemoveReason::None, INVALID_CLIENT_ID);})
Start a new competitor company if possible.
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.
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.
static const std::initializer_list< Colours > _similar_colour[to_underlying(Colours::End)]
Similar colours, so we can try to prevent same coloured companies.
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.
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.
static void SubtractMoneyFromCompany(Company *c, const CommandCost &cost)
Deduct costs of a command from the money of a company.
CompanyID GetFirstPlayableCompanyID()
Get the index of the first available company.
static CompanyMask _dirty_company_finances
Bitmask of company finances that should be marked dirty.
TextColour GetDrawStringCompanyColour(CompanyID company)
Get the colour for DrawString-subroutines which matches the colour of the company.
CommandCost CmdSetCompanyManagerFace(DoCommandFlags flags, uint style, uint32_t bits)
Change the company manager's face.
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.
static const EnumIndexArray< uint8_t, Colours, Colours::End > _colour_sort
Sorting weights for the company colours.
CommandCost CmdRenamePresident(DoCommandFlags flags, const std::string &text)
Change the name of the president.
CompanyPool _company_pool("Company")
Pool of companies.
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.
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.
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:1238
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 Commands::CompanyControl.
@ New
Create a new company.
@ NewAI
Create a new AI company.
@ Delete
Delete a company.
static constexpr CompanyID COMPANY_SPECTATOR
The client is spectating.
static constexpr Owner OWNER_END
Last + 1 owner.
CompanyAllowListCtrlAction
The action to do with Commands::CompanyAllowListControl.
@ RemoveKey
Remove a public key.
@ AddKey
Create a public key.
@ AllowListed
Allow only listed keys to join the company.
@ AllowAny
Allow joining the company without a 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.
@ None
Dummy reason for actions that don't need one.
@ End
Sentinel for end.
@ 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.
@ WID_C_PRESIDENT_NAME
Button to change president name.
@ WID_C_COMPANY_NAME
Button to change company name.
static const uint NETWORK_PUBLIC_KEY_LENGTH
The maximum length of the hexadecimal encoded public keys, in bytes including '\0'.
Definition config.h:99
@ LoanInterest
Interest payments over the loan.
@ TrainRun
Running costs trains.
@ AircraftRevenue
Revenue from aircraft.
@ Invalid
Invalid expense type.
@ Property
Property costs.
@ Other
Other expenses.
@ RoadVehRevenue
Revenue from road vehicles.
@ AircraftRun
Running costs aircraft.
@ RoadVehRun
Running costs road vehicles.
@ ShipRevenue
Revenue from ships.
@ TrainRevenue
Revenue from trains.
@ ShipRun
Running costs ships.
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!
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:21
EnumClassIndexContainer< std::array< T, to_underlying(N)>, Index > EnumIndexArray
A typedef for EnumClassIndexContainer using std::array as the backing container type.
Base functions for all Games.
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:1038
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
Colours
One of 16 base colours used for companies and windows/widgets.
Definition gfx_type.h:283
@ Begin
Begin marker.
Definition gfx_type.h:284
@ White
White.
Definition gfx_type.h:300
@ PaleGreen
Pale green.
Definition gfx_type.h:286
@ Mauve
Mauve.
Definition gfx_type.h:295
@ Invalid
Invalid marker.
Definition gfx_type.h:302
@ LightBlue
Light blue.
Definition gfx_type.h:290
@ Yellow
Yellow.
Definition gfx_type.h:288
@ End
End-of-array marker.
Definition gfx_type.h:301
@ DarkBlue
Dark blue.
Definition gfx_type.h:285
@ Orange
Orange.
Definition gfx_type.h:297
@ Blue
Blue.
Definition gfx_type.h:293
@ Purple
Purple.
Definition gfx_type.h:296
@ Grey
Grey.
Definition gfx_type.h:299
@ Green
Green.
Definition gfx_type.h:291
@ Cream
Cream.
Definition gfx_type.h:294
@ Brown
Brown.
Definition gfx_type.h:298
@ DarkGreen
Dark green.
Definition gfx_type.h:292
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition gfx_type.h:307
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:1554
LiveryScheme
List of different livery schemes.
Definition livery.h:22
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
void NetworkTextMessage(NetworkAction action, TextColour colour, bool self_send, std::string_view name, std::string_view str, StringParameter &&data)
Writes a text-message to the console and the chat box.
Definition network.cpp:244
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.
@ GiveMoney
A company was given money.
@ 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:919
@ CompanyInfo
Company info (new companies, bankruptcy messages).
Definition news_type.h:34
@ Company
Company news item. (Newspaper with face).
Definition news_type.h:82
PixelColour GetColourGradient(Colours colour, Shade shade)
Get colour gradient palette index.
Definition palette.cpp:393
@ Normal
Normal colour shade.
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:137
Rail specific functions.
void SetDefaultRailGui()
Set the initial (default) railtype to use.
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:210
RoadTypes GetMaskForRoadTramType(RoadTramType rtt)
Get the mask for road types of the given RoadTramType.
Definition road.h:183
RoadType
The different roadtypes we support.
Definition road_type.h:23
RoadTramType
The different types of road type.
Definition road_type.h:37
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:88
@ SND_00_GOOD_YEAR
39 == 0x27 New year: performance improved
Definition sound_type.h:87
static PaletteID GetColourPalette(Colours colour)
Get recolour palette for a colour.
Definition sprite.h:221
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:351
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.
Money income
The amount of income.
Money expenses
The amount of expenses.
uint32_t GetRoadTramTotal(RoadTramType rtt) const
Get total sum of all owned road bits.
std::array< uint32_t, ROADTYPE_END > road
Count of company owned track bits for each road type.
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:169
Colours colour
The colour related to the company.
Definition news_type.h:170
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:165
std::string company_name
The name of the company.
Definition news_type.h:164
std::string other_company_name
The name of the company taking over this one.
Definition news_type.h:166
uint32_t clear_limit
Amount of tiles we can (still) clear (times 65536).
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.
bool allow_any
Set if anyone is allowed to join this company.
uint32_t build_object_limit
Amount of tiles we can (still) build objects on (times 65536). Also applies to buying land and placin...
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...
uint32_t terraform_limit
Amount of tileheights we can (still) terraform (times 65536).
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.
uint32_t tree_limit
Amount of trees we can (still) plant (times 65536).
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.
VehicleTypeIndexArray< GroupStatistics > group_all
NOSAVE: Statistics for the ALL_GROUP group.
static bool IsHumanID(auto index)
Is this company a company not controlled by a NoAI program?
RoadTypes avail_roadtypes
Road types available to this company.
~Company()
Close the associated company windows.
RailTypes avail_railtypes
Rail types available to this company.
static void PostDestructor(size_t index)
Invalidating some stuff after removing item from the pool.
Company(CompanyID index, StringID name_1={}, bool is_ai=false)
Constructor.
Group data.
Definition group.h:74
@ Primary
Primary colour is set.
Definition livery.h:82
@ Secondary
Secondary colour is set.
Definition livery.h:83
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).
static Pool::IterateWrapper< Company > Iterate(size_t from=0)
static T * CreateAtIndex(CompanyID index, Targs &&... args)
static Company * Get(auto index)
static bool CanAllocateItem(size_t n=1)
static T * Create(Targs &&... args)
static Company * GetIfValid(auto index)
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.
Town data structure.
Definition town.h:63
std::string name
Custom town name. If empty, the town was not renamed and uses the generated name.
Definition town.h:73
uint32_t townnameparts
Custom town name. If empty, the town was not renamed and uses the generated name.
Definition town.h:72
uint16_t townnametype
Custom town name. If empty, the town was not renamed and uses the generated name.
Definition town.h:71
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
Vehicle data structure.
Data structure for an opened window.
Definition window_gui.h:274
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
Definition window.cpp:570
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
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
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.
@ Ship
Ship vehicle type.
@ Aircraft
Aircraft vehicle type.
@ Road
Road vehicle type.
@ Train
Train vehicle type.
void CloseConstructionWindows()
Close all windows that are used for construction of vehicle etc.
Definition window.cpp:3409
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:1209
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition window.cpp:3322
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition window.cpp:1166
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:3216
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3200
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition window.cpp:3340
Window functions not directly related to making/drawing windows.
@ WN_NETWORK_STATUS_WINDOW_JOIN
Network join status.
Definition window_type.h:45
@ 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:70
@ 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:64
@ WC_COMPANY
Company view; Window numbers:
@ WC_NETWORK_STATUS_WINDOW
Network status window; Window numbers:
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers: