[Plugin API] feat: expose monthly expenditure history by mrmagic2020 · Pull Request #22150 · OpenRCT2/OpenRCT2

mrmagic2020 · 2024-06-05T03:58:57Z

Expose monthly expenditure history to the plugin API.

Click here for test plugin

registerPlugin({
  name: "Expenditure Table Test",
  authors: ["mrmagic2020"],
  version: "0.0.1",
  licence: "MIT",
  type: "local",
  minApiVersion: 93,
  main: function () {
    var selectedMonth = 0;
    var selectedType = 0;
    const expTypes = [
      "ride_construction",
      "ride_runningcosts",
      "land_purchase",
      "landscaping",
      "park_entrance_tickets",
      "park_ride_tickets",
      "shop_sales",
      "shop_stock",
      "food_drink_sales",
      "food_drink_stock",
      "wages",
      "marketing",
      "research",
      "interest"
    ];

    var result = 0;
    var str = "";

    ui.registerMenuItem("Expenditure Table Test", function () {
      var wdw = ui.openWindow({
        classification: "expenditure_table_test",
        title: "Expenditure Table Test",
        width: 360,
        height: 80,
        widgets: [
          {
            type: "spinner",
            name: "spinner-choose-month",
            x: 5,
            y: 20,
            width: 100,
            height: 14,
            text: selectedMonth + " months ago",
            onDecrement: function () {
              selectedMonth--;
              if (selectedMonth < 0) {
                selectedMonth = 0;
              }
            },
            onIncrement: function () {
              selectedMonth++;
              if (selectedMonth > 15) {
                selectedMonth = 15;
              }
            }
          },
          {
            type: "dropdown",
            name: "dropdown-choose-type",
            x: 110,
            y: 20,
            width: 120,
            height: 14,
            items: expTypes,
            onChange: function (idx) {
              selectedType = idx;
            }
          },
          {
            type: "button",
            name: "button-fetch",
            x: 235,
            y: 20,
            width: 50,
            height: 14,
            text: "Fetch",
            onClick: function () {
              result = park.getMonthlyExpenditure(expTypes[selectedType])[
                selectedMonth
              ];
              str =
                "Expenditure for " +
                expTypes[selectedType] +
                " is $" +
                result / 10 +
                " (" +
                selectedMonth +
                " months ago).";
              console.log(str);
            }
          },
          {
            type: "label",
            name: "label-result",
            x: 5,
            y: 40,
            width: 350,
            height: 14,
            text: str
          }
        ],
        onUpdate: function () {
          wdw.findWidget("spinner-choose-month").text =
            selectedMonth + " months ago";
          wdw.findWidget("dropdown-choose-type").selectedIndex = selectedType;
          wdw.findWidget("label-result").text = str;
        }
      });
      wdw.open();
    });
  }
});

mrmagic2020 · 2024-06-05T04:01:18Z

        IntervalHandle AddInterval(const std::shared_ptr<Plugin>& plugin, int32_t delay, bool repeat, DukValue&& callback);
        void RemoveInterval(const std::shared_ptr<Plugin>& plugin, IntervalHandle handle);

+        static std::string_view ExpenditureTypeToString(ExpenditureType expenditureType);


I moved these two functions to public scope for access in ScPark.cpp.

Basssiiie

Tested it and found no issues. API looks good as well. Nice work! 🙂

- Feature: [#622] Add option to align the top toolbar buttons horizontally centred (off by default). - Feature: [#20263] Ability to increase the size of the map in the (0, 0) direction. - Feature: [#21714] [Plugin] Costume assignment is now tailored to each staff type. - Feature: [#21853] Enlarged UI mode. - Feature: [#21893, #22065] On launch, the game now indicates what system is being initialised. - Feature: [#21913] [Plugin] Allow precise and safe control of peep animations. - Feature: [#22046] [Plugin] Add interface for crashed vehicle particle. - Feature: [#22085] [Plugin] The result of actions that create banners now includes the bannerIndex. - Feature: [#22087] [Plugin] Expose guests’ favourite rides to the plugin API. - Feature: [#22090] [Plugin] Allow writing of paused state in non-networked settings. - Feature: [#22140] Add option to automatically close dropdown menus if Enlarged UI is enabled. - Feature: [#22150] [Plugin] Expose monthly expenditure history to the plugin API. - Feature: [#22210] [Plugin] Peeps can now be made stationary or completely frozen. - Feature: [#22210] [Plugin] The direction in which a peep is facing can now be manipulated. - Improved: [#19870] Allow using new colours in UI themes. - Improved: [#21774] The Alpine Coaster now supports using the alternative colour schemes. - Improved: [#21853] Dropdowns now automatically use multiple columns if they are too tall for the screen. - Improved: [#21981] Rendering performance of the map window has been improved considerably. - Improved: [#21981] The map window now defaults to showing as much of the map as fits the screen. - Improved: [#21983] Taking a screenshot now shows a message again, closing when taking another. - Improved: [#22026] The options window now stays centred when window scaling is changed. - Improved: [#22060] [Plugin] The scroll wheel can now be used to modify spinner widget values in custom/script windows. - Improved: [#22065] Joining a network game now indicates progress using coaster trains. - Improved: [#22075] [Plugin] Plugins can now use G1 Icons. - Improved: [#22084] The game now temporarily pauses while the load/save window is open. - Improved: [#22217] See-through items are ignored again in viewport/pointer interaction. - Improved: [objects#238] Add preview image for invisible queue. - Improved: [objects#329] Add RCT1AA lay-down coaster trains (for import only). - Change: [#7248] Small mini-maps are now centred in the map window. - Change: [#20240] Heavy snow and blizzards now make guests buy and use umbrellas. - Change: [#21043] The new music styles are no longer added to old parks automatically. - Change: [#21214] Wacky Worlds and Time Twister’s scenario names now match their park names. - Change: [#21991] UI themes JSON now use colour names and a translucency bool, instead of a number (old themes still work). - Change: [#22057] Reorder Time Twister’s scenarios and adjust their difficulty classification. - Change: [#22173] Patrol path selection is visible over existing patrol paths. - Change: [#22196] Make track navigation buttons holdable. - Change: [#22227] [Plugin] Ride prices are now constrained for plugins as well. - Fix: [#13234] Vehicle weight sometimes wrong after using Remove All Guests cheat. - Fix: [#13294] Map corners are cut off in some directions (original bug). - Fix: [#14630] Non-ASCII thousands and decimal separators not processed correctly. - Fix: [#21496] Some RCT1 scenery is hidden after saving and reloading. - Fix: [#21533] Support glitches on Hybrid Coaster. - Fix: [#21974] No reason specified when attempting to place benches, lamps, or bins on path with no unconnected edges (original bug). - Fix: [#21987] [Plugin] API cannot handle negative removal prices. - Fix: [#22008] Uninverted Lay-down roller coaster uses the wrong support type. - Fix: [#22012] [Plugin] Images on ImgButton widgets cannot be updated. - Fix: [#22121] Some news items in the “Recent Messages” window have the wrong text colour. - Fix: [#22152] [Plugin] Negative signed integers are truncated. - Fix: [#22161] Using arrow keys in textboxes crashes the game. - Fix: [#22174] Cheats are reset when starting a server. - Fix: [#22185] Intensity and nausea are incorrectly sorted in the rides list after ratings invalidation. - Fix: [#22226] Red traffic light shows incorrect sprite when pressed. - Fix: [objects#323] Incorrect wall boundaries on large WW/TT scenery objects. - Fix: [objects#331] Incorrect hover car capacity string. - Fix: [objects#334] Incorrect school bus capacity string. - Fix: [objects#337] Swan Boats use an incorrect third remap colour (original bug).

Release v0.4.12 - Feature: [OpenRCT2#622] Add option to align the top toolbar buttons horizontally centred (off by default). - Feature: [OpenRCT2#20263] Ability to increase the size of the map in the (0, 0) direction. - Feature: [OpenRCT2#21714] [Plugin] Costume assignment is now tailored to each staff type. - Feature: [OpenRCT2#21853] Enlarged UI mode. - Feature: [OpenRCT2#21893, OpenRCT2#22065] On launch, the game now indicates what system is being initialised. - Feature: [OpenRCT2#21913] [Plugin] Allow precise and safe control of peep animations. - Feature: [OpenRCT2#22046] [Plugin] Add interface for crashed vehicle particle. - Feature: [OpenRCT2#22085] [Plugin] The result of actions that create banners now includes the bannerIndex. - Feature: [OpenRCT2#22087] [Plugin] Expose guests’ favourite rides to the plugin API. - Feature: [OpenRCT2#22090] [Plugin] Allow writing of paused state in non-networked settings. - Feature: [OpenRCT2#22140] Add option to automatically close dropdown menus if Enlarged UI is enabled. - Feature: [OpenRCT2#22150] [Plugin] Expose monthly expenditure history to the plugin API. - Feature: [OpenRCT2#22210] [Plugin] Peeps can now be made stationary or completely frozen. - Feature: [OpenRCT2#22210] [Plugin] The direction in which a peep is facing can now be manipulated. - Improved: [OpenRCT2#19870] Allow using new colours in UI themes. - Improved: [OpenRCT2#21774] The Alpine Coaster now supports using the alternative colour schemes. - Improved: [OpenRCT2#21853] Dropdowns now automatically use multiple columns if they are too tall for the screen. - Improved: [OpenRCT2#21981] Rendering performance of the map window has been improved considerably. - Improved: [OpenRCT2#21981] The map window now defaults to showing as much of the map as fits the screen. - Improved: [OpenRCT2#21983] Taking a screenshot now shows a message again, closing when taking another. - Improved: [OpenRCT2#22026] The options window now stays centred when window scaling is changed. - Improved: [OpenRCT2#22060] [Plugin] The scroll wheel can now be used to modify spinner widget values in custom/script windows. - Improved: [OpenRCT2#22065] Joining a network game now indicates progress using coaster trains. - Improved: [OpenRCT2#22075] [Plugin] Plugins can now use G1 Icons. - Improved: [OpenRCT2#22084] The game now temporarily pauses while the load/save window is open. - Improved: [OpenRCT2#22217] See-through items are ignored again in viewport/pointer interaction. - Improved: [objects#238] Add preview image for invisible queue. - Improved: [objects#329] Add RCT1AA lay-down coaster trains (for import only). - Change: [OpenRCT2#7248] Small mini-maps are now centred in the map window. - Change: [OpenRCT2#20240] Heavy snow and blizzards now make guests buy and use umbrellas. - Change: [OpenRCT2#21043] The new music styles are no longer added to old parks automatically. - Change: [OpenRCT2#21214] Wacky Worlds and Time Twister’s scenario names now match their park names. - Change: [OpenRCT2#21991] UI themes JSON now use colour names and a translucency bool, instead of a number (old themes still work). - Change: [OpenRCT2#22057] Reorder Time Twister’s scenarios and adjust their difficulty classification. - Change: [OpenRCT2#22173] Patrol path selection is visible over existing patrol paths. - Change: [OpenRCT2#22196] Make track navigation buttons holdable. - Change: [OpenRCT2#22227] [Plugin] Ride prices are now constrained for plugins as well. - Fix: [OpenRCT2#13234] Vehicle weight sometimes wrong after using Remove All Guests cheat. - Fix: [OpenRCT2#13294] Map corners are cut off in some directions (original bug). - Fix: [OpenRCT2#14630] Non-ASCII thousands and decimal separators not processed correctly. - Fix: [OpenRCT2#21496] Some RCT1 scenery is hidden after saving and reloading. - Fix: [OpenRCT2#21533] Support glitches on Hybrid Coaster. - Fix: [OpenRCT2#21974] No reason specified when attempting to place benches, lamps, or bins on path with no unconnected edges (original bug). - Fix: [OpenRCT2#21987] [Plugin] API cannot handle negative removal prices. - Fix: [OpenRCT2#22008] Uninverted Lay-down roller coaster uses the wrong support type. - Fix: [OpenRCT2#22012] [Plugin] Images on ImgButton widgets cannot be updated. - Fix: [OpenRCT2#22121] Some news items in the “Recent Messages” window have the wrong text colour. - Fix: [OpenRCT2#22152] [Plugin] Negative signed integers are truncated. - Fix: [OpenRCT2#22161] Using arrow keys in textboxes crashes the game. - Fix: [OpenRCT2#22174] Cheats are reset when starting a server. - Fix: [OpenRCT2#22185] Intensity and nausea are incorrectly sorted in the rides list after ratings invalidation. - Fix: [OpenRCT2#22226] Red traffic light shows incorrect sprite when pressed. - Fix: [objects#323] Incorrect wall boundaries on large WW/TT scenery objects. - Fix: [objects#331] Incorrect hover car capacity string. - Fix: [objects#334] Incorrect school bus capacity string. - Fix: [objects#337] Swan Boats use an incorrect third remap colour (original bug).

mrmagic2020 commented Jun 5, 2024

View reviewed changes

mrmagic2020 force-pushed the plugin-api-expenditure-table branch from 3d0815c to b199261 Compare June 6, 2024 07:04

janisozaur requested changes Jun 14, 2024

View reviewed changes

Comment thread src/openrct2/scripting/bindings/world/ScPark.cpp Outdated

mrmagic2020 added 2 commits June 15, 2024 17:56

feat: expose monthly expenditure history

05e0a02

chore: add changelog entry

d37d655

mrmagic2020 force-pushed the plugin-api-expenditure-table branch from b199261 to d37d655 Compare June 15, 2024 07:57

fix: vector size is always 16

6cb556c

mrmagic2020 requested a review from janisozaur June 15, 2024 08:40

janisozaur approved these changes Jun 16, 2024

View reviewed changes

Gymnasiast requested a review from Basssiiie June 21, 2024 10:28

Basssiiie approved these changes Jun 22, 2024

View reviewed changes

Gymnasiast merged commit a0f5d09 into OpenRCT2:develop Jun 23, 2024

tupaschoal added this to the v0.4.12 milestone Jun 23, 2024

mrmagic2020 deleted the plugin-api-expenditure-table branch June 24, 2024 00:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Plugin API] feat: expose monthly expenditure history#22150

[Plugin API] feat: expose monthly expenditure history#22150
Gymnasiast merged 3 commits into
OpenRCT2:developfrom
mrmagic2020:plugin-api-expenditure-table

mrmagic2020 commented Jun 5, 2024

Uh oh!

mrmagic2020 Jun 5, 2024

Uh oh!

Uh oh!

Basssiiie left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

mrmagic2020 commented Jun 5, 2024

Uh oh!

mrmagic2020 Jun 5, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Basssiiie left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants