Add function to get all entities on a tile to plugin api #15901

andrewpratt64 · 2021-11-12T05:15:20Z

Add function map.getAllEntitiesOnTile() to api

This was made to allow getting entities on a tile without the need to manually iterate over all entities of a given type, such as the value returned by getAllEntities()
getAllEntitiesOnTile() was made to closely resemble the already existing getAllEntities()
In general tems, getAllEntitiesOnTile() is to EntityTileList as getAllEntities() is to EntityList
Currently, the tile position is taken in as two integer parameters that are then used to construct a CoordsXY object. This could be changed to take a single CoordsXY parameter instead, if that would be better
I appended , api function to get entities on a tile to my name in contributors.md, I can change how it's worded or remove that change entirely if it's not necessary

distribution/openrct2.d.ts

src/openrct2/scripting/bindings/world/ScMap.cpp

distribution/openrct2.d.ts

src/openrct2/scripting/bindings/world/ScMap.cpp

andrewpratt64

Added it, but other commits somehow got duplicated in the process, so ignore them for now while I try to fix that

andrewpratt64 · 2021-11-18T22:28:19Z

Added it, but other commits somehow got duplicated in the process, so ignore them for now while I try to fix that

Fixed

Broxzier

Tested, and works as expected, however I think it would be better to take tile coordinates instead of big coordinates. This has to be rebased, and the changelog entry should be moved up to the current development version.

distribution/changelog.txt

Broxzier · 2021-11-22T21:46:36Z

src/openrct2/scripting/bindings/world/ScMap.cpp

+        const std::string& type, const DukValue& tilePos) const
+    {
+        // Get the tile position
+        const auto pos = FromDuk<CoordsXY>(tilePos);


I think it would be better to take TileCoords instead of CoordsXY, so each tile increments X and Y by only 1 instead of 32. To get all entities on tile {x: 70, y: 75} for example, you now have to supply {x: 70 * 32, y: 75 * 32}.

Broxzier@6ee6ae3

I agree, tiles should use tile coordinates.

The use of big coords and tile coords seems to be rather mixed in the API. I've seen a couple plugins use game-actions where they multiply every value with 32 to iterate over some tiles, and the getTile function on the map takes two arguments for x and y where they are tile coords instead.

Is this solved (and thus PR mergeable?)

Well it still takes big coords instead of tile coords. I tried changing it so that the pos was multiplied by 32, but my build environment get a little messed up after the new save format update was released. Is there anything special I'm supposed to do to update it? Running from the game launcher works fine but Visual Studio logs a thousand "Object not found." errors and I think it tries to load the older format

you need to do a full rebuild (from the msbuild window) to make it download the updated objects.

I think I tried that, but I'll try again. If that dosen't work I'll just delete the local repository and clone it again

It seems that the use of TileCoords and Coords are a bit mixed in the API. This is better left for another issue.

tupaschoal · 2021-11-30T20:29:01Z

@andrewpratt64 can you rebase to fix the merge conflict on distribution.txt, please?

Add function map.getAllEntitiesOnTile() to api - This was made to allow getting entities on a tile without the need to manually iterate over all entities of a given type, such as the value returned by getAllEntities() - getAllEntitiesOnTile() was made to closely resemble the already existing getAllEntities() - In general tems, getAllEntitiesOnTile() is to EntityTileList<T> as getAllEntities() is to EntityList<T> - Currently, the tile position is taken in as two integer parameters that are then used to construct a CoordsXY object. This could be changed to take a single CoordsXY parameter instead, if that would be better

Change getAllEntitiesOnTile - Make getAllEntitiesOnTile take a Tile object instead of two ints - Remove obsolete type "peep" from getAllEntitiesOnTile - Add comments - Improve error message for invalid type argument - Add error handling for invalid tile argument -

Change argument in getAllEntitiesOnTile - Change getAllEntitiesOnTile tile argument to take a CoordsXY object - Rename argument from "tile" to "tilePos"

Improve getAllEntitiesOnTile - Use FromDuk instead of manually creating a CoordsXY object - Remove now-obselete try catch block

- Headline feature: [#10664] New save format with increased limits. - Feature: [#714] Allow up to 255 trains per ride. - Feature: [#2253] Path surfaces and railings can be mixed and matched, like in RCT1. - Feature: [#2766] The Fruity Ices Stall can now be recoloured, like in RCT1. - Feature: [#4933] Allow map sizes of 999 × 999 (up from 254 × 254). - Feature: [#7660] Custom music objects that are distributed with the save. - Feature: [#8407] Ride platforms can be made invisible. - Feature: [#12793] Add Excitement/Intensity/Nausea ratings to Ride List view with sorting. - Feature: [#13858] Flatride bases can be made invisible. - Feature: [#14676] [Plugin] Allow plugins to store data in .park files. - Feature: [#15367] Individual track elements can now be drawn as another ride type. - Feature: [#15901] [Plugin] Add ‘map.getAllEntitiesOnTile’ to API. - Feature: [#16029] [Plugin] Add ‘TrackElement.rideType’ to API. - Feature: [#16097] The Looping Roller Coaster can now draw all elements from the LIM Launched Roller Coaster. - Feature: [#16132, #16389] The Corkscrew, Twister and Vertical Drop Roller Coasters can now draw inline twists. - Feature: [#16144] [Plugin] Add ‘ImageManager’ to API. - Feature: [#16707] [Plugin] Implement intransient plugins. - Feature: [#16707] [Plugin] New API for current mode, ‘map.change’ hook and toolbox menu items on title screen. - Feature: [#16731] [Plugin] New API for fetching and manipulating a staff member’s patrol area. - Feature: [#16800] [Plugin] Add lift hill speed properties to API. - Feature: [#16806] Parkobj can load sprites from RCT image archives. - Feature: [#16831] Allow tertiary colours for small and large scenery objects. - Feature: [#16872] [Plugin] Add support for custom images. - Improved: [#3517] Cheats are now saved with the park. - Improved: [#10150] Ride stations are now properly checked if they’re sheltered. - Improved: [#10664, #16072] Visibility status can be modified directly in the Tile Inspector’s list. - Improved: [#16251] Plugin API handles null values better. - Improved: [#16251] openrct2.d.ts: mark ‘callback’ argument of queryAction and executeAction as optional. - Improved: [#16251] openrct2.d.ts: change ‘network.status’ to ‘network.mode’ in network API docs. - Improved: [#16251] openrct2.d.ts: added previously undocumented ‘GroupBoxWidget.text’ property. - Improved: [#16251] openrct2.d.ts: removed unused ‘LabelWidget.onChange’ property. - Improved: [#16258] Increased image limit in the engine. - Improved: [#16408] Improve ‘--version’ cli option to report more compatibility information. - Improved: [#16740] Allow staff patrol areas to be defined with individual tiles rather than groups of 4x4. - Improved: [#16764] [Plugin] Add hook ‘map.save’, called before the map is saved. - Improved: [#16925] The queue length of 1000 guests is lifted, and a warning for too long queues is added instead. - Change: [#14484] Make the Heartline Twister coaster ratings a little bit less hateful. - Change: [#16077] When importing SV6 files, the RCT1 land types are only added when they were actually used. - Change: [#16424] Following an entity in the title sequence no longer toggles underground view when it’s underground. - Change: [#16493] Boat Hire and Submarine Ride support costs now match their visual appearance. - Change: [#16710] Changed default view of Guest List to ‘Thoughts’ and selected tab will default to ‘Summarised’ (when opened from the menu). - Change: [#16859] Guests with umbrellas no longer always avoid going into a Maze. - Change: [#16912] Tired or nauseated guests will no longer jump in a Maze. - Fix: [#6767] Black screen after Alt-Tabbing back into the game. - Fix: [#11752] Track pieces with fractional cost are too cheap to build. - Fix: [#12556] Allow game to run without audio devices. - Fix: [#12774] [Plugin] Scripts will not be re-initialised when a new scenario is loaded from within a running scenario. - Fix: [#13336] Can no longer place Bumble Bee track design (reverts #12707). - Fix: [#14155] Map Generator sometimes places non-tree objects as trees. - Fix: [#14674] Recent Messages only shows first few notifications. - Fix: [#14920] Ghosts for rides and shops do not auto-elevate when obscured. - Fix: [#15413] Modifying park rating with plugins desyncs park rating history from actual park rating. - Fix: [#15571] Non-ASCII characters in scenario description get distorted while saving. - Fix: [#15830] Objects with RCT1 images are very glitchy if OpenRCT2 is not linked to an RCT1 install. - Fix: [#15909] Text can overflow in ‘Select ride design’ windows. - Fix: [#15947, #15960] Removing a flat ride results in an error message and duplicate structures. - Fix: [#15998] Cannot set map size to the actual maximum. - Fix: [#16007] Scenario Editor “Entry Price” appears to the right of the value field. - Fix: [#16008] Tile Inspector can select elements from last tile without reselecting it. - Fix: [#16024] Go-Karts with more than 32 vehicles do not colour themselves correctly. - Fix: [#16026] Newly created rides with “Disable vehicle limits” cheat always get 32 trains with 12 cars each. - Fix: [#16063] Object Selection preview for objects with glass is broken. - Fix: [#16075] Exporting track designs saves scenery in incorrect locations. - Fix: [#16087] The Looping Roller Coaster booster is now always drawn correctly. - Fix: [#16140] The ‘Follow this’ option is now disabled when the ride view is set to ‘overall’ or a station. - Fix: [#16162] Go Karts speeds are not correctly randomised, they only go very fast or very slow. - Fix: [#16188] Medium-size banked turns on the Twister and Vertical Roller Coaster have incorrect support placement (partly original bug). - Fix: [#16264, #16572] Placing saved track design crashes game. - Fix [#16308] Crash when trying to place down a ride on Android. - Fix: [#16327] Crash on malformed network packet. - Fix: [#16449] [Plugin] Viewport doesn't hide when switching tabs. - Fix: [#16450] Banner style not copied when using tile inspector. - Fix: [#16535] Entering construction mode unblocks all paths. - Fix: [#16542] “Same price throughout park” status not correctly imported for RCT1 saves. - Fix: [#16572] Crash when trying to place track designs. - Fix: [#16591] [Plugin] ‘setInterval’ and ‘setTimeout’ is not disposed when map unloads. - Fix: [#16711] [Plugin] ‘Car.rideObject’ overflowing with more than 256 ride types. - Fix: [#16779] Fix case where title music doesn't unmute properly. - Fix: [#16808] Incorrect track design serialisation causing vehicle object replacement. - Fix: [#16869] Soft Toy Stall cannot be recoloured, but shows a recolouring option anyway (original bug). - Fix: [#16995] Native Linux dialog windows do not open if the path contains single quotes. - Fix: [objects#165] Glitch when Bengal Tiger Cars go through a corner.

- Headline feature: [OpenRCT2#10664] New save format with increased limits. - Feature: [OpenRCT2#714] Allow up to 255 trains per ride. - Feature: [OpenRCT2#2253] Path surfaces and railings can be mixed and matched, like in RCT1. - Feature: [OpenRCT2#2766] The Fruity Ices Stall can now be recoloured, like in RCT1. - Feature: [OpenRCT2#4933] Allow map sizes of 999 × 999 (up from 254 × 254). - Feature: [OpenRCT2#7660] Custom music objects that are distributed with the save. - Feature: [OpenRCT2#8407] Ride platforms can be made invisible. - Feature: [OpenRCT2#12793] Add Excitement/Intensity/Nausea ratings to Ride List view with sorting. - Feature: [OpenRCT2#13858] Flatride bases can be made invisible. - Feature: [OpenRCT2#14676] [Plugin] Allow plugins to store data in .park files. - Feature: [OpenRCT2#15367] Individual track elements can now be drawn as another ride type. - Feature: [OpenRCT2#15901] [Plugin] Add ‘map.getAllEntitiesOnTile’ to API. - Feature: [OpenRCT2#16029] [Plugin] Add ‘TrackElement.rideType’ to API. - Feature: [OpenRCT2#16097] The Looping Roller Coaster can now draw all elements from the LIM Launched Roller Coaster. - Feature: [OpenRCT2#16132, OpenRCT2#16389] The Corkscrew, Twister and Vertical Drop Roller Coasters can now draw inline twists. - Feature: [OpenRCT2#16144] [Plugin] Add ‘ImageManager’ to API. - Feature: [OpenRCT2#16707] [Plugin] Implement intransient plugins. - Feature: [OpenRCT2#16707] [Plugin] New API for current mode, ‘map.change’ hook and toolbox menu items on title screen. - Feature: [OpenRCT2#16731] [Plugin] New API for fetching and manipulating a staff member’s patrol area. - Feature: [OpenRCT2#16800] [Plugin] Add lift hill speed properties to API. - Feature: [OpenRCT2#16806] Parkobj can load sprites from RCT image archives. - Feature: [OpenRCT2#16831] Allow tertiary colours for small and large scenery objects. - Feature: [OpenRCT2#16872] [Plugin] Add support for custom images. - Improved: [OpenRCT2#3517] Cheats are now saved with the park. - Improved: [OpenRCT2#10150] Ride stations are now properly checked if they’re sheltered. - Improved: [OpenRCT2#10664, OpenRCT2#16072] Visibility status can be modified directly in the Tile Inspector’s list. - Improved: [OpenRCT2#16251] Plugin API handles null values better. - Improved: [OpenRCT2#16251] openrct2.d.ts: mark ‘callback’ argument of queryAction and executeAction as optional. - Improved: [OpenRCT2#16251] openrct2.d.ts: change ‘network.status’ to ‘network.mode’ in network API docs. - Improved: [OpenRCT2#16251] openrct2.d.ts: added previously undocumented ‘GroupBoxWidget.text’ property. - Improved: [OpenRCT2#16251] openrct2.d.ts: removed unused ‘LabelWidget.onChange’ property. - Improved: [OpenRCT2#16258] Increased image limit in the engine. - Improved: [OpenRCT2#16408] Improve ‘--version’ cli option to report more compatibility information. - Improved: [OpenRCT2#16740] Allow staff patrol areas to be defined with individual tiles rather than groups of 4x4. - Improved: [OpenRCT2#16764] [Plugin] Add hook ‘map.save’, called before the map is saved. - Improved: [OpenRCT2#16925] The queue length of 1000 guests is lifted, and a warning for too long queues is added instead. - Change: [OpenRCT2#14484] Make the Heartline Twister coaster ratings a little bit less hateful. - Change: [OpenRCT2#16077] When importing SV6 files, the RCT1 land types are only added when they were actually used. - Change: [OpenRCT2#16424] Following an entity in the title sequence no longer toggles underground view when it’s underground. - Change: [OpenRCT2#16493] Boat Hire and Submarine Ride support costs now match their visual appearance. - Change: [OpenRCT2#16710] Changed default view of Guest List to ‘Thoughts’ and selected tab will default to ‘Summarised’ (when opened from the menu). - Change: [OpenRCT2#16859] Guests with umbrellas no longer always avoid going into a Maze. - Change: [OpenRCT2#16912] Tired or nauseated guests will no longer jump in a Maze. - Fix: [OpenRCT2#6767] Black screen after Alt-Tabbing back into the game. - Fix: [OpenRCT2#11752] Track pieces with fractional cost are too cheap to build. - Fix: [OpenRCT2#12556] Allow game to run without audio devices. - Fix: [OpenRCT2#12774] [Plugin] Scripts will not be re-initialised when a new scenario is loaded from within a running scenario. - Fix: [OpenRCT2#13336] Can no longer place Bumble Bee track design (reverts OpenRCT2#12707). - Fix: [OpenRCT2#14155] Map Generator sometimes places non-tree objects as trees. - Fix: [OpenRCT2#14674] Recent Messages only shows first few notifications. - Fix: [OpenRCT2#14920] Ghosts for rides and shops do not auto-elevate when obscured. - Fix: [OpenRCT2#15413] Modifying park rating with plugins desyncs park rating history from actual park rating. - Fix: [OpenRCT2#15571] Non-ASCII characters in scenario description get distorted while saving. - Fix: [OpenRCT2#15830] Objects with RCT1 images are very glitchy if OpenRCT2 is not linked to an RCT1 install. - Fix: [OpenRCT2#15909] Text can overflow in ‘Select ride design’ windows. - Fix: [OpenRCT2#15947, OpenRCT2#15960] Removing a flat ride results in an error message and duplicate structures. - Fix: [OpenRCT2#15998] Cannot set map size to the actual maximum. - Fix: [OpenRCT2#16007] Scenario Editor “Entry Price” appears to the right of the value field. - Fix: [OpenRCT2#16008] Tile Inspector can select elements from last tile without reselecting it. - Fix: [OpenRCT2#16024] Go-Karts with more than 32 vehicles do not colour themselves correctly. - Fix: [OpenRCT2#16026] Newly created rides with “Disable vehicle limits” cheat always get 32 trains with 12 cars each. - Fix: [OpenRCT2#16063] Object Selection preview for objects with glass is broken. - Fix: [OpenRCT2#16075] Exporting track designs saves scenery in incorrect locations. - Fix: [OpenRCT2#16087] The Looping Roller Coaster booster is now always drawn correctly. - Fix: [OpenRCT2#16140] The ‘Follow this’ option is now disabled when the ride view is set to ‘overall’ or a station. - Fix: [OpenRCT2#16162] Go Karts speeds are not correctly randomised, they only go very fast or very slow. - Fix: [OpenRCT2#16188] Medium-size banked turns on the Twister and Vertical Roller Coaster have incorrect support placement (partly original bug). - Fix: [OpenRCT2#16264, OpenRCT2#16572] Placing saved track design crashes game. - Fix [OpenRCT2#16308] Crash when trying to place down a ride on Android. - Fix: [OpenRCT2#16327] Crash on malformed network packet. - Fix: [OpenRCT2#16449] [Plugin] Viewport doesn't hide when switching tabs. - Fix: [OpenRCT2#16450] Banner style not copied when using tile inspector. - Fix: [OpenRCT2#16535] Entering construction mode unblocks all paths. - Fix: [OpenRCT2#16542] “Same price throughout park” status not correctly imported for RCT1 saves. - Fix: [OpenRCT2#16572] Crash when trying to place track designs. - Fix: [OpenRCT2#16591] [Plugin] ‘setInterval’ and ‘setTimeout’ is not disposed when map unloads. - Fix: [OpenRCT2#16711] [Plugin] ‘Car.rideObject’ overflowing with more than 256 ride types. - Fix: [OpenRCT2#16779] Fix case where title music doesn't unmute properly. - Fix: [OpenRCT2#16808] Incorrect track design serialisation causing vehicle object replacement. - Fix: [OpenRCT2#16869] Soft Toy Stall cannot be recoloured, but shows a recolouring option anyway (original bug). - Fix: [OpenRCT2#16995] Native Linux dialog windows do not open if the path contains single quotes. - Fix: [objects#165] Glitch when Bengal Tiger Cars go through a corner.

Broxzier reviewed Nov 12, 2021

View reviewed changes

distribution/openrct2.d.ts Outdated Show resolved Hide resolved

duncanspumpkin reviewed Nov 12, 2021

View reviewed changes

src/openrct2/scripting/bindings/world/ScMap.cpp Outdated Show resolved Hide resolved

Broxzier reviewed Nov 12, 2021

View reviewed changes

distribution/openrct2.d.ts Outdated Show resolved Hide resolved

Broxzier added the plugin api version Plugin API version needs updating - double check before merging! label Nov 12, 2021

andrewpratt64 force-pushed the api-getallentities-wip branch 2 times, most recently from ad43f93 to e8735b1 Compare November 14, 2021 02:22

Broxzier reviewed Nov 14, 2021

View reviewed changes

src/openrct2/scripting/bindings/world/ScMap.cpp Outdated Show resolved Hide resolved

andrewpratt64 commented Nov 18, 2021

View reviewed changes

andrewpratt64 force-pushed the api-getallentities-wip branch from 412473f to bc4b801 Compare November 18, 2021 22:27

IntelOrca approved these changes Nov 20, 2021

View reviewed changes

Broxzier requested changes Nov 22, 2021

View reviewed changes

andrewpratt64 force-pushed the api-getallentities-wip branch from 72228cb to 5d4ef89 Compare November 24, 2021 22:41

andrewpratt64 force-pushed the api-getallentities-wip branch from 196fb2f to bedfcc4 Compare November 30, 2021 21:21

andrewpratt64 force-pushed the api-getallentities-wip branch from bedfcc4 to 6988f44 Compare December 10, 2021 00:42

tupaschoal requested a review from Broxzier March 18, 2022 12:02

andrewpratt64 added 6 commits March 20, 2022 13:03

Remove extra newline

fe5d797

Change argument in getAllEntitiesOnTile

3bc03f7

Change argument in getAllEntitiesOnTile - Change getAllEntitiesOnTile tile argument to take a CoordsXY object - Rename argument from "tile" to "tilePos"

Update changelog.txt

9ba4fc1

Improve getAllEntitiesOnTile

b36dd65

Improve getAllEntitiesOnTile - Use FromDuk instead of manually creating a CoordsXY object - Remove now-obselete try catch block

Broxzier force-pushed the api-getallentities-wip branch from 6988f44 to b36dd65 Compare March 20, 2022 12:04

Increment plug-in API version

2df60c2

Broxzier approved these changes Mar 20, 2022

View reviewed changes

Broxzier merged commit 5ea89b9 into OpenRCT2:develop Mar 20, 2022

tupaschoal added this to the v0.4.0 milestone Mar 20, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add function to get all entities on a tile to plugin api #15901

Add function to get all entities on a tile to plugin api #15901

andrewpratt64 commented Nov 12, 2021

andrewpratt64 left a comment

andrewpratt64 commented Nov 18, 2021

Broxzier left a comment

Broxzier Nov 22, 2021

Broxzier Nov 22, 2021

ZehMatt Nov 23, 2021

Broxzier Dec 5, 2021

tupaschoal Dec 10, 2021

andrewpratt64 Dec 12, 2021

duncanspumpkin Dec 16, 2021

andrewpratt64 Dec 17, 2021

Broxzier Mar 20, 2022

tupaschoal commented Nov 30, 2021

Add function to get all entities on a tile to plugin api #15901

Add function to get all entities on a tile to plugin api #15901

Conversation

andrewpratt64 commented Nov 12, 2021

andrewpratt64 left a comment

Choose a reason for hiding this comment

andrewpratt64 commented Nov 18, 2021

Broxzier left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tupaschoal commented Nov 30, 2021