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

Eliaquim

Hakuen Studio
Veteran
Joined
May 22, 2018
Messages
1,610
Reaction score
976
First Language
Portuguese - Br
Primarily Uses
RMMV

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 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
159
Reaction score
31
First Language
Indonesia
Primarily Uses
RMMV
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,610
Reaction score
976
First Language
Portuguese - Br
Primarily Uses
RMMV
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,610
Reaction score
976
First Language
Portuguese - Br
Primarily Uses
RMMV
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]]
 

Users Who Are Viewing This Thread (Users: 0, Guests: 1)

Latest Threads

Latest Posts

Latest Profile Posts

I always told my DA fans how much I hate slot machines. They're fine in games as a risk-and-reward system. But when you're spending REAL MONEY in a Vegas casino to try and hit the jackpot (which very, very few people will), it can really hurt your budget. Gambling is a bad habit, and I don't like wasting my money on a slim chance. Go to Vegas for the experience, not the jackpot.
Took the kids to a corn maze. They gave us a map and had lights at certain points in the maze. Not overwhelming... or underwhelming... just... whelming.
Okay, vacuuming fruit flies out of the air is surprisingly effective.
Finally finished my menu redesign after like a month of coding! I hate designing menus... Good news though - I thought of a complete redesign for it now, so yay...
Still no scam calls all day... also I got a quick gig designing a mascot drawing for a small business, so I might actually make some green of my own after all. That would be a perfect job for me, since I love art and digital design.

Forum statistics

Threads
104,391
Messages
1,006,038
Members
135,920
Latest member
chelsandherself
Top