mirror of
https://github.com/OpenRCT2/OpenRCT2
synced 2026-01-30 10:15:36 +01:00
83b911b193
* Refactor to result GameActions::Result as copy instead of unique_ptr * Remove alias GameActions::Result::Ptr * Remove MakeResult wrapper * Remove type forwarder in TileInspector
100 lines
2.8 KiB
C++
100 lines
2.8 KiB
C++
/*****************************************************************************
|
|
* Copyright (c) 2014-2021 OpenRCT2 developers
|
|
*
|
|
* For a complete list of all authors, please refer to contributors.md
|
|
* Interested in contributing? Visit https://github.com/OpenRCT2/OpenRCT2
|
|
*
|
|
* OpenRCT2 is licensed under the GNU General Public License version 3.
|
|
*****************************************************************************/
|
|
#pragma once
|
|
|
|
#include "../localisation/StringIds.h"
|
|
#include "../management/Finance.h"
|
|
#include "../world/Location.hpp"
|
|
|
|
#include <any>
|
|
#include <array>
|
|
#include <cstdint>
|
|
#include <limits>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <type_traits>
|
|
#include <variant>
|
|
|
|
namespace GameActions
|
|
{
|
|
/**
|
|
* Common error codes for game actions.
|
|
*/
|
|
enum class Status : uint16_t
|
|
{
|
|
Ok,
|
|
InvalidParameters,
|
|
Disallowed,
|
|
GamePaused,
|
|
InsufficientFunds,
|
|
NotInEditorMode,
|
|
|
|
NotOwned,
|
|
TooLow,
|
|
TooHigh,
|
|
NoClearance,
|
|
ItemAlreadyPlaced,
|
|
|
|
NotClosed,
|
|
Broken,
|
|
|
|
NoFreeElements,
|
|
|
|
Unknown = std::numeric_limits<std::underlying_type_t<Status>>::max(),
|
|
};
|
|
|
|
#ifdef __WARN_SUGGEST_FINAL_METHODS__
|
|
# pragma GCC diagnostic push
|
|
# pragma GCC diagnostic ignored "-Wsuggest-final-methods"
|
|
# pragma GCC diagnostic ignored "-Wsuggest-final-types"
|
|
#endif
|
|
|
|
/**
|
|
* Represents the result of a game action query or execution.
|
|
*/
|
|
class Result final
|
|
{
|
|
public:
|
|
using StringVariant = std::variant<std::string, rct_string_id>;
|
|
|
|
GameActions::Status Error = GameActions::Status::Ok;
|
|
StringVariant ErrorTitle = STR_NONE;
|
|
StringVariant ErrorMessage = STR_NONE;
|
|
std::array<uint8_t, 32> ErrorMessageArgs{};
|
|
CoordsXYZ Position = { LOCATION_NULL, LOCATION_NULL, LOCATION_NULL };
|
|
money32 Cost = 0;
|
|
ExpenditureType Expenditure = ExpenditureType::Count;
|
|
std::any ResultData;
|
|
|
|
Result() = default;
|
|
Result(GameActions::Status error, rct_string_id title, rct_string_id message, uint8_t* args = nullptr);
|
|
|
|
std::string GetErrorTitle() const;
|
|
std::string GetErrorMessage() const;
|
|
|
|
// It is recommended to use strong types since a type alias such as 'using MyType = uint32_t'
|
|
// is still just uint32_t, this guarantees the data is associated with the correct type.
|
|
template<typename T> void SetData(const T&& data)
|
|
{
|
|
ResultData = std::forward<const T&&>(data);
|
|
}
|
|
|
|
// This function will throw std::bad_any_cast if the type mismatches.
|
|
template<typename T> T GetData() const
|
|
{
|
|
return std::any_cast<T>(ResultData);
|
|
}
|
|
};
|
|
|
|
#ifdef __WARN_SUGGEST_FINAL_METHODS__
|
|
# pragma GCC diagnostic pop
|
|
#endif
|
|
|
|
} // namespace GameActions
|