mirror of https://github.com/OpenRCT2/OpenRCT2.git
332 lines
12 KiB
C++
332 lines
12 KiB
C++
/*****************************************************************************
|
|
* Copyright (c) 2014-2024 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 warning(disable : 4706) // assignment within conditional expression
|
|
|
|
#include "SmallSceneryObject.h"
|
|
|
|
#include "../core/IStream.hpp"
|
|
#include "../core/Json.hpp"
|
|
#include "../core/Memory.hpp"
|
|
#include "../core/String.hpp"
|
|
#include "../drawing/Drawing.h"
|
|
#include "../interface/Cursors.h"
|
|
#include "../localisation/Language.h"
|
|
#include "../world/Scenery.h"
|
|
#include "SceneryBoundingBox.h"
|
|
|
|
void SmallSceneryObject::ReadLegacy(IReadObjectContext* context, OpenRCT2::IStream* stream)
|
|
{
|
|
stream->Seek(6, OpenRCT2::STREAM_SEEK_CURRENT);
|
|
_legacyType.flags = stream->ReadValue<uint32_t>();
|
|
_legacyType.height = stream->ReadValue<uint8_t>();
|
|
_legacyType.tool_id = static_cast<CursorID>(stream->ReadValue<uint8_t>());
|
|
_legacyType.price = stream->ReadValue<int16_t>() * 10;
|
|
_legacyType.removal_price = stream->ReadValue<int16_t>() * 10;
|
|
stream->Seek(4, OpenRCT2::STREAM_SEEK_CURRENT);
|
|
_legacyType.animation_delay = stream->ReadValue<uint16_t>();
|
|
_legacyType.animation_mask = stream->ReadValue<uint16_t>();
|
|
_legacyType.num_frames = stream->ReadValue<uint16_t>();
|
|
_legacyType.scenery_tab_id = OBJECT_ENTRY_INDEX_NULL;
|
|
SetBoundingBoxFromFlags();
|
|
|
|
GetStringTable().Read(context, stream, ObjectStringID::NAME);
|
|
|
|
RCTObjectEntry sgEntry = stream->ReadValue<RCTObjectEntry>();
|
|
SetPrimarySceneryGroup(ObjectEntryDescriptor(sgEntry));
|
|
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_HAS_FRAME_OFFSETS))
|
|
{
|
|
_frameOffsets = ReadFrameOffsets(stream);
|
|
}
|
|
// This crude method was used by RCT2. JSON objects have a flag for this property.
|
|
if (_legacyType.height > 64)
|
|
{
|
|
_legacyType.flags |= SMALL_SCENERY_FLAG_IS_TREE;
|
|
}
|
|
|
|
GetImageTable().Read(context, stream);
|
|
|
|
// Validate properties
|
|
if (_legacyType.price <= 0.00_GBP)
|
|
{
|
|
context->LogError(ObjectError::InvalidProperty, "Price can not be free or negative.");
|
|
}
|
|
if (_legacyType.removal_price <= 0.00_GBP)
|
|
{
|
|
// Make sure you don't make a profit when placing then removing.
|
|
const auto reimbursement = _legacyType.removal_price;
|
|
if (reimbursement > _legacyType.price)
|
|
{
|
|
context->LogError(ObjectError::InvalidProperty, "Sell price can not be more than buy price.");
|
|
}
|
|
}
|
|
}
|
|
|
|
void SmallSceneryObject::Load()
|
|
{
|
|
GetStringTable().Sort();
|
|
_legacyType.name = LanguageAllocateObjectString(GetName());
|
|
_legacyType.image = LoadImages();
|
|
|
|
_legacyType.scenery_tab_id = OBJECT_ENTRY_INDEX_NULL;
|
|
_legacyType.FrameOffsetCount = 0;
|
|
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_HAS_FRAME_OFFSETS))
|
|
{
|
|
_legacyType.frame_offsets = _frameOffsets.data();
|
|
_legacyType.FrameOffsetCount = static_cast<uint16_t>(_frameOffsets.size());
|
|
}
|
|
|
|
PerformFixes();
|
|
}
|
|
|
|
void SmallSceneryObject::Unload()
|
|
{
|
|
LanguageFreeObjectString(_legacyType.name);
|
|
UnloadImages();
|
|
|
|
_legacyType.name = 0;
|
|
_legacyType.image = 0;
|
|
}
|
|
|
|
void SmallSceneryObject::DrawPreview(DrawPixelInfo& dpi, int32_t width, int32_t height) const
|
|
{
|
|
auto imageId = ImageId(_legacyType.image);
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_HAS_PRIMARY_COLOUR))
|
|
{
|
|
imageId = imageId.WithPrimary(COLOUR_BORDEAUX_RED);
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_HAS_SECONDARY_COLOUR))
|
|
{
|
|
imageId = imageId.WithSecondary(COLOUR_YELLOW);
|
|
}
|
|
}
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_HAS_TERTIARY_COLOUR))
|
|
{
|
|
imageId = imageId.WithSecondary(COLOUR_DARK_BROWN);
|
|
}
|
|
|
|
auto screenCoords = ScreenCoordsXY{ width / 2, (height / 2) + (_legacyType.height / 2) };
|
|
screenCoords.y = std::min(screenCoords.y, height - 16);
|
|
|
|
if ((_legacyType.HasFlag(SMALL_SCENERY_FLAG_FULL_TILE)) && (_legacyType.HasFlag(SMALL_SCENERY_FLAG_VOFFSET_CENTRE)))
|
|
{
|
|
screenCoords.y -= 12;
|
|
}
|
|
|
|
GfxDrawSprite(dpi, imageId, screenCoords);
|
|
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_HAS_GLASS))
|
|
{
|
|
imageId = ImageId(_legacyType.image + 4).WithTransparency(COLOUR_BORDEAUX_RED);
|
|
GfxDrawSprite(dpi, imageId, screenCoords);
|
|
}
|
|
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_ANIMATED_FG))
|
|
{
|
|
imageId = ImageId(_legacyType.image + 4);
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_HAS_SECONDARY_COLOUR))
|
|
{
|
|
imageId = imageId.WithSecondary(COLOUR_YELLOW);
|
|
}
|
|
GfxDrawSprite(dpi, imageId, screenCoords);
|
|
}
|
|
}
|
|
|
|
std::vector<uint8_t> SmallSceneryObject::ReadFrameOffsets(OpenRCT2::IStream* stream)
|
|
{
|
|
uint8_t frameOffset;
|
|
auto data = std::vector<uint8_t>();
|
|
data.push_back(stream->ReadValue<uint8_t>());
|
|
while ((frameOffset = stream->ReadValue<uint8_t>()) != 0xFF)
|
|
{
|
|
data.push_back(frameOffset);
|
|
}
|
|
data.push_back(frameOffset);
|
|
return data;
|
|
}
|
|
|
|
// clang-format off
|
|
void SmallSceneryObject::PerformFixes()
|
|
{
|
|
auto identifier = GetLegacyIdentifier();
|
|
|
|
// ToonTowner's base blocks. Put them in the Walls and Roofs group.
|
|
if (identifier == "XXBBCL01" ||
|
|
identifier == "XXBBMD01" ||
|
|
identifier == "ARBASE2 ")
|
|
{
|
|
SetPrimarySceneryGroup(ObjectEntryDescriptor("rct2.scenery_group.scgwalls"));
|
|
}
|
|
|
|
// ToonTowner's Pirate roofs. Make them show up in the Pirate Theming.
|
|
if (identifier == "TTPIRF05" ||
|
|
identifier == "TTPRF09 " ||
|
|
identifier == "TTPRF10 " ||
|
|
identifier == "TTPRF11 ")
|
|
{
|
|
SetPrimarySceneryGroup(ObjectEntryDescriptor("rct2.scenery_group.scgpirat"));
|
|
}
|
|
}
|
|
// clang-format on
|
|
|
|
void SmallSceneryObject::ReadJson(IReadObjectContext* context, json_t& root)
|
|
{
|
|
Guard::Assert(root.is_object(), "SmallSceneryObject::ReadJson expects parameter root to be object");
|
|
|
|
auto properties = root["properties"];
|
|
|
|
if (properties.is_object())
|
|
{
|
|
_legacyType.height = Json::GetNumber<uint8_t>(properties["height"]);
|
|
_legacyType.tool_id = Cursor::FromString(Json::GetString(properties["cursor"]), CursorID::StatueDown);
|
|
_legacyType.price = Json::GetNumber<int16_t>(properties["price"]) * 10;
|
|
_legacyType.removal_price = Json::GetNumber<int16_t>(properties["removalPrice"]) * 10;
|
|
_legacyType.animation_delay = Json::GetNumber<uint16_t>(properties["animationDelay"]);
|
|
_legacyType.animation_mask = Json::GetNumber<uint16_t>(properties["animationMask"]);
|
|
_legacyType.num_frames = Json::GetNumber<uint16_t>(properties["numFrames"]);
|
|
|
|
_legacyType.flags = Json::GetFlags<uint32_t>(
|
|
properties,
|
|
{
|
|
{ "SMALL_SCENERY_FLAG_VOFFSET_CENTRE", SMALL_SCENERY_FLAG_VOFFSET_CENTRE },
|
|
{ "requiresFlatSurface", SMALL_SCENERY_FLAG_REQUIRE_FLAT_SURFACE },
|
|
{ "isRotatable", SMALL_SCENERY_FLAG_ROTATABLE },
|
|
{ "isAnimated", SMALL_SCENERY_FLAG_ANIMATED },
|
|
{ "canWither", SMALL_SCENERY_FLAG_CAN_WITHER },
|
|
{ "canBeWatered", SMALL_SCENERY_FLAG_CAN_BE_WATERED },
|
|
{ "hasOverlayImage", SMALL_SCENERY_FLAG_ANIMATED_FG },
|
|
{ "hasGlass", SMALL_SCENERY_FLAG_HAS_GLASS },
|
|
{ "hasPrimaryColour", SMALL_SCENERY_FLAG_HAS_PRIMARY_COLOUR },
|
|
{ "SMALL_SCENERY_FLAG_FOUNTAIN_SPRAY_1", SMALL_SCENERY_FLAG_FOUNTAIN_SPRAY_1 },
|
|
{ "SMALL_SCENERY_FLAG_FOUNTAIN_SPRAY_4", SMALL_SCENERY_FLAG_FOUNTAIN_SPRAY_4 },
|
|
{ "isClock", SMALL_SCENERY_FLAG_IS_CLOCK },
|
|
{ "SMALL_SCENERY_FLAG_SWAMP_GOO", SMALL_SCENERY_FLAG_SWAMP_GOO },
|
|
{ "SMALL_SCENERY_FLAG17", SMALL_SCENERY_FLAG17 },
|
|
{ "isStackable", SMALL_SCENERY_FLAG_STACKABLE },
|
|
{ "prohibitWalls", SMALL_SCENERY_FLAG_NO_WALLS },
|
|
{ "hasSecondaryColour", SMALL_SCENERY_FLAG_HAS_SECONDARY_COLOUR },
|
|
{ "hasNoSupports", SMALL_SCENERY_FLAG_NO_SUPPORTS },
|
|
{ "SMALL_SCENERY_FLAG_VISIBLE_WHEN_ZOOMED", SMALL_SCENERY_FLAG_VISIBLE_WHEN_ZOOMED },
|
|
{ "SMALL_SCENERY_FLAG_COG", SMALL_SCENERY_FLAG_COG },
|
|
{ "allowSupportsAbove", SMALL_SCENERY_FLAG_BUILD_DIRECTLY_ONTOP },
|
|
{ "supportsHavePrimaryColour", SMALL_SCENERY_FLAG_PAINT_SUPPORTS },
|
|
{ "SMALL_SCENERY_FLAG27", SMALL_SCENERY_FLAG27 },
|
|
{ "isTree", SMALL_SCENERY_FLAG_IS_TREE },
|
|
{ "hasTertiaryColour", SMALL_SCENERY_FLAG_HAS_TERTIARY_COLOUR },
|
|
});
|
|
|
|
// Determine shape flags from a shape string
|
|
auto shape = Json::GetString(properties["shape"]);
|
|
if (!shape.empty())
|
|
{
|
|
auto quarters = shape.substr(0, 3);
|
|
if (quarters == "2/4")
|
|
{
|
|
_legacyType.flags |= SMALL_SCENERY_FLAG_FULL_TILE | SMALL_SCENERY_FLAG_HALF_SPACE;
|
|
}
|
|
else if (quarters == "3/4")
|
|
{
|
|
_legacyType.flags |= SMALL_SCENERY_FLAG_FULL_TILE | SMALL_SCENERY_FLAG_THREE_QUARTERS;
|
|
}
|
|
else if (quarters == "4/4")
|
|
{
|
|
_legacyType.flags |= SMALL_SCENERY_FLAG_FULL_TILE;
|
|
}
|
|
if (shape.size() >= 5)
|
|
{
|
|
if ((shape.substr(3) == "+D"))
|
|
{
|
|
_legacyType.flags |= SMALL_SCENERY_FLAG_DIAGONAL;
|
|
}
|
|
}
|
|
}
|
|
SetBoundingBoxFromFlags();
|
|
auto jBBox = properties["boundingBox"];
|
|
if (!jBBox.empty())
|
|
{
|
|
_legacyType.boundBoxes = ReadBoundBoxes(
|
|
jBBox, _legacyType.boundBoxes[0].length.z,
|
|
_legacyType.HasFlag(SMALL_SCENERY_FLAG_FULL_TILE) || _legacyType.HasFlag(SMALL_SCENERY_FLAG_HALF_SPACE));
|
|
}
|
|
auto jSpriteOffset = properties["spriteOffsetCoordinates"];
|
|
if (!jSpriteOffset.empty())
|
|
_legacyType.spriteOffset = ReadSpriteOffset(jSpriteOffset);
|
|
|
|
auto jFrameOffsets = properties["frameOffsets"];
|
|
if (jFrameOffsets.is_array())
|
|
{
|
|
_frameOffsets = ReadJsonFrameOffsets(jFrameOffsets);
|
|
_legacyType.flags |= SMALL_SCENERY_FLAG_HAS_FRAME_OFFSETS;
|
|
}
|
|
|
|
SetPrimarySceneryGroup(ObjectEntryDescriptor(Json::GetString(properties["sceneryGroup"])));
|
|
}
|
|
|
|
PopulateTablesFromJson(context, root);
|
|
}
|
|
|
|
std::vector<uint8_t> SmallSceneryObject::ReadJsonFrameOffsets(json_t& jFrameOffsets)
|
|
{
|
|
std::vector<uint8_t> offsets;
|
|
|
|
for (const auto& jOffset : jFrameOffsets)
|
|
{
|
|
offsets.push_back(Json::GetNumber<uint8_t>(jOffset));
|
|
}
|
|
return offsets;
|
|
}
|
|
|
|
static int32_t getBoundBoxHeight(uint8_t clearanceHeight)
|
|
{
|
|
int32_t height = clearanceHeight - 4;
|
|
if (height > 128 || height < 0)
|
|
{
|
|
height = 128;
|
|
}
|
|
return height - 1;
|
|
}
|
|
|
|
void SmallSceneryObject::SetBoundingBoxFromFlags()
|
|
{
|
|
DefaultBoundingBoxType boundBoxType = DefaultBoundingBoxType::QuarterTileBox;
|
|
DefaultSpriteOffsetType spriteOffsetType = DefaultSpriteOffsetType::QuarterTileOffset;
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_FULL_TILE))
|
|
{
|
|
boundBoxType = DefaultBoundingBoxType::FullTileThinBox;
|
|
spriteOffsetType = DefaultSpriteOffsetType::FullTileThinOffset;
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_HALF_SPACE))
|
|
{
|
|
spriteOffsetType = DefaultSpriteOffsetType::FullTileOffset;
|
|
boundBoxType = DefaultBoundingBoxType::HalfTileBox;
|
|
}
|
|
else
|
|
{
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_VOFFSET_CENTRE))
|
|
{
|
|
boundBoxType = DefaultBoundingBoxType::FullTileBox;
|
|
spriteOffsetType = DefaultSpriteOffsetType::FullTileOffset;
|
|
if (_legacyType.HasFlag(SMALL_SCENERY_FLAG_NO_WALLS))
|
|
{
|
|
boundBoxType = DefaultBoundingBoxType::FullTileLargeBox;
|
|
spriteOffsetType = DefaultSpriteOffsetType::FullTileLargeOffset;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
_legacyType.spriteOffset = GetDefaultSpriteOffset(spriteOffsetType);
|
|
_legacyType.boundBoxes = GetDefaultSceneryBoundBoxes(boundBoxType);
|
|
|
|
auto clearanceHeight = getBoundBoxHeight(_legacyType.height);
|
|
for (uint8_t i = 0; i < NumOrthogonalDirections; i++)
|
|
{
|
|
_legacyType.boundBoxes[i].length.z = clearanceHeight;
|
|
}
|
|
}
|