Eli Escape Codes - Write almost anything from Database in message/windows!

Eliaquim

Hakuen Studio
Veteran
Joined
May 22, 2018
Messages
1,991
Reaction score
1,460
First Language
Portuguese - Br
Primarily Uses
RMMZ
8IO9Gue.png

Author: Hakuen Studio

Introduction

We already know that we can type \V[ID] to get a variable value to show on the message window. So if we want to show custom information that's not covered by the default escape codes, we can simply put it on the variable and show on
the message. But, this process can be tedious sometimes.
So, this plugin adds new Escape codes that can show a lot of game information inside any window that processes escape characters.

Features

• Add several escape codes to windows that can show a lot of game information!

How to use

Almost plug and play!
All you need to know is the escape codes. But first I will give you a list to help you memorize what every escape codes mean:
AC = Refers to actor
MB = Refers to a party member
CL = Refers to class
NK = Nickname
LV = Level
XP = Current Xp
XP? = Next required Exp
PR = Default parameters
PRX = X parameters
PRS = Special parameters
PRO = Profile
SK = Skills
EQ = Equipments
MT = Meta
IC = Icon
IT = Item
WE = Weapon
AR = Armor
EN = Enemy
ST = State
MAP = Map
DN = Display name
EV = Event
QT = Quantity
OBJ = Refers to a property of the current object
BTNUM = Battles Fought
BTWIN = Battles Win
BTESC = Battles escape
GMTLT = Game title
STEP = Step numbers
ALMB = Alive members
PRTSZ = Party Size
PLTM = Play Time
EVAL = Formula. Can be any valid javascript code.

Knowing that will help you using the plugin. Below contains how you can use the escape codes in the windows and every possible combination of them.

• Actors: Always start with AC.
\AcCl[ID] - Returns the name of this class for this actor id.
\AcNk[ID] - Nickname of this actor.
\AcLv[ID] - Level of this actor.
\AcXp[ID] - Current Exp.
\AcXp?[ID] - Next required Exp.

\AcPr[ActorId[ParamId]] - The value of the parameter of the actor id specified.
0 --> Max HP (MHP)
1 --> Max MP (MMP)
2 --> Attack (ATK)
3 --> Defense (DEF)
4 --> Magic Attack Power (MAT)
5 --> Magic Defense Power (MDF)
6 --> Agility (AGI)
7 --> Luck (LUK)

\AcPrX[ActorId[ParamId]] - The value(%) of the Ex parameter of the actor id specified.
0 --> Hit Rate (HIT)
1 --> Evasion Rate (EVA)
2 --> Critical Rate (CRI)
3 --> Critical Evasion (CEV)
4 --> Magic Evasion (MEV)
5 --> Magic Reflection (MRF)
6 --> Counter Attack (CNT)
7 --> HP Regeneration (HRG)
8 --> MP Regeneration (MRG)
9 --> TP Regeneration (TRG)

\AcPrS[ActorId[ParamId]] - The value(%) of the Special parameter of the actor id specified.
0 --> Target Rate (TGR)
1 --> Guard Effect (GRD)
2 --> Recovery Effect (REC)
3 --> Pharmacology (PHA)
4 --> MP Cost Rate (MCR)
5 --> TP Charge Rate (TCR)
6 --> Physical Damage Rate (PDR)
7 --> Magical Damage Rate (MDR)
8 --> Floor Damage Rate (FDR)
9 --> Experience Rate (EXR)

\AcPro[ID] - The profile.
\AcSk[ActorId[SkillIndex]] - It will return the skill of the actor in the specified index.
\AcEq[ActorId[EquipSlot]] - The equipment name on the specified slot.
\AcMt[ActorId[MetaName]] - It will return the value of the meta tag of this actor.
\AcObj[ID[Property]] - This means that you can show a property of an object using their names.
Ex: \AcObj[1[_hp]]


NOTE: You can safely replace AC(for actors) with MB(For party members).
The difference is that using MB you will have to reference not for the ID, but instead, with the party position/index.
Ex:
\MbCl[INDEX] - Returns member class
\MbPro[INDEX] - Returns member profile

• Class:
\Cl[ID] - Return the name of the class id.
\ClMt - It will return the value of the meta tag of this class.

• Skills:
\Sk[ID] - The name of this skill id.
\SkIc[ID] - The name of this skill id with the icon.
\SkMt[SkillId[MetaName]] - It will return the value of the meta tag of this skill.

• Items:
\It[ID] - The name of this item id.
\ItIc[ID] - The name of this item id with the icon.
\ItMt[ItemId[MetaName]] - It will return the value of the meta tag of this item.
\ItQt[ID] - Item number.

• Weapons:
\We[ID] - The name of this weapon id.
\WeIc[ID] - The name of this weapon id with the icon.
\WeMt[WeaponId[MetaName]] - It will return the value of the meta tag of this weapon.
\WeQt[ID] - Weapon number.

• Armors:
\Ar[ID] - The name of this armor id.
\ArIc[ID] - The name of this armor id with the icon.
\ArMt[ArmorId[MetaName]] - It will return the value of the meta tag of this armor.
\ArQt[ID] - Armor number.

• Enemy:
\En[ID] - The name of this enemy id.
\EnPr[EnemyId[ParamId]] - The default parameter of this enemy id.
\EnMt[EnemyId[MetaName]] - It will return the value of the meta tag of this enemy.

• States:
\St[ID] - The name of this state id.
\StIc[ID] - The name of this state id with the icon.
\StMt[StateId[MetaName]] - It will return the value of the meta tag of this state.

• Map:
\Map[ID] - The name of the map id. If zero will return the current map name.
\MapDn - The display name of the current map.
\MapMt[MetaName] - It will return the value of the meta tag of the current map.

• Event:
\EvNm[ID] - The name of the event id. If the ID is zero, it will return the name of the current event.
\EvX[ID] - The X position.
\EvY[ID] - The X position.
\EvPos[ID] - The X and Y position.
\EvDir[ID] - The direction.

• Misc:
\BtNum - Returns the number of battles already fought.
\BtWin - Returns the number of battles won.
\BtEsc - The number of battle escapes.
\GmTlt - The game title.
\Step - The number of steps.
\AlMb - The number of alive members.
\PrtSz - The size of the party.
\PlTm - The playtime.
\Var[ID[Index]] - Show value from an array of a game variable.
\Eval[formula] - You can show anything in the message using formulas.
This is an advanced one and you have to know a minimum of javascript or at least the script calls of MZ.

Terms of Use

https://www.hakuenstudio.com/rpg-maker/terms-of-use

Update Log
Version 2.2.0 - 05/17/2021
- Added four new escape codes to show custom parameter values through actor id or member index.
- Add the option to change the existing escape codes to your liking, via plugin parameters.
Version 2.1.0 - 05/15/2021
- Added two new escape codes: Eval(new one) and conditional.
Version 2.0.1 - 04/12/2021
- Fixed an issue that some windows are not converting an escape character inside the \eval
Version 2.0.0 - 12/18/2020
- Adapted to work with Eli Book 3.0.0.
Version 1.1.1 - 10/31/2020
- Fixed error to show battle codes.
- Fixed error on getting alive members.
- Fixed error with showing game title escape code. Somehow GMTLT was not working. Changed to TLT.
- Fixed an error when getting actor metadata with party member codes.
Version 1.1.0 - 10/14/2020
- Add party codes.
- Add misc codes.
- Add eval codes.
- Add code to show array values from game variables.
Version 1.0.0 - 09/21/2020
- Plugin release!
 
Last edited:

Jrrkein

Insert Witty Title Here
Veteran
Joined
Apr 20, 2014
Messages
265
Reaction score
111
First Language
Indonesian
Primarily Uses
RMMZ
I still question how to display current HP/MP than showing max HP/MP since we can do in the variable, but how to do that with this plugin?
 

Eliaquim

Hakuen Studio
Veteran
Joined
May 22, 2018
Messages
1,991
Reaction score
1,460
First Language
Portuguese - Br
Primarily Uses
RMMZ
I still question how to display current HP/MP than showing max HP/MP since we can do in the variable, but how to do that with this plugin?
Oh, that's right. I didn't think about that. I will implement it in the next update :)
 

Eliaquim

Hakuen Studio
Veteran
Joined
May 22, 2018
Messages
1,991
Reaction score
1,460
First Language
Portuguese - Br
Primarily Uses
RMMZ
Updated first post.
Version 1.1.0 - 10/14/2020
- Add party codes.
- Add misc codes.
- Add eval codes.
- Add code to show array values from game variables.

@Jrrkein I have added the feature you requested. You can achieve it by using one of these codes:

\AcPrc[ActorId[ParamId]] - This is for current parameters.
0 --> Current Hp
1 --> Current Mp
2 --> Current Tp


or using party members:

\MbPrc[index[ParamId]] - This is for current parameters.
0 --> Current Hp
1 --> Current Mp
2 --> Current Tp


You can even replace Prc with Obj, and use the name of the param instead:
\AcObj[ActorId[_hp]]
\MbObj[index[_hp]]
 

Eliaquim

Hakuen Studio
Veteran
Joined
May 22, 2018
Messages
1,991
Reaction score
1,460
First Language
Portuguese - Br
Primarily Uses
RMMZ
Version 1.1.1 - 10/31/2020
- Fixed error to show battle codes.
- Fixed error on getting alive members.
- Fixed error with showing game title escape code. Somehow GMTLT was not working. Changed to TLT.
- Fixed an error when getting actor metadata with party member codes.
 

Eliaquim

Hakuen Studio
Veteran
Joined
May 22, 2018
Messages
1,991
Reaction score
1,460
First Language
Portuguese - Br
Primarily Uses
RMMZ
Version 2.0.1 - 04/12/2021
- Fixed an issue that some windows are not converting an escape character inside the \eval
 
Last edited:

Eliaquim

Hakuen Studio
Veteran
Joined
May 22, 2018
Messages
1,991
Reaction score
1,460
First Language
Portuguese - Br
Primarily Uses
RMMZ
Version 2.1.0 - 05/15/2021
- Added two new escape codes: Eval(new one) and conditional.

Added new info on the help file:

Now there are two new special escape codes, that needs a better explanation:

• The new Eval escape code​

I had to create a new one, because if you use the older like below, it will not properly eval the code:

\Eval[ $gameParty.members()[0].name() ]

Because there is another bracket character in the formula "[0]"

So now, you can use this one instead:
  • =|YourText|= - This will Eval the text between =| |=
Example:
  • =| $gameParty.members()[0].name() |=
NOTE²: The old one was not removed.

• The conditional message escape code:​

?{condition ? result1 : result2}? - This is a conditional message.

If the condition is true, then it will return result1. Otherwise, result 2.

Example:

?{$gameVariables.value(1) > 0 ? Is greater than zero : Is less than zero}?

If the variable 1 is higher than 0, it will return the message "Is greater than zero".

Otherwise, it will return the message "Is less than zero". The only thing you should know about these two is that you cannot use a formula together with an escape code. If you use it, the text will not convert properly:

?{$gameVariables.value(1) > 0 ? scriptCall \v[1] : scriptCall \i[34]}?

=|
scriptCall \i[24]|=
 

Eliaquim

Hakuen Studio
Veteran
Joined
May 22, 2018
Messages
1,991
Reaction score
1,460
First Language
Portuguese - Br
Primarily Uses
RMMZ
Version 2.2.0 - 05/17/2021
- Added four new escape codes to show custom parameter values through actor id or member index.
- Add the option to change the existing escape codes to your liking, via plugin parameters.

Screenshots
parameters.png
 

Latest Threads

Latest Posts

Latest Profile Posts

Working on a slightly experimental horror game. It will be finished in approximately 88888888888 years.
Y'all will enjoy it though, I put lots of effort into making it stand out.

It's called Red Light and it's inspired by another obscure RPG Maker horror game, but I don't want to give too much away just yet.
Ohh man, Weapon animations plugin feels so mandatory. Seeing that same image regardless of the icon of the weapon....ugh :p
Ok so......Maaaaybe I've taken a ''little'' bit of inspiration from FF9 when it comes to battle hud xD

ff9.PNG

Just maybe....
New version of my wife's art for Tundra's opening map. No new version of Katrina yet, but I think this looks awesome.1624062754755.png

Forum statistics

Threads
112,354
Messages
1,067,706
Members
146,002
Latest member
Raytoly
Top