2017-01-11 22:47:17 +01:00
|
|
|
/*****************************************************************************
|
2018-06-15 14:07:34 +02:00
|
|
|
* Copyright (c) 2014-2018 OpenRCT2 developers
|
2017-01-11 22:47:17 +01:00
|
|
|
*
|
2018-06-15 14:07:34 +02:00
|
|
|
* For a complete list of all authors, please refer to contributors.md
|
|
|
|
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
|
2017-01-11 22:47:17 +01:00
|
|
|
*
|
2018-06-15 14:07:34 +02:00
|
|
|
* OpenRCT2 is licensed under the GNU General Public License version 3.
|
2017-01-11 22:47:17 +01:00
|
|
|
*****************************************************************************/
|
|
|
|
|
2018-06-22 22:56:21 +02:00
|
|
|
#include "GameAction.h"
|
|
|
|
|
2017-09-27 23:07:26 +02:00
|
|
|
#include "../Context.h"
|
2018-12-06 06:34:27 +01:00
|
|
|
#include "../ReplayManager.h"
|
2017-01-11 22:47:17 +01:00
|
|
|
#include "../core/Guard.hpp"
|
2017-01-11 23:53:33 +01:00
|
|
|
#include "../core/Memory.hpp"
|
2017-03-23 20:49:19 +01:00
|
|
|
#include "../core/MemoryStream.h"
|
2018-01-25 20:47:57 +01:00
|
|
|
#include "../localisation/Localisation.h"
|
2017-01-11 23:53:33 +01:00
|
|
|
#include "../network/network.h"
|
2017-09-27 23:07:26 +02:00
|
|
|
#include "../platform/platform.h"
|
2018-03-13 13:14:02 +01:00
|
|
|
#include "../scenario/Scenario.h"
|
2017-12-31 21:40:00 +01:00
|
|
|
#include "../world/Park.h"
|
2018-06-22 22:56:21 +02:00
|
|
|
|
|
|
|
#include <algorithm>
|
2018-11-21 23:16:04 +01:00
|
|
|
#include <iterator>
|
2017-01-11 23:53:33 +01:00
|
|
|
|
2017-01-11 22:47:17 +01:00
|
|
|
GameActionResult::GameActionResult(GA_ERROR error, rct_string_id message)
|
|
|
|
{
|
|
|
|
Error = error;
|
|
|
|
ErrorMessage = message;
|
|
|
|
}
|
|
|
|
|
2017-10-09 16:50:49 +02:00
|
|
|
GameActionResult::GameActionResult(GA_ERROR error, rct_string_id title, rct_string_id message)
|
|
|
|
{
|
|
|
|
Error = error;
|
|
|
|
ErrorTitle = title;
|
|
|
|
ErrorMessage = message;
|
|
|
|
}
|
|
|
|
|
2018-06-22 22:56:21 +02:00
|
|
|
GameActionResult::GameActionResult(GA_ERROR error, rct_string_id title, rct_string_id message, uint8_t* args)
|
2017-10-09 16:50:49 +02:00
|
|
|
{
|
|
|
|
Error = error;
|
|
|
|
ErrorTitle = title;
|
|
|
|
ErrorMessage = message;
|
2018-02-01 13:52:39 +01:00
|
|
|
std::copy_n(args, ErrorMessageArgs.size(), ErrorMessageArgs.begin());
|
2017-10-09 16:50:49 +02:00
|
|
|
}
|
|
|
|
|
2017-01-11 22:47:17 +01:00
|
|
|
namespace GameActions
|
|
|
|
{
|
|
|
|
static GameActionFactory _actions[GAME_COMMAND_COUNT];
|
|
|
|
|
2018-06-20 17:28:51 +02:00
|
|
|
GameActionFactory Register(uint32_t id, GameActionFactory factory)
|
2017-01-11 22:47:17 +01:00
|
|
|
{
|
2018-11-21 23:16:04 +01:00
|
|
|
Guard::Assert(id < std::size(_actions));
|
2017-01-11 22:47:17 +01:00
|
|
|
Guard::ArgumentNotNull(factory);
|
|
|
|
|
|
|
|
_actions[id] = factory;
|
|
|
|
return factory;
|
|
|
|
}
|
|
|
|
|
2018-12-15 10:11:54 +01:00
|
|
|
bool IsValidId(uint32_t id)
|
|
|
|
{
|
|
|
|
if (id < std::size(_actions))
|
|
|
|
{
|
|
|
|
return _actions[id] != nullptr;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2017-07-17 21:27:21 +02:00
|
|
|
void Initialize()
|
|
|
|
{
|
|
|
|
static bool initialized = false;
|
|
|
|
if (initialized)
|
|
|
|
return;
|
|
|
|
|
|
|
|
Register();
|
|
|
|
|
|
|
|
initialized = true;
|
|
|
|
}
|
|
|
|
|
2018-06-20 17:28:51 +02:00
|
|
|
std::unique_ptr<GameAction> Create(uint32_t id)
|
2017-01-11 22:47:17 +01:00
|
|
|
{
|
2017-07-17 21:27:21 +02:00
|
|
|
Initialize();
|
|
|
|
|
2018-06-22 22:56:21 +02:00
|
|
|
GameAction* result = nullptr;
|
2018-11-21 23:16:04 +01:00
|
|
|
if (id < std::size(_actions))
|
2017-01-11 22:47:17 +01:00
|
|
|
{
|
|
|
|
GameActionFactory factory = _actions[id];
|
|
|
|
if (factory != nullptr)
|
|
|
|
{
|
|
|
|
result = factory();
|
|
|
|
}
|
|
|
|
}
|
2019-02-07 18:23:58 +01:00
|
|
|
#ifdef _DEBUG
|
2018-05-14 12:36:45 +02:00
|
|
|
Guard::ArgumentNotNull(result, "Attempting to create unregistered gameaction: %u", id);
|
2019-02-07 18:23:58 +01:00
|
|
|
#endif
|
2017-07-21 19:54:05 +02:00
|
|
|
return std::unique_ptr<GameAction>(result);
|
2017-01-11 22:47:17 +01:00
|
|
|
}
|
|
|
|
|
2018-12-28 20:31:07 +01:00
|
|
|
GameAction::Ptr Clone(const GameAction* action)
|
|
|
|
{
|
|
|
|
std::unique_ptr<GameAction> ga = GameActions::Create(action->GetType());
|
|
|
|
ga->SetCallback(action->GetCallback());
|
|
|
|
|
|
|
|
// Serialise action data into stream.
|
|
|
|
DataSerialiser dsOut(true);
|
|
|
|
action->Serialise(dsOut);
|
|
|
|
|
|
|
|
// Serialise into new action.
|
|
|
|
MemoryStream& stream = dsOut.GetStream();
|
|
|
|
stream.SetPosition(0);
|
|
|
|
|
|
|
|
DataSerialiser dsIn(false, stream);
|
|
|
|
ga->Serialise(dsIn);
|
|
|
|
|
|
|
|
return ga;
|
|
|
|
}
|
|
|
|
|
2018-06-20 17:28:51 +02:00
|
|
|
static bool CheckActionInPausedMode(uint32_t actionFlags)
|
2017-01-11 23:53:33 +01:00
|
|
|
{
|
2018-06-22 22:56:21 +02:00
|
|
|
if (gGamePaused == 0)
|
|
|
|
return true;
|
|
|
|
if (gCheatsBuildInPauseMode)
|
|
|
|
return true;
|
|
|
|
if (actionFlags & GA_FLAGS::ALLOW_WHILE_PAUSED)
|
|
|
|
return true;
|
2017-01-11 23:53:33 +01:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-06-22 22:56:21 +02:00
|
|
|
static bool CheckActionAffordability(const GameActionResult* result)
|
2017-01-11 23:53:33 +01:00
|
|
|
{
|
2018-06-22 22:56:21 +02:00
|
|
|
if (gParkFlags & PARK_FLAGS_NO_MONEY)
|
|
|
|
return true;
|
|
|
|
if (result->Cost <= 0)
|
|
|
|
return true;
|
|
|
|
if (result->Cost <= gCash)
|
|
|
|
return true;
|
2017-01-11 23:53:33 +01:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-06-22 22:56:21 +02:00
|
|
|
GameActionResult::Ptr Query(const GameAction* action)
|
2017-01-11 22:47:17 +01:00
|
|
|
{
|
|
|
|
Guard::ArgumentNotNull(action);
|
|
|
|
|
2018-06-20 17:28:51 +02:00
|
|
|
uint16_t actionFlags = action->GetActionFlags();
|
2017-01-11 23:53:33 +01:00
|
|
|
if (!CheckActionInPausedMode(actionFlags))
|
|
|
|
{
|
2017-07-20 19:28:56 +02:00
|
|
|
GameActionResult::Ptr result = std::make_unique<GameActionResult>();
|
|
|
|
|
|
|
|
result->Error = GA_ERROR::GAME_PAUSED;
|
2018-08-04 14:30:13 +02:00
|
|
|
result->ErrorTitle = STR_RIDE_CONSTRUCTION_CANT_CONSTRUCT_THIS_HERE;
|
2017-07-20 19:28:56 +02:00
|
|
|
result->ErrorMessage = STR_CONSTRUCTION_NOT_POSSIBLE_WHILE_GAME_IS_PAUSED;
|
|
|
|
|
|
|
|
return result;
|
2017-01-11 23:53:33 +01:00
|
|
|
}
|
2017-07-20 19:28:56 +02:00
|
|
|
|
|
|
|
auto result = action->Query();
|
2018-01-06 13:16:42 +01:00
|
|
|
|
|
|
|
gCommandPosition.x = result->Position.x;
|
|
|
|
gCommandPosition.y = result->Position.y;
|
|
|
|
gCommandPosition.z = result->Position.z;
|
|
|
|
|
2017-07-20 19:28:56 +02:00
|
|
|
if (result->Error == GA_ERROR::OK)
|
2017-01-11 23:53:33 +01:00
|
|
|
{
|
2017-07-20 19:28:56 +02:00
|
|
|
if (!CheckActionAffordability(result.get()))
|
2017-01-11 23:53:33 +01:00
|
|
|
{
|
2017-07-20 19:28:56 +02:00
|
|
|
result->Error = GA_ERROR::INSUFFICIENT_FUNDS;
|
|
|
|
result->ErrorMessage = STR_NOT_ENOUGH_CASH_REQUIRES;
|
2018-06-20 17:28:51 +02:00
|
|
|
set_format_arg_on(result->ErrorMessageArgs.data(), 0, uint32_t, result->Cost);
|
2017-01-11 23:53:33 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return result;
|
2017-01-11 22:47:17 +01:00
|
|
|
}
|
|
|
|
|
2018-11-20 06:04:42 +01:00
|
|
|
static const char* GetRealm()
|
|
|
|
{
|
|
|
|
if (network_get_mode() == NETWORK_MODE_CLIENT)
|
|
|
|
return "cl";
|
|
|
|
else if (network_get_mode() == NETWORK_MODE_SERVER)
|
|
|
|
return "sv";
|
2018-12-15 23:12:49 +01:00
|
|
|
return "sp";
|
2018-11-20 06:04:42 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
struct ActionLogContext_t
|
|
|
|
{
|
|
|
|
MemoryStream output;
|
|
|
|
};
|
|
|
|
|
|
|
|
static void LogActionBegin(ActionLogContext_t& ctx, const GameAction* action)
|
|
|
|
{
|
|
|
|
MemoryStream& output = ctx.output;
|
|
|
|
|
|
|
|
char temp[128] = {};
|
2018-12-15 23:12:49 +01:00
|
|
|
snprintf(temp, sizeof(temp), "[%s] GA: %s (%08X) (", GetRealm(), action->GetName(), action->GetType());
|
2018-11-20 06:04:42 +01:00
|
|
|
|
|
|
|
output.Write(temp, strlen(temp));
|
|
|
|
|
|
|
|
DataSerialiser ds(true, ctx.output, true); // Logging mode.
|
|
|
|
|
|
|
|
// Write all parameters into output as text.
|
|
|
|
action->Serialise(ds);
|
|
|
|
}
|
|
|
|
|
|
|
|
static void LogActionFinish(ActionLogContext_t& ctx, const GameAction* action, const GameActionResult::Ptr& result)
|
|
|
|
{
|
|
|
|
MemoryStream& output = ctx.output;
|
|
|
|
|
|
|
|
char temp[128] = {};
|
|
|
|
|
|
|
|
if (result->Error != GA_ERROR::OK)
|
|
|
|
{
|
|
|
|
snprintf(temp, sizeof(temp), ") Failed, %u", (uint32_t)result->Error);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
snprintf(temp, sizeof(temp), ") OK");
|
|
|
|
}
|
|
|
|
|
|
|
|
output.Write(temp, strlen(temp) + 1);
|
|
|
|
|
|
|
|
const char* text = (const char*)output.GetData();
|
2018-12-15 19:41:55 +01:00
|
|
|
log_verbose("%s", text);
|
|
|
|
|
2018-11-20 06:04:42 +01:00
|
|
|
network_append_server_log(text);
|
|
|
|
}
|
|
|
|
|
2018-06-22 22:56:21 +02:00
|
|
|
GameActionResult::Ptr Execute(const GameAction* action)
|
2017-01-11 22:47:17 +01:00
|
|
|
{
|
|
|
|
Guard::ArgumentNotNull(action);
|
|
|
|
|
2018-06-20 17:28:51 +02:00
|
|
|
uint16_t actionFlags = action->GetActionFlags();
|
|
|
|
uint32_t flags = action->GetFlags();
|
2017-07-15 11:24:08 +02:00
|
|
|
|
2018-12-06 08:48:00 +01:00
|
|
|
auto* replayManager = OpenRCT2::GetContext()->GetReplayManager();
|
2018-12-11 08:13:47 +01:00
|
|
|
if (replayManager != nullptr && (replayManager->IsReplaying() || replayManager->IsNormalising()))
|
2018-12-06 08:48:00 +01:00
|
|
|
{
|
|
|
|
// We only accept replay commands as long the replay is active.
|
|
|
|
if ((flags & GAME_COMMAND_FLAG_REPLAY) == 0)
|
|
|
|
{
|
|
|
|
// TODO: Introduce proper error.
|
|
|
|
GameActionResult::Ptr result = std::make_unique<GameActionResult>();
|
|
|
|
|
|
|
|
result->Error = GA_ERROR::GAME_PAUSED;
|
|
|
|
result->ErrorTitle = STR_RIDE_CONSTRUCTION_CANT_CONSTRUCT_THIS_HERE;
|
|
|
|
result->ErrorMessage = STR_CONSTRUCTION_NOT_POSSIBLE_WHILE_GAME_IS_PAUSED;
|
|
|
|
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-07-20 19:28:56 +02:00
|
|
|
GameActionResult::Ptr result = Query(action);
|
|
|
|
if (result->Error == GA_ERROR::OK)
|
2017-01-11 22:47:17 +01:00
|
|
|
{
|
2017-03-21 20:05:53 +01:00
|
|
|
// Networked games send actions to the server to be run
|
2017-07-15 11:24:08 +02:00
|
|
|
if (network_get_mode() == NETWORK_MODE_CLIENT)
|
2017-03-21 20:05:53 +01:00
|
|
|
{
|
2017-07-15 11:24:08 +02:00
|
|
|
// As a client we have to wait or send it first.
|
2017-09-04 21:37:58 +02:00
|
|
|
if (!(actionFlags & GA_FLAGS::CLIENT_ONLY) && !(flags & GAME_COMMAND_FLAG_NETWORKED))
|
2017-03-21 20:05:53 +01:00
|
|
|
{
|
2018-12-15 23:12:49 +01:00
|
|
|
log_verbose("[%s] GameAction::Execute %s (Out)", GetRealm(), action->GetName());
|
2017-07-15 11:24:08 +02:00
|
|
|
network_send_game_action(action);
|
|
|
|
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else if (network_get_mode() == NETWORK_MODE_SERVER)
|
|
|
|
{
|
|
|
|
// If player is the server it would execute right away as where clients execute the commands
|
|
|
|
// at the beginning of the frame, so we have to put them into the queue.
|
2017-09-04 21:37:58 +02:00
|
|
|
if (!(actionFlags & GA_FLAGS::CLIENT_ONLY) && !(flags & GAME_COMMAND_FLAG_NETWORKED))
|
2017-07-15 11:24:08 +02:00
|
|
|
{
|
2018-12-15 23:12:49 +01:00
|
|
|
log_verbose("[%s] GameAction::Execute %s (Queue)", GetRealm(), action->GetName());
|
2017-07-15 11:24:08 +02:00
|
|
|
network_enqueue_game_action(action);
|
|
|
|
|
|
|
|
return result;
|
2017-03-21 20:05:53 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-11-20 06:04:42 +01:00
|
|
|
ActionLogContext_t logContext;
|
|
|
|
LogActionBegin(logContext, action);
|
2017-07-17 21:27:21 +02:00
|
|
|
|
2017-01-11 23:53:33 +01:00
|
|
|
// Execute the action, changing the game state
|
2017-07-15 11:24:08 +02:00
|
|
|
result = action->Execute();
|
2017-01-11 23:53:33 +01:00
|
|
|
|
2018-11-20 06:04:42 +01:00
|
|
|
LogActionFinish(logContext, action, result);
|
|
|
|
|
2018-01-06 13:16:42 +01:00
|
|
|
gCommandPosition.x = result->Position.x;
|
|
|
|
gCommandPosition.y = result->Position.y;
|
|
|
|
gCommandPosition.z = result->Position.z;
|
|
|
|
|
2017-01-11 23:53:33 +01:00
|
|
|
// Update money balance
|
2018-06-22 22:56:21 +02:00
|
|
|
if (!(gParkFlags & PARK_FLAGS_NO_MONEY) && !(flags & GAME_COMMAND_FLAG_GHOST) && !(flags & GAME_COMMAND_FLAG_5)
|
|
|
|
&& result->Cost != 0)
|
2017-01-11 23:53:33 +01:00
|
|
|
{
|
2017-07-20 19:28:56 +02:00
|
|
|
finance_payment(result->Cost, result->ExpenditureType);
|
|
|
|
money_effect_create(result->Cost);
|
2017-01-11 23:53:33 +01:00
|
|
|
}
|
|
|
|
|
2018-12-06 06:34:27 +01:00
|
|
|
if (!(actionFlags & GA_FLAGS::CLIENT_ONLY) && result->Error == GA_ERROR::OK)
|
2017-01-11 23:53:33 +01:00
|
|
|
{
|
2018-12-06 06:34:27 +01:00
|
|
|
if (network_get_mode() == NETWORK_MODE_SERVER)
|
2017-01-11 23:53:33 +01:00
|
|
|
{
|
2018-11-20 06:04:42 +01:00
|
|
|
NetworkPlayerId_t playerId = action->GetPlayer();
|
2017-07-15 11:24:08 +02:00
|
|
|
|
2018-12-05 07:39:57 +01:00
|
|
|
int32_t playerIndex = network_get_player_index(playerId.id);
|
|
|
|
Guard::Assert(playerIndex != -1);
|
|
|
|
|
|
|
|
network_set_player_last_action(playerIndex, action->GetType());
|
2017-09-30 23:57:38 +02:00
|
|
|
if (result->Cost != 0)
|
|
|
|
{
|
2018-12-05 07:39:57 +01:00
|
|
|
network_add_player_money_spent(playerIndex, result->Cost);
|
2017-09-30 23:57:38 +02:00
|
|
|
}
|
2017-01-11 23:53:33 +01:00
|
|
|
}
|
2018-12-06 06:34:27 +01:00
|
|
|
else if (network_get_mode() == NETWORK_MODE_NONE)
|
|
|
|
{
|
2018-12-15 11:00:59 +01:00
|
|
|
bool commandExecutes = (flags & GAME_COMMAND_FLAG_GHOST) == 0 && (flags & GAME_COMMAND_FLAG_5) == 0;
|
|
|
|
|
2018-12-11 08:13:47 +01:00
|
|
|
bool recordAction = false;
|
|
|
|
if (replayManager)
|
|
|
|
{
|
2018-12-15 11:00:59 +01:00
|
|
|
if (replayManager->IsRecording() && commandExecutes)
|
2018-12-11 08:13:47 +01:00
|
|
|
recordAction = true;
|
|
|
|
else if (replayManager->IsNormalising() && (flags & GAME_COMMAND_FLAG_REPLAY) != 0)
|
|
|
|
recordAction = true; // In normalisation we only feed back actions issued by the replay manager.
|
|
|
|
}
|
|
|
|
if (recordAction)
|
2018-12-06 06:34:27 +01:00
|
|
|
{
|
|
|
|
replayManager->AddGameAction(gCurrentTicks, action);
|
|
|
|
}
|
|
|
|
}
|
2017-01-11 23:53:33 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Allow autosave to commence
|
|
|
|
if (gLastAutoSaveUpdate == AUTOSAVE_PAUSE)
|
|
|
|
{
|
2017-07-14 08:02:56 +02:00
|
|
|
gLastAutoSaveUpdate = platform_get_ticks();
|
2017-01-11 23:53:33 +01:00
|
|
|
}
|
2017-01-11 22:47:17 +01:00
|
|
|
}
|
2017-01-11 23:53:33 +01:00
|
|
|
|
|
|
|
// Call callback for asynchronous events
|
2017-07-21 20:44:44 +02:00
|
|
|
auto cb = action->GetCallback();
|
|
|
|
if (cb != nullptr)
|
2017-01-11 22:47:17 +01:00
|
|
|
{
|
2017-07-21 20:44:44 +02:00
|
|
|
cb(action, result.get());
|
2017-01-11 22:47:17 +01:00
|
|
|
}
|
2017-01-11 23:53:33 +01:00
|
|
|
|
2018-06-22 22:56:21 +02:00
|
|
|
if (result->Error != GA_ERROR::OK && !(flags & GAME_COMMAND_FLAG_GHOST) && !(flags & GAME_COMMAND_FLAG_5))
|
2017-01-11 23:53:33 +01:00
|
|
|
{
|
|
|
|
// Show the error box
|
2018-02-01 13:52:39 +01:00
|
|
|
std::copy(result->ErrorMessageArgs.begin(), result->ErrorMessageArgs.end(), gCommonFormatArgs);
|
2017-09-27 23:07:26 +02:00
|
|
|
context_show_error(result->ErrorTitle, result->ErrorMessage);
|
2017-01-11 23:53:33 +01:00
|
|
|
}
|
2017-03-25 18:05:18 +01:00
|
|
|
return result;
|
2017-01-11 22:47:17 +01:00
|
|
|
}
|
2018-11-20 06:04:42 +01:00
|
|
|
|
2018-05-04 22:40:09 +02:00
|
|
|
} // namespace GameActions
|