• Do not use Discord to host any images you post, these links expire quickly! You can learn how to add images to your posts here.
  • Reminder: AI-generated content is not allowed on the forums per the Rules and Regulations. Please contact us if you have any questions!
Resource icon

v21.1 Event Reporting (fka Switch and Variable Usage Report) 2.0

This resource pertains to version 21.1 of Pokémon Essentials.
Pokémon Essentials Version
v21.1 ✅
Also compatible with
  1. v20.1
Have you ever used a switch or variable in many events in your game, so you can't keep track which ones are checking or using it? What if you need to reorganize your switch or variables and have to redo that setup in your events? Do you want to find all places you use a certain audio file so you can replace it with a better one? Do you want an easy way to find an event with "Todo" written somewhere so you can take action on that task?

Now, you can run reports that tells you information about events that can help you with the questions above.

Report Types
  • Switch Usage Report - Find switches in page Conditions, Control Switch commands, Script commands, and Conditional Branches.
  • Variable Usage Report - Find variables in page Conditions, Control Variable commands, Script commands, and Conditional Branches.
  • Audio Usage Report - Find audio files used in the various Play X commands and Script commands.
  • Comments Usage Report - Find a string used in event Names, Comment commands, or Script command comments (after #).

Report Structure
When you run the report, it will tell you the following information:
  • The map ID and name the event(s) is found in
  • The event ID, name, and x, y coordinates
  • The page the that the criteria is being checked/used in
  • Whether it's being checked in the page's Conditions section, or checked/used in the Event Commands.
  • The type of command that's using it (Ex: Script command, Control Switch/Variable command, Conditional Branch) and, if applicable, what style of code is checking/setting it (Ex: $game_switches, pbGet, pbSet, pbSEPlay)
Examples:
Code:
Expand Collapse Copy
==============================
==== Switch 1 Event Usage ====
==============================

Map 3 - \PN's house
  Event 9 - Mom [7, 4]
    Page 2
      Conditions
        Switch 1
      Event Commands
        [Line 15] Control Switches command

Code:
Expand Collapse Copy
================================
==== Variable 3 Event Usage ====
================================

Map 2 - Lappet Town
  Event 29 - Icecream maker [19, 7]
    Page 1
      Event Commands
        [Line 29] Script command: $game_variables
        [Line 31] Script command: pbGet
  Event 67 - Size Checker [14, 11]
    Page 1
      Event Commands
        [Line 4] Script command: pbSet
  Event 87 - Icecream maker [19, 8]
    Page 1
      Event Commands
        [Line 11] Script command: $game_variables
        [Line 13] Script command: pbGet
  Event 91 - TR Shards [14, 8]
    Page 1
      Event Commands
        [Line 46] Script command: pbSet
        [Line 53] Script command: pbGet

Setup
Simply install the plugin, and you're all set.

How to use
1) Open the Event Reporting... menu in the Debug menu.
2) Choose a report option.
3) Choose the criteria to search on.
4) Choose whether you want the report to print to the console, or to a file that will be saved to the Event Reports folder in your project's main folder.
5) You're done! Review the report to see which events contain the info you're interested in!

Future
  • No future plans at the moment, but can add new search criteria based on requests.
Credits
wrigty12
Author
wrigty12
Downloads
279
Views
1,044
First release
Last update

Ratings

0.00 star(s) 0 ratings

More resources from wrigty12

Latest updates

  1. 2.0 - Restructure and new features

    This update is a restructure of the plugin. Due to the name change, you must remove the existing...
Back
Top