VsConvertEscapeCharacters - Custom escape characters

じ☆ve冰风

VsConvertEscapeCharacters + 1.1.0
VsRpgDev​

Introduction
This plugin allows you to register custom escape characters, which lets you, for example, access custom values from your plugin, trigger methods, draw images, etc., when a text message is displayed.
Additionally, you can use convertEscapeCharacters from anywhere in the code through the static class VsConvertEscapeCharacters.

Readme

Features

• registerEscapeCharacter
  registers a new escaped character
  
• registerProcessEscapeCharacter
  register a new escaped character (gets handled later then registerEscapeCharacter)
  
• convertEscapeCharacters
  converts escaped characters in a text
  

How to Use
registerEscapeCharacter
                JavaScript:       

1. // arrow functions -------------
2. VsConvertEscapeCharacters.registerEscapeCharacter("X",(text)=> {
3.   return "your text was "+text;
4. });
5. // old style -------------------
6. function ReplaceText(text)
7. {
8.   return "your text was "+text;
9. }
10. VsConvertEscapeCharacters.registerEscapeCharacter("X",ReplaceText);

复制代码

registerProcessEscapeCharacter
                JavaScript:       

1. // arrow functions -------------
2. VsConvertEscapeCharacters.registerProcessEscapeCharacter("X",(currentWindow, textState, param)=> {
3.   //do whatever you like
4.   //example draw icon
5.   currentWindow.processDrawIcon(param, textState);
6. });
7. // old style -------------------
8. function CustomMethod(currentWindow, textState, param)
9. {
10.   return "your text was "+text;
11.   //do whatever you like
12.   //example draw icon
13.   currentWindow.processDrawIcon(param, textState);
14. }
15. VsConvertEscapeCharacters.registerProcessEscapeCharacter("X",CustomMethod);

复制代码

convertEscapeCharacters - get escaped character from wherever you want
                JavaScript:       

1. finalText = VsConvertEscapeCharacters.convertEscapeCharacters(text);

复制代码

Plugin Commands / Script Calls
                JavaScript:       

1. declare class VsConvertEscapeCharacters
2. {
3.     static convertEscapeCharacters(text: string) : string;
4.     static actorName(n: string) : string;
5.     static partyMemberName (n:string) : string;
6.     /**
7.      * register a new escape character
8.      * @param char escape character to use
9.      * @param method callback method which gets the paramter from within the brackets [] and should return the replacement text
10.      */
11.     static registerEscapeCharacter(char : string, method: (string)=>string) : string;
13.     /**
14.      * retursn all registered escape characters
15.      */
16.     static get CustomEscapeCharacters() :  { [id: string]:(string)=>string; };
18.     /**
19.      * register process escape character, these get processed character by character when the textbox draws the message text
20.      * @param char scape character to use
21.      * @param method callback method which gets the the current windows, the textstate and paramter from within the brackets [] and should return the replacement text
22.      */
23.     static registerProcessEscapeCharacter(char : string, method: (windowBase:Window_Base, state: TextState, param: string)=>void) : string;
25.     static get ProcessEscapeCharacter() :  { [id: string]: (windowBase:Window_Base, state: TextState, param: string)=>void; };
26. }

复制代码

Changes to the core script

• rmmz_windows.js
  
  
  
  • Window_Base
    
    
    
    • [M] convertEscapeCharacters: overrides,original gets called after
      
    • [M] processEscapeCharacter: overrides,original gets called after
      
    
    
  
  

The plugin should work with all other plugins as long as convertEscapeCharacters and processEscapeCharacter are still called.

Demo
demo.js

Download
VsConvertEscapeCharacters.js (Plugin)
Github Repository

Terms and Credits
VsConvertEscapeCharacters is marked with CC0 1.0 Universal. To view a copy of this license, visit https://creativecommons.org/publicdomain/zero/1.0/
This plugin can be used in any project, commercial or otherwise. no credit needed.


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