Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Plugin] Per-save plugin storage #14676

Closed
rctdude2 opened this issue May 16, 2021 · 4 comments · Fixed by #16685
Closed

[Plugin] Per-save plugin storage #14676

rctdude2 opened this issue May 16, 2021 · 4 comments · Fixed by #16685
Labels
enhancement An improvement to an existing feature (no alteration). plug-in Related to the plugin system of OpenRCT2.

Comments

@rctdude2
Copy link
Contributor

(I looked through existing issues and didn't find an existing issue or reference, sorry if I missed something.)

Now that the new save format is in testing and closer to being implemented, I wanted to add a feature request for adding per-save plugin storage. I'd like to be able to store settings for specific parks, and the current sharedStorage a) isn't conducive to saving per-park data, because there isn't a unique identifier (that I know of; I've seen a plugin use the park name, which isn't a constant and would clash with other saves), and even if it did, b) promotes orphaned data by separating park-specific information from the park itself and increasing the plugin.store.js file size with many saves.

This per-save storage would be in two parts:

  1. "Global" storage that applies to the whole park. This could be used for defaults or settings/data that apply to the whole park.
  2. Per-ride storage. This would be for data that applies to a specific ride (this could be stored in global by using the ride.id, however if the ride is deleted the stored data would be useless).

As a real-world example, I have an automatic price manager that I use to set ideal prices to maximize scam- uh, convincing my guests into parting with their money. One of the settings is setting ride prices to either the value price (most guests will pay and think "x is really good value"), the expensive price (most guests will pay before thinking "I'm not paying that much to go on x"), or halfway in-between. In many scenarios, typically this would just be set to expensive and left alone, since you can add ATMs and guests will continue to gleefully withdraw from their bank account. However, if you have a scenario with no ATMs and a park goal of x number of guests (read: RCT1 scenarios), you're better off using the value price so guests will stay in the park longer.

What I'd like to do is make my plugin save the settings per-save, that way I can switch between saves and have it set the proper settings for that park without accidentally blowing away the settings in another save. This would also help prevent modifying settings in new scenarios that price things differently from how I usually want them, and provide a way of keeping track of if the user has done something with the plugin for that park (for example, setting defaults for the park).

@Ryder17z
Copy link

AdvancedTrack could also benefit from this

@James103
Copy link
Contributor

The new save format could not only allow storing plugin data, but also plugin code, allowing custom scenarios to have custom challenge plugins, whereby, for example (these are just some ideas),

  • You have to achieve a park value of £100,000 by October, Year 3 BUT your park value is limited to at most 101 times your park rating (implying a park rating requirement of 991).
  • You have to get 4,000 guests in your park with park rating >= 700 BUT you fail if your bank balance goes below zero AND every guest takes $0.10 from your bank balance and adds it to their bank balance every in-game day.
  • You have to build 10 coasters each with minimum excitement rating >= 16.00 BUT every 100 park rating reduces the required excitement rating by 1.00, down to a minimum of 7.01 at 999 park rating.
  • A very long scenario where every year, there is a new goal to complete BUT also a new limitation that you have to follow. Reach October, Year 10, complete all goals, and satisfy all limitations to pass the scenario. Failure to complete the goal and follow the limitation by the end of the corresponding year fails the scenario.

@Ryder17z
Copy link

Another fun thing that might be possible is having a plugin that once you reach 800 guests enables land/build rights (owned/purchasable)
Or you could have a plugin that affects the research que. Like if you have a park value over 100.000 euros, you unlock a new ride (e.g. Looping Coaster) (either directly or by research later)

@James103
Copy link
Contributor

Some more ideas:

  • Forest Frontiers BUT the goal amount of guests increases by 1% for every in-game day.
  • Diamond Heights BUT spending money on anything increases the goal park value by the amount spent.
  • Mega Park BUT you get all of the other objectives for the RCT1 base game in sequence and you need to complete each objective before its time limit in order to pass the scenario.
  • Botany Breakers BUT you need to earn 1/12 of the park value in ride ticket income each month to pass.
  • Alton Towers, Blackpool Pleasure Beach or Heide-Park BUT you also need to pay off the loan to complete the scenario.
  • Choose any RCT2 scenario BUT you need to surpass @deurklink's YouTube subscriber count (6,320 at the time of writing) to pass the scenario.
  • A scenario with a loan of £1,000,000,000,000 at 0% interest BUT there are side goals to complete that will halve your loan for each side goal you complete.

@Gymnasiast Gymnasiast added enhancement An improvement to an existing feature (no alteration). plug-in Related to the plugin system of OpenRCT2. labels Oct 22, 2021
Gymnasiast added a commit that referenced this issue Apr 25, 2022
- 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.
rik-smeets pushed a commit to rik-smeets/OpenRCT2 that referenced this issue Jun 11, 2022
- 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An improvement to an existing feature (no alteration). plug-in Related to the plugin system of OpenRCT2.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants