SES Lexicon (Browse script source in-game.)

じ☆ve冰风

SES Lexicon v1.2
by Solistra and Enelvon​

Introduction
This script provides information and browsing capabilities for all of the RGSS3 scripts that are present in the RPG Maker VX Ace Script Editor. Script source code may be browsed and paginated in-game with the use of a REPL (such as the SES Console) or using script calls.

Change Log

• v1.2 (April 18th, 2014) - Enhanced Pager functionality.
  
• v1.1 (April 14th, 2014) - Documented, some API changes.
  
• v1.0 (April 14th, 2014) - Initial release.
  

Features

• Browse game source code while the game is running.
  
• Paginate output, allowing large scripts to be browsed.
  
• Easily discover which scripts define or redefine classes and modules.
  
• Search for scripts by partial name with strings or regular expressions.
  

Screenshot
Spoiler

​

Usage
This script is designed to function entirely through a REPL or script calls (although the latter is not recommended). As such, all of the available functionality of this script is available through simple methods.

In order to browse the source code of a script, simply use the provided SES::Lexicon.browse method with the file name of the script you wish to view. Example:
 
                Code:       

1. SES::Lexicon.browse('Game_Interpreter’)

复制代码

This method opens the given script in the pager, allowing paginated browsing of the script's source code. Without pagination, it's very likely that a significant portion of the script may be swallowed by the console's buffer (especially when viewing large scripts such as Game_Interpreter).

If you need to view a specific line or chunk of source code, you can use the SES::Lexicon.line method. The usage of this method involves providing the script name, line number, and (optionally) the number of lines around the requested line number to display as well. For example, if we wanted to view the update method of Scene_Base and the 5 lines of code both above and below that method, we would use the following:
 
                Code:       

1. SES::Lexicon.line('Scene_Base', 40, 5)

复制代码

There are also two methods provided for information-gathering purposes: SES::Lexicon.named and SES::Lexicon.defining. As expected, the named method returns an array of script names containing the given string or regular expression, and the defining method returns an array of scripts which define or redefine the given class or module. Examples:
 
                Code:       

1. SES::Lexicon.named('Manager') # => ["DataManager", "SceneManager", "BattleManager"]SES::Lexicon.defining('Cache') # => ["Cache”]

复制代码

The defining method can also take partial class or module names and will return an array of script names which match the partial information given. For example, you can easily view which scripts modify any of the Scene_* classes using SES::Lexicon.defining('Scene_’).

The Lexicon also enables direct reading of the script information that it stores. This information is provided as a reader method for the Lexicon's @scripts instance variable. The elements of this array store information as a hash -- each hash includes the :name and :code keys which provide the expected information when accessed. For example, if you want to simply print the contents of Main to the console, you could use the following:
 
                Code:       

1. puts SES::Lexicon.scripts[-2][:code]

复制代码

Using the Pager
The Lexicon's pager paginates large text so that it can be viewed in pages which may be navigated with commands. When using the pager, you will come across a string at the bottom of the paged output with >> at the end of it; this indicates that a command is expected.

By default, giving no command (by simply pressing Enter) will advance the pager to the next page of text; this is exactly the same as giving any of the following commands: >, forward, next, or down. You may browse the previous page of text with <, back, prev, previous, or up.

In addition to this, you can browse a specific number of pages forward or backward in the paginated text by passing a valid integer as the command. Positive integers advance the text forward, negatives show previous pages of the text. You may browse between -99 and 99 pages at a time; any number above or below these values is not a valid command.

In order to exit the pager, simply pass any of the following commands: q, quit, or exit. This will cause the pager to immediately terminate and return the position of the pager in the paginated text.

Script
This script is available from SES VX Ace.

Installation
Place this script below the SES Core (v2.0) and SES Console (v1.1) scripts (if you are using them) or the Materials header, but above Main. This script does not require the SES Core (v2.0) or SES Console (v1.1), but they are recommended.

Credit and Thanks

• Solistra
  
• Enelvon
  

Author's Notes
This script is made available under the terms of the MIT Expat license. View this page for more information.


本贴来自国际rpgmaker官方论坛作者:Solistra处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/ses-lexicon-browse-script-source-in-game.26790/