Cross Reference Tool

Discussion in 'JS Plugin Releases (RMMV)' started by Shaz, Dec 22, 2016.

  1. Shaz

    Shaz Veteran Veteran

    Messages:
    37,712
    Likes Received:
    11,420
    Location:
    Australia
    First Language:
    English
    Primarily Uses:
    RMMV
    Cross Reference Tool
    2016.12.22
    by Shaz

    Introduction
    This plugin shows you where all your database items have been used throughout your project

    How to use
    Add to your plugins folder (name is irrelevant but I use CrossReferenceTool.js). There are no parameters to set and no plugin commands to run.  There will be a new menu option on your Title Screen menu (assuming you don't have a plugin that modifies your Title Screen menu - if you do, just add a SceneManager.push(Scene_XRef); to it somewhere).


    For events, the #:# refers to the page and line numbers.  A 0 means it's a condition rather than an event command.  These are used for common events, troop events, and map events.


    Remove the plugin prior to deployment.  This is a development tool only.

    Plugin
    Download from pastebin

    Credit
    - Shaz

    Terms
    - free for use in the creation of commercial games (plugin should be removed before deployment, whether commercial or not)

    Notes
    - looks for \v[x] escape code in all database text that could be displayed as well as message and choice boxes


    - looks for v[x] codes in damage formulae


    - does NOT look at scripts or plugins, script calls in any event commands, plugin commands, or any other damage box info


    - after launching the game, there will be a delay the first time you choose the XRef option while the references are being retrieved


    - the Change Equipment command, when used with slot 2, will result in both a weapon and an armor reference.  The logic is that only when that command is encountered during play can we know whether the actor, their class, or any of their states allow dual wielding.  So both are retrieved as a 'better safe than sorry' measure.  If this is a pain for the majority of people I will change it and only look at the actor and their class as set in the database.


    - if you have plugins that add more escape codes to message boxes and/or damage formulae and you want to add to this plugin, the functions of interest will be XRefManager.scanDbText and XRefManager.scanDmg - you will need to be familiar with regular expressions.


    Please comment with any issues/errors you encounter.
     
    Last edited by a moderator: Dec 23, 2016
    #1
    Liak, kovak, Halrawk and 4 others like this.
  2. redspark

    redspark Veteran Veteran

    Messages:
    71
    Likes Received:
    20
    First Language:
    English
    Thank you.  This will be very useful. :)
     
    #2
  3. Liak

    Liak Veteran Veteran

    Messages:
    1,789
    Likes Received:
    269
    Location:
    Germany
    First Language:
    German
    Yeah, finally! Very useful! :)  Thank you, Shaz!
     
    #3

Share This Page