2009-08-21 22:21:05 +02:00
|
|
|
/*
|
|
|
|
* This file is part of OpenTTD.
|
|
|
|
* 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.
|
|
|
|
* 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.
|
|
|
|
* 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/>.
|
|
|
|
*/
|
|
|
|
|
2009-01-12 18:11:45 +01:00
|
|
|
/** @file ai_sl.cpp Handles the saveload part of the AIs */
|
2009-01-04 16:32:25 +01:00
|
|
|
|
|
|
|
#include "../stdafx.h"
|
2009-01-12 18:11:45 +01:00
|
|
|
#include "../debug.h"
|
2021-05-30 15:59:40 +02:00
|
|
|
|
2009-01-04 16:32:25 +01:00
|
|
|
#include "saveload.h"
|
2021-05-30 15:59:40 +02:00
|
|
|
#include "compat/ai_sl_compat.h"
|
|
|
|
|
|
|
|
#include "../company_base.h"
|
2009-01-12 18:11:45 +01:00
|
|
|
#include "../string_func.h"
|
2009-01-04 16:32:25 +01:00
|
|
|
|
2011-12-01 13:03:34 +01:00
|
|
|
#include "../ai/ai.hpp"
|
|
|
|
#include "../ai/ai_config.hpp"
|
|
|
|
#include "../network/network.h"
|
|
|
|
#include "../ai/ai_instance.hpp"
|
|
|
|
|
2014-04-23 22:13:33 +02:00
|
|
|
#include "../safeguards.h"
|
|
|
|
|
2021-04-29 19:04:27 +02:00
|
|
|
static std::string _ai_saveload_name;
|
|
|
|
static int _ai_saveload_version;
|
|
|
|
static std::string _ai_saveload_settings;
|
|
|
|
static bool _ai_saveload_is_random;
|
2009-01-04 16:32:25 +01:00
|
|
|
|
2021-05-30 15:59:40 +02:00
|
|
|
static const SaveLoad _ai_company_desc[] = {
|
2021-06-14 10:05:30 +02:00
|
|
|
SLEG_SSTR("name", _ai_saveload_name, SLE_STR),
|
|
|
|
SLEG_SSTR("settings", _ai_saveload_settings, SLE_STR),
|
|
|
|
SLEG_CONDVAR("version", _ai_saveload_version, SLE_UINT32, SLV_108, SL_MAX_VERSION),
|
2024-02-09 22:55:49 +01:00
|
|
|
SLEG_CONDVAR("is_random", _ai_saveload_is_random, SLE_BOOL, SLV_136, SLV_AI_LOCAL_CONFIG),
|
|
|
|
};
|
|
|
|
|
|
|
|
static const SaveLoad _ai_running_desc[] = {
|
|
|
|
SLEG_CONDSSTR("running_name", _ai_saveload_name, SLE_STR, SLV_AI_LOCAL_CONFIG, SL_MAX_VERSION),
|
|
|
|
SLEG_CONDSSTR("running_settings", _ai_saveload_settings, SLE_STR, SLV_AI_LOCAL_CONFIG, SL_MAX_VERSION),
|
|
|
|
SLEG_CONDVAR("running_version", _ai_saveload_version, SLE_UINT32, SLV_AI_LOCAL_CONFIG, SL_MAX_VERSION),
|
2009-01-04 16:32:25 +01:00
|
|
|
};
|
|
|
|
|
2009-01-12 18:11:45 +01:00
|
|
|
static void SaveReal_AIPL(int *index_ptr)
|
|
|
|
{
|
|
|
|
CompanyID index = (CompanyID)*index_ptr;
|
2024-02-09 22:55:49 +01:00
|
|
|
AIConfig *config = AIConfig::GetConfig(index, AIConfig::SSS_FORCE_GAME);
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2011-11-30 00:26:35 +01:00
|
|
|
if (config->HasScript()) {
|
2021-04-29 19:04:27 +02:00
|
|
|
_ai_saveload_name = config->GetName();
|
2009-01-23 22:52:29 +01:00
|
|
|
_ai_saveload_version = config->GetVersion();
|
|
|
|
} else {
|
|
|
|
/* No AI is configured for this so store an empty string as name. */
|
2021-04-29 19:04:27 +02:00
|
|
|
_ai_saveload_name.clear();
|
2009-01-23 22:52:29 +01:00
|
|
|
_ai_saveload_version = -1;
|
|
|
|
}
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2021-04-29 19:04:27 +02:00
|
|
|
_ai_saveload_settings = config->SettingsToString();
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2021-05-30 15:59:40 +02:00
|
|
|
SlObject(nullptr, _ai_company_desc);
|
2024-02-09 22:55:49 +01:00
|
|
|
|
|
|
|
if (!Company::IsValidAiID(index)) return;
|
|
|
|
|
2021-05-09 19:02:17 +02:00
|
|
|
/* If the AI was active, store its data too */
|
2024-02-09 22:55:49 +01:00
|
|
|
config = AIConfig::GetConfig(index);
|
|
|
|
_ai_saveload_name = config->GetName();
|
|
|
|
_ai_saveload_version = config->GetVersion();
|
|
|
|
_ai_saveload_settings = config->SettingsToString();
|
|
|
|
|
|
|
|
SlObject(nullptr, _ai_running_desc);
|
|
|
|
AI::Save(index);
|
|
|
|
|
2009-01-12 18:11:45 +01:00
|
|
|
}
|
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
struct AIPLChunkHandler : ChunkHandler {
|
|
|
|
AIPLChunkHandler() : ChunkHandler('AIPL', CH_TABLE) {}
|
2021-05-30 15:59:40 +02:00
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
void Load() const override
|
|
|
|
{
|
|
|
|
const std::vector<SaveLoad> slt = SlCompatTableHeader(_ai_company_desc, _ai_company_sl_compat);
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
/* Free all current data */
|
|
|
|
for (CompanyID c = COMPANY_FIRST; c < MAX_COMPANIES; c++) {
|
2023-05-05 21:59:50 +02:00
|
|
|
AIConfig::GetConfig(c, AIConfig::SSS_FORCE_GAME)->Change(std::nullopt);
|
2021-06-07 23:24:37 +02:00
|
|
|
}
|
2011-08-25 18:37:27 +02:00
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
CompanyID index;
|
|
|
|
while ((index = (CompanyID)SlIterateArray()) != (CompanyID)-1) {
|
|
|
|
if (index >= MAX_COMPANIES) SlErrorCorrupt("Too many AI configs");
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
_ai_saveload_is_random = false;
|
|
|
|
_ai_saveload_version = -1;
|
|
|
|
SlObject(nullptr, slt);
|
|
|
|
|
2022-12-15 21:43:07 +01:00
|
|
|
if (_game_mode == GM_MENU || (_networking && !_network_server)) {
|
2024-02-09 22:55:49 +01:00
|
|
|
if (Company::IsValidAiID(index)) {
|
|
|
|
SlObject(nullptr, _ai_running_desc);
|
|
|
|
AIInstance::LoadEmpty();
|
|
|
|
}
|
2021-06-07 23:24:37 +02:00
|
|
|
continue;
|
|
|
|
}
|
2009-02-20 00:10:32 +01:00
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
AIConfig *config = AIConfig::GetConfig(index, AIConfig::SSS_FORCE_GAME);
|
2024-02-09 22:55:49 +01:00
|
|
|
if (_ai_saveload_name.empty() || _ai_saveload_is_random) {
|
2021-06-07 23:24:37 +02:00
|
|
|
/* A random AI. */
|
2024-02-09 22:55:49 +01:00
|
|
|
config->Change(std::nullopt, -1, false);
|
2021-06-07 23:24:37 +02:00
|
|
|
} else {
|
2024-02-09 22:55:49 +01:00
|
|
|
config->Change(_ai_saveload_name, _ai_saveload_version, false);
|
2011-11-30 00:26:35 +01:00
|
|
|
if (!config->HasScript()) {
|
2024-02-09 22:55:49 +01:00
|
|
|
/* No version of the AI available. Try to configure the
|
2021-06-07 23:24:37 +02:00
|
|
|
* latest version of the AI instead. */
|
2024-02-09 22:55:49 +01:00
|
|
|
config->Change(_ai_saveload_name, -1, false);
|
2021-06-07 23:24:37 +02:00
|
|
|
if (!config->HasScript()) {
|
|
|
|
if (_ai_saveload_name.compare("%_dummy") != 0) {
|
|
|
|
Debug(script, 0, "The savegame has an AI by the name '{}', version {} which is no longer available.", _ai_saveload_name, _ai_saveload_version);
|
2024-02-09 22:55:49 +01:00
|
|
|
Debug(script, 0, "Configuration switched to Random AI.");
|
2021-06-07 23:24:37 +02:00
|
|
|
}
|
2009-06-25 01:34:30 +02:00
|
|
|
} else {
|
2021-06-07 23:24:37 +02:00
|
|
|
Debug(script, 0, "The savegame has an AI by the name '{}', version {} which is no longer available.", _ai_saveload_name, _ai_saveload_version);
|
2024-02-09 22:55:49 +01:00
|
|
|
Debug(script, 0, "The latest version of that AI has been configured instead");
|
2009-06-25 01:34:30 +02:00
|
|
|
}
|
2009-01-23 22:52:29 +01:00
|
|
|
}
|
2009-01-12 18:11:45 +01:00
|
|
|
}
|
2021-06-07 23:24:37 +02:00
|
|
|
config->StringToSettings(_ai_saveload_settings);
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2024-02-09 22:55:49 +01:00
|
|
|
if (!Company::IsValidAiID(index)) continue;
|
|
|
|
|
2022-12-28 05:02:26 +01:00
|
|
|
/* Load the AI saved data */
|
2024-02-09 22:55:49 +01:00
|
|
|
SlObject(nullptr, _ai_running_desc);
|
|
|
|
|
|
|
|
Company::Get(index)->ai_config = std::make_unique<AIConfig>();
|
|
|
|
config = Company::Get(index)->ai_config.get();
|
|
|
|
config->Change(_ai_saveload_name, _ai_saveload_version, false);
|
|
|
|
if (!config->HasScript()) {
|
|
|
|
/* No version of the AI available that can load the data. Try to load the
|
|
|
|
* latest version of the AI instead. */
|
|
|
|
config->Change(_ai_saveload_name, -1, false);
|
|
|
|
if (!config->HasScript()) {
|
|
|
|
if (_ai_saveload_name.compare("%_dummy") != 0) {
|
|
|
|
Debug(script, 0, "The savegame has an AI by the name '{}', version {} which is no longer available.", _ai_saveload_name, _ai_saveload_version);
|
|
|
|
Debug(script, 0, "A random other AI will be loaded in its place.");
|
|
|
|
} else {
|
|
|
|
Debug(script, 0, "The savegame had no AIs available at the time of saving.");
|
|
|
|
Debug(script, 0, "A random available AI will be loaded now.");
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
Debug(script, 0, "The savegame has an AI by the name '{}', version {} which is no longer available.", _ai_saveload_name, _ai_saveload_version);
|
|
|
|
Debug(script, 0, "The latest version of that AI has been loaded instead, but it'll not get the savegame data as it's incompatible.");
|
|
|
|
}
|
|
|
|
/* Make sure the AI doesn't get the saveload data, as it was not the
|
|
|
|
* writer of the saveload data in the first place */
|
|
|
|
_ai_saveload_version = -1;
|
|
|
|
}
|
|
|
|
config->StringToSettings(_ai_saveload_settings);
|
|
|
|
config->SetToLoadData(AIInstance::Load(_ai_saveload_version));
|
2009-01-12 18:11:45 +01:00
|
|
|
}
|
|
|
|
}
|
2009-01-04 16:32:25 +01:00
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
void Save() const override
|
|
|
|
{
|
|
|
|
SlTableHeader(_ai_company_desc);
|
2021-05-30 15:59:40 +02:00
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
for (int i = COMPANY_FIRST; i < MAX_COMPANIES; i++) {
|
|
|
|
SlSetArrayIndex(i);
|
|
|
|
SlAutolength((AutolengthProc *)SaveReal_AIPL, &i);
|
|
|
|
}
|
2009-01-04 16:32:25 +01:00
|
|
|
}
|
2021-06-07 23:24:37 +02:00
|
|
|
};
|
2009-01-12 18:11:45 +01:00
|
|
|
|
2021-06-07 23:24:37 +02:00
|
|
|
static const AIPLChunkHandler AIPL;
|
2021-06-09 16:23:35 +02:00
|
|
|
static const ChunkHandlerRef ai_chunk_handlers[] = {
|
|
|
|
AIPL,
|
2009-01-12 18:11:45 +01:00
|
|
|
};
|
2021-05-02 22:41:34 +02:00
|
|
|
|
|
|
|
extern const ChunkHandlerTable _ai_chunk_handlers(ai_chunk_handlers);
|