Fix #9054: remove gSceneryTileElement by returning it within GameActi… (#9127)

* Fix #9054: remove gSceneryTileElement by returning it within GameActionResult * fixing Clang-format issues * fixing clang-format lets try this again... * fixing clang-format alright should be good this time * fixing clang-format issues using automatic clang-formatting * initializing tileElement
2025-12-11 18:12:23 +01:00 · 2019-04-24 04:42:00 -04:00
parent 3f4acd7e69
commit b052c4ac61
6 changed files with 66 additions and 47 deletions
--- a/src/openrct2-ui/windows/TopToolbar.cpp
+++ b/src/openrct2-ui/windows/TopToolbar.cpp
@@ -2484,7 +2484,7 @@ static money32 try_place_ghost_scenery(
            gSceneryPlaceRotation = (uint16_t)(parameter_3 & 0xFF);
            gSceneryPlaceObject = selected_tab;

-            tileElement = gSceneryTileElement;
+            tileElement = dynamic_cast<SmallSceneryPlaceActionResult*>(res.get())->tileElement;
            gSceneryGhostPosition.z = tileElement->base_height;
            gSceneryQuadrant = tileElement->AsSmallScenery()->GetSceneryQuadrant();
            if (dynamic_cast<SmallSceneryPlaceActionResult*>(res.get())->GroundFlags & ELEMENT_IS_UNDERGROUND)
@@ -2539,14 +2539,14 @@ static money32 try_place_ghost_scenery(
                type, { map_tile.x, map_tile.y, gSceneryPlaceZ }, edges, primaryColour, _secondaryColour, _tertiaryColour);
            wallPlaceAction.SetFlags(
                GAME_COMMAND_FLAG_GHOST | GAME_COMMAND_FLAG_ALLOW_DURING_PAUSED | GAME_COMMAND_FLAG_NO_SPEND);
-            wallPlaceAction.SetCallback([=](const GameAction* ga, const GameActionResult* result) {
+            wallPlaceAction.SetCallback([=](const GameAction* ga, const WallPlaceActionResult* result) {
                if (result->Error != GA_ERROR::OK)
                    return;

                gSceneryGhostPosition.x = map_tile.x;
                gSceneryGhostPosition.y = map_tile.y;
                gSceneryGhostWallRotation = edges;
-                gSceneryGhostPosition.z = gSceneryTileElement->base_height;
+                gSceneryGhostPosition.z = result->tileElement->base_height;

                gSceneryGhostType |= SCENERY_GHOST_FLAG_2;
            });
@@ -2579,7 +2579,7 @@ static money32 try_place_ghost_scenery(
            gSceneryGhostPosition.y = map_tile.y;
            gSceneryPlaceRotation = loc.direction;

-            tileElement = gSceneryTileElement;
+            tileElement = dynamic_cast<LargeSceneryPlaceActionResult*>(res.get())->tileElement;
            gSceneryGhostPosition.z = tileElement->base_height;

            if (dynamic_cast<LargeSceneryPlaceActionResult*>(res.get())->GroundFlags & ELEMENT_IS_UNDERGROUND)
--- a/src/openrct2/actions/LargeSceneryPlaceAction.hpp
+++ b/src/openrct2/actions/LargeSceneryPlaceAction.hpp
@@ -40,6 +40,7 @@ public:
    }

    uint8_t GroundFlags{ 0 };
+    TileElement* tileElement = nullptr;
 };

 DEFINE_GAME_ACTION(LargeSceneryPlaceAction, GAME_COMMAND_PLACE_LARGE_SCENERY, LargeSceneryPlaceActionResult)
@@ -326,7 +327,7 @@ public:

            if (tileNum == 0)
            {
-                gSceneryTileElement = newTileElement;
+                res->tileElement = newTileElement;
            }
            map_invalidate_tile_full(curTile.x, curTile.y);
        }
--- a/src/openrct2/actions/SmallSceneryPlaceAction.hpp
+++ b/src/openrct2/actions/SmallSceneryPlaceAction.hpp
@@ -48,6 +48,7 @@ public:
    }

    uint8_t GroundFlags{ 0 };
+    TileElement* tileElement = nullptr;
 };

 DEFINE_GAME_ACTION(SmallSceneryPlaceAction, GAME_COMMAND_PLACE_SCENERY, SmallSceneryPlaceActionResult)
@@ -431,7 +432,7 @@ public:

        TileElement* newElement = tile_element_insert(_loc.x / 32, _loc.y / 32, zLow, quarterTile.GetBaseQuarterOccupied());
        assert(newElement != nullptr);
-        gSceneryTileElement = newElement;
+        res->tileElement = newElement;
        newElement->SetType(TILE_ELEMENT_TYPE_SMALL_SCENERY);
        newElement->SetDirection(_loc.direction);
        SmallSceneryElement* sceneryElement = newElement->AsSmallScenery();
--- a/src/openrct2/actions/WallPlaceAction.hpp
+++ b/src/openrct2/actions/WallPlaceAction.hpp
@@ -23,7 +23,33 @@
 #include "../world/Surface.h"
 #include "GameAction.h"

-DEFINE_GAME_ACTION(WallPlaceAction, GAME_COMMAND_PLACE_WALL, GameActionResult)
+class WallPlaceActionResult final : public GameActionResult
+{
+public:
+    WallPlaceActionResult()
+        : GameActionResult(GA_ERROR::OK, STR_CANT_BUILD_PARK_ENTRANCE_HERE)
+    {
+    }
+
+    WallPlaceActionResult(GA_ERROR err)
+        : GameActionResult(err, STR_CANT_BUILD_PARK_ENTRANCE_HERE)
+    {
+    }
+
+    WallPlaceActionResult(GA_ERROR err, rct_string_id msg)
+        : GameActionResult(err, STR_CANT_BUILD_PARK_ENTRANCE_HERE, msg)
+    {
+    }
+
+    WallPlaceActionResult(GA_ERROR error, rct_string_id msg, uint8_t* args)
+        : GameActionResult(error, STR_CANT_BUILD_PARK_ENTRANCE_HERE, msg, args)
+    {
+    }
+
+    TileElement* tileElement = nullptr;
+};
+
+DEFINE_GAME_ACTION(WallPlaceAction, GAME_COMMAND_PLACE_WALL, WallPlaceActionResult)
 {
 private:
    int32_t _wallType{ -1 };
@@ -73,7 +99,7 @@ public:

    GameActionResult::Ptr Query() const override
    {
-        auto res = MakeResult();
+        auto res = std::make_unique<WallPlaceActionResult>();
        res->ErrorTitle = STR_CANT_BUILD_PARK_ENTRANCE_HERE;
        res->Position = _loc;

@@ -93,23 +119,23 @@ public:
            {
                if (!map_is_location_in_park({ _loc.x, _loc.y }))
                {
-                    return MakeResult(GA_ERROR::NOT_OWNED, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+                    return std::make_unique<WallPlaceActionResult>(GA_ERROR::NOT_OWNED);
                }
            }
            else if (!map_is_location_owned(_loc.x, _loc.y, _loc.z))
            {
-                return MakeResult(GA_ERROR::NOT_OWNED, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::NOT_OWNED);
            }
        }
        else if (!byte_9D8150 && (_loc.x > gMapSizeMaxXY || _loc.y > gMapSizeMaxXY))
        {
            log_error("Invalid x/y coordinates. x = %d y = %d", _loc.x, _loc.y);
-            return MakeResult(GA_ERROR::INVALID_PARAMETERS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+            return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS);
        }

        if (_edge > 3)
        {
-            return MakeResult(GA_ERROR::INVALID_PARAMETERS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+            return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS);
        }

        uint8_t edgeSlope = 0;
@@ -120,7 +146,7 @@ public:
            if (surfaceElement == nullptr)
            {
                log_error("Surface element not found at %d, %d.", _loc.x, _loc.y);
-                return MakeResult(GA_ERROR::INVALID_PARAMETERS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS);
            }
            targetHeight = surfaceElement->base_height * 8;

@@ -137,7 +163,7 @@ public:
        if (surfaceElement == nullptr)
        {
            log_error("Surface element not found at %d, %d.", _loc.x, _loc.y);
-            return MakeResult(GA_ERROR::INVALID_PARAMETERS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+            return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS);
        }

        if (surfaceElement->AsSurface()->GetWaterHeight() > 0)
@@ -146,13 +172,13 @@ public:

            if (targetHeight < waterHeight && !gCheatsDisableClearanceChecks)
            {
-                return MakeResult(GA_ERROR::DISALLOWED, STR_CANT_BUILD_PARK_ENTRANCE_HERE, STR_CANT_BUILD_THIS_UNDERWATER);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::DISALLOWED, STR_CANT_BUILD_THIS_UNDERWATER);
            }
        }

        if (targetHeight / 8 < surfaceElement->base_height && !gCheatsDisableClearanceChecks)
        {
-            return MakeResult(GA_ERROR::DISALLOWED, STR_CANT_BUILD_PARK_ENTRANCE_HERE, STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
+            return std::make_unique<WallPlaceActionResult>(GA_ERROR::DISALLOWED, STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
        }

        if (!(edgeSlope & (EDGE_SLOPE_UPWARDS | EDGE_SLOPE_DOWNWARDS)))
@@ -164,8 +190,7 @@ public:
            {
                if (targetHeight / 8 < newBaseHeight)
                {
-                    return MakeResult(
-                        GA_ERROR::DISALLOWED, STR_CANT_BUILD_PARK_ENTRANCE_HERE, STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
+                    return std::make_unique<WallPlaceActionResult>(GA_ERROR::DISALLOWED, STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
                }

                if (surfaceElement->AsSurface()->GetSlope() & TILE_ELEMENT_SLOPE_DOUBLE_HEIGHT)
@@ -180,9 +205,8 @@ public:
                            newBaseHeight += 2;
                            if (targetHeight / 8 < newBaseHeight)
                            {
-                                return MakeResult(
-                                    GA_ERROR::DISALLOWED, STR_CANT_BUILD_PARK_ENTRANCE_HERE,
-                                    STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
+                                return std::make_unique<WallPlaceActionResult>(
+                                    GA_ERROR::DISALLOWED, STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
                            }
                            newBaseHeight -= 2;
                        }
@@ -195,8 +219,7 @@ public:
            {
                if (targetHeight / 8 < newBaseHeight)
                {
-                    return MakeResult(
-                        GA_ERROR::DISALLOWED, STR_CANT_BUILD_PARK_ENTRANCE_HERE, STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
+                    return std::make_unique<WallPlaceActionResult>(GA_ERROR::DISALLOWED, STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
                }

                if (surfaceElement->AsSurface()->GetSlope() & TILE_ELEMENT_SLOPE_DOUBLE_HEIGHT)
@@ -211,9 +234,8 @@ public:
                            newBaseHeight += 2;
                            if (targetHeight / 8 < newBaseHeight)
                            {
-                                return MakeResult(
-                                    GA_ERROR::DISALLOWED, STR_CANT_BUILD_PARK_ENTRANCE_HERE,
-                                    STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
+                                return std::make_unique<WallPlaceActionResult>(
+                                    GA_ERROR::DISALLOWED, STR_CAN_ONLY_BUILD_THIS_ABOVE_GROUND);
                            }
                        }
                    }
@@ -226,7 +248,7 @@ public:
        if (wallEntry == nullptr)
        {
            log_error("Wall Type not found %d", _wallType);
-            return MakeResult(GA_ERROR::INVALID_PARAMETERS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+            return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS);
        }

        if (wallEntry->wall.scrolling_mode != SCROLLING_MODE_NONE)
@@ -234,14 +256,13 @@ public:
            if (_bannerId == BANNER_INDEX_NULL)
            {
                log_error("Banner Index not specified.");
-                return MakeResult(
-                    GA_ERROR::INVALID_PARAMETERS, STR_TOO_MANY_BANNERS_IN_GAME, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS, STR_TOO_MANY_BANNERS_IN_GAME);
            }

            if (gBanners[_bannerId].type != BANNER_NULL)
            {
                log_error("No free banners available");
-                return MakeResult(GA_ERROR::NO_FREE_ELEMENTS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::NO_FREE_ELEMENTS);
            }
        }

@@ -250,8 +271,7 @@ public:
        {
            if (wallEntry->wall.flags & WALL_SCENERY_CANT_BUILD_ON_SLOPE)
            {
-                return MakeResult(
-                    GA_ERROR::DISALLOWED, STR_CANT_BUILD_PARK_ENTRANCE_HERE, STR_ERR_UNABLE_TO_BUILD_THIS_ON_SLOPE);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::DISALLOWED, STR_ERR_UNABLE_TO_BUILD_THIS_ON_SLOPE);
            }
            clearanceHeight += 2;
        }
@@ -262,14 +282,14 @@ public:
        {
            if (!WallCheckObstruction(wallEntry, targetHeight / 8, clearanceHeight, &wallAcrossTrack))
            {
-                return MakeResult(
-                    GA_ERROR::NO_CLEARANCE, STR_CANT_BUILD_PARK_ENTRANCE_HERE, gGameCommandErrorText, gCommonFormatArgs);
+                return std::make_unique<WallPlaceActionResult>(
+                    GA_ERROR::NO_CLEARANCE, gGameCommandErrorText, gCommonFormatArgs);
            }
        }

        if (!map_check_free_elements_and_reorganise(1))
        {
-            return MakeResult(GA_ERROR::NO_FREE_ELEMENTS, STR_CANT_BUILD_PARK_ENTRANCE_HERE, gGameCommandErrorText);
+            return std::make_unique<WallPlaceActionResult>(GA_ERROR::NO_FREE_ELEMENTS, gGameCommandErrorText);
        }

        res->Cost = wallEntry->wall.price;
@@ -278,7 +298,7 @@ public:

    GameActionResult::Ptr Execute() const override
    {
-        auto res = MakeResult();
+        auto res = std::make_unique<WallPlaceActionResult>();
        res->ErrorTitle = STR_CANT_BUILD_PARK_ENTRANCE_HERE;
        res->Position = _loc;

@@ -299,7 +319,7 @@ public:
            if (surfaceElement == nullptr)
            {
                log_error("Surface element not found at %d, %d.", _loc.x, _loc.y);
-                return MakeResult(GA_ERROR::INVALID_PARAMETERS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS);
            }
            targetHeight = surfaceElement->base_height * 8;

@@ -317,7 +337,7 @@ public:
        if (wallEntry == nullptr)
        {
            log_error("Wall Type not found %d", _wallType);
-            return MakeResult(GA_ERROR::INVALID_PARAMETERS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+            return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS);
        }

        if (wallEntry->wall.scrolling_mode != SCROLLING_MODE_NONE)
@@ -325,14 +345,13 @@ public:
            if (_bannerId == BANNER_INDEX_NULL)
            {
                log_error("Banner Index not specified.");
-                return MakeResult(
-                    GA_ERROR::INVALID_PARAMETERS, STR_TOO_MANY_BANNERS_IN_GAME, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::INVALID_PARAMETERS, STR_TOO_MANY_BANNERS_IN_GAME);
            }

            if (gBanners[_bannerId].type != BANNER_NULL)
            {
                log_error("No free banners available");
-                return MakeResult(GA_ERROR::NO_FREE_ELEMENTS, STR_CANT_BUILD_PARK_ENTRANCE_HERE);
+                return std::make_unique<WallPlaceActionResult>(GA_ERROR::NO_FREE_ELEMENTS);
            }

            rct_banner* banner = &gBanners[_bannerId];
@@ -364,14 +383,14 @@ public:
        {
            if (!WallCheckObstruction(wallEntry, targetHeight / 8, clearanceHeight, &wallAcrossTrack))
            {
-                return MakeResult(
-                    GA_ERROR::NO_CLEARANCE, STR_CANT_BUILD_PARK_ENTRANCE_HERE, gGameCommandErrorText, gCommonFormatArgs);
+                return std::make_unique<WallPlaceActionResult>(
+                    GA_ERROR::NO_CLEARANCE, gGameCommandErrorText, gCommonFormatArgs);
            }
        }

        if (!map_check_free_elements_and_reorganise(1))
        {
-            return MakeResult(GA_ERROR::NO_FREE_ELEMENTS, STR_CANT_BUILD_PARK_ENTRANCE_HERE, gGameCommandErrorText);
+            return std::make_unique<WallPlaceActionResult>(GA_ERROR::NO_FREE_ELEMENTS, gGameCommandErrorText);
        }

        TileElement* tileElement = tile_element_insert(_loc.x / 32, _loc.y / 32, targetHeight / 8, 0);
@@ -410,7 +429,7 @@ public:
            wallElement->SetGhost(true);
        }

-        gSceneryTileElement = tileElement;
+        res->tileElement = tileElement;
        map_invalidate_tile_zoom1(_loc.x, _loc.y, wallElement->base_height * 8, wallElement->base_height * 8 + 72);

        res->Cost = wallEntry->wall.price;
--- a/src/openrct2/world/Scenery.cpp
+++ b/src/openrct2/world/Scenery.cpp
@@ -40,7 +40,6 @@ colour_t gWindowScenerySecondaryColour;
 colour_t gWindowSceneryTertiaryColour;
 bool gWindowSceneryEyedropperEnabled;

-TileElement* gSceneryTileElement;
 uint8_t gSceneryQuadrant;

 money32 gSceneryPlaceCost;
--- a/src/openrct2/world/Scenery.h
+++ b/src/openrct2/world/Scenery.h
@@ -256,7 +256,6 @@ extern colour_t gWindowScenerySecondaryColour;
 extern colour_t gWindowSceneryTertiaryColour;
 extern bool gWindowSceneryEyedropperEnabled;

-extern TileElement* gSceneryTileElement;
 extern uint8_t gSceneryQuadrant;

 extern money32 gSceneryPlaceCost;