Difference between revisions of "Template:VisuMZ Core Engine Notetags"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Quality of Life)
(JavaScript Notetags: Basic, X, and S Parameters)
 
Line 531: Line 531:
 
- This is used to calculate the 'flatBonus' portion in Parameter Settings =>
 
- This is used to calculate the 'flatBonus' portion in Parameter Settings =>
 
   S Parameter => Formula.
 
   S Parameter => Formula.
 +
</pre>
 +
 +
---
 +
 +
=== Battle Setting-Related Notetags ===
 +
 +
These tags will change the settings for battle regardless of how the battle
 +
system is set up normally. Insert these tags in either the noteboxes of maps
 +
or the names of troops for them to take effect. If both are present for a
 +
specific battle, then priority goes to the setting found in the troop name.
 +
 +
---
 +
 +
<pre>
 +
<FV>
 +
<Front View>
 +
<Battle View: FV>
 +
<Battle View: Front View>
 +
 +
- Used for: Map Notetags and Troop Name Tags
 +
- Changes the perspective of battle to front view for this specific map or
 +
  battle.
 +
- Make sure you have the enemy image files available in the img/enemies/
 +
  folder as they will used instead of the "sv_enemies" graphics.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<SV>
 +
<Side View>
 +
<Battle View: SV>
 +
<Battle View: Side View>
 +
 +
- Used for: Map Notetags and Troop Name Tags
 +
- Changes the perspective of battle to side view for this specific map or
 +
  battle.
 +
- Make sure you have the enemy image files available in the img/sv_enemies/
 +
  folder as they will used instead of the "enemies" graphics.
 +
- Make sure your actors have "sv_actor" graphics attached to them.
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<DTB>
 +
<Battle System: DTB>
 +
 +
- Used for: Map Notetags and Troop Name Tags
 +
- Changes the battle system to the default battle system (DTB).
 +
</pre>
 +
 +
---
 +
 +
<pre>
 +
<TPB Active>
 +
<ATB Active>
 +
<Battle System: TPB Active>
 +
<Battle System: ATB Active>
 +
 +
- Used for: Map Notetags and Troop Name Tags
 +
- Changes the battle system to the time progress battle system (TPB) or
 +
  active turn battle system (ATB) if you have VisuMZ_2_BattleSystemATB
 +
  installed for the game project.
 
</pre>
 
</pre>
  
 
---
 
---

Latest revision as of 03:36, 27 September 2020


The following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present.

Actors

Parameter limits can be adjusted in the Plugin Parameters, but this won't lift the ability to change the values of an actor's initial or max level past the editor's limits. Instead, this must be done through the usage of notetags to accomplish the feat.

---

<Max Level: x>

- Used for: Actor Notetags
- Replace 'x' with an integer to determine the actor's max level.
- This allows you to go over the database limit of 99.
- If this notetag isn't used, default to the actor's database value.

---

<Initial Level: x>

- Used for: Actor Notetags
- Replace 'x' with an integer to determine the actor's initial level.
- This allows you to go over the database limit of 99.
- If this notetag isn't used, default to the actor's database value.

---

Classes

As actor levels can now surpass 99 due to the notetag system, there may be some skills you wish certain classes can learn upon reaching higher levels past 99, too.

---

<Learn At Level: x>

- Used for: Class Skill Learn Notetags
- Replace 'x' with an integer to determine the level this class will learn
  the associated skill at.
- This allows you to go over the database limit of 99.
- If this notetag isn't used, default to the class's database value.

---

Enemies

Enemies are now given levels. The levels don't do anything except to serve as a container for a number value. This way, levels can be used in damage formulas (ie. a.atk - b.level) without causing any errors. To give enemies levels, use the notetags below. These notetags also allow you to adjust the base parameters, EXP, and Gold past the database limitations.

---

<Level: x>

- Used for: Enemy Notetags
- Replace 'x' with an integer to determine the enemy's level.
- If no level is declared, the level will default to 1.

---

<param: x>

- Used for: Enemy Notetags
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to alter.
- Replace 'x' with an integer to set an enemy's 'param' base value.
- This will overwrite the enemy's database value and can exceed the original
  value limitation in the database.
- If these notetags aren't used, default to the enemy's database value.

---

<EXP: x>
<Gold: x>

- Used for: Enemy Notetags
- Replace 'x' with an integer to determine the enemy's EXP or Gold values.
- This will overwrite the enemy's database value and can exceed the original
  value limitation in the database.
- If these notetags aren't used, default to the enemy's database value.

---

Animations

CoreEngineAnimationNotetags.png

Animations in RPG Maker MZ are done by Effekseer and the animation system has been revamped. However, the animations are only centered on the targets now, and cannot be attached to the head or foot. Insert these tags into the names of the animations in the database to adjust their positions.

---

<Head>
<Foot>

- Used for: Animation Name Tags
- Will set the animation to anchor on top of the sprite (if <Head> is used)
  or at the bottom of the sprite (if <Foot> is used).

---

<Anchor X: x>
<Anchor Y: y>

<Anchor: x, y>

- Used for: Animation Name Tags
- Will anchor the animation at a specific point within the sprite based on
  the 'x' and 'y' values.
- Replace 'x' and 'y' with numeric values representing their positions based
  on a rate where 0.0 is the furthest left/up (x, y respectively) to 1.0 for
  the furthest right/down (x, y respectively).

Examples:

<Anchor X: 0.4>
<Anchor Y: 0.8>

<Anchor: 0.2, 0.9>

---

<Offset X: +x>
<Offset X: -x>
<Offset Y: +y>
<Offset Y: -y>

<Offset: +x, +y>
<Offset: -x, -y>

- Used for: Animation Name Tags
- Will anchor the animation to be offset by an exact number of pixels.
- This does the same the editor does, except it lets you input values
  greater than 999 and lower than -999.
- Replace 'x' and 'y' with numeric values the exact number of pixels to
  offset the animation's x and y coordinates by.

Examples:

<Offset X: +20>
<Offset Y: -50>

<Offset: +10, -30>

---

Quality of Life

By default, RPG Maker MZ does not offer an encounter step minimum after a random encounter has finished. This means that one step immediately after finishing a battle, the player can immediately enter another battle. The Quality of Life improvement: Minimum Encounter Steps allows you to set a buffer range between battles for the player to have some breathing room.

---

<Minimum Encounter Steps: x>

- Used for: Map Notetags
- Replace 'x' with the minimum number of steps before the player enters a
  random encounter on that map.
- If this notetag is not used, then the minimum encounter steps for the map
  will default to Quality of Life Settings => Encounter Rate Min.

---

Tile shadows are automatically added to certain tiles in the map editor. These tile shadows may or may not fit some types of maps. You can turn them on/off with the Quality of Life Plugin Parameters or you can override the settings with the following notetags:

<Show Tile Shadows>
<Hide Tile Shadows>

- Used for: Map Notetags
- Use the respective notetag for the function you wish to achieve.
- If this notetag is not used, then the tileset shadow settings for the map
  will default to Quality of Life Settings => No Tile Shadows.

---

Basic, X, and S Parameters

A battler's parameters, or stats as some devs know them as, are the values that determine how a battler performs. These settings allow you to alter behaviors and give boosts to trait objects in a more controlled manner.

---

<param Plus: +x>
<param Plus: -x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Adds or subtracts 'x' to 'param' plus value when calculating totals.
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to modify.
- Replace 'x' with an integer on how much to adjust the parameter by.
- This is used to calculate the 'plus' portion in the Parameter Settings =>
  Basic Parameter => Formula.

---

<param Rate: x%>
<param Rate: x.x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Changes 'param' rate to 'x' to alter the total 'param' value.
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to modify.
- Replace 'x' with a percentage (ie. 150%) or a rate (ie. 1.5).
- This is used to calculate the 'paramRate' portion in Parameter Settings =>
  Basic Parameter => Formula.

---

<param Flat: +x>
<param Flat: -x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Adds or subtracts 'x' to 'param' plus value when calculating totals.
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to modify.
- Replace 'x' with an integer on how much to adjust the parameter by.
- This is used to calculate the 'flatBonus' portion in Parameter Settings =>
  Basic Parameter => Formula.

---

<param Max: x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Sets max caps for the 'param' to be 'x'. If there are multiple max caps
  available to the unit, then the highest will be selected.
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to modify.
- Replace 'x' with an integer to determine what the max cap should be.

---

<xparam Plus: +x%>
<xparam Plus: -x%>

<xparam Plus: +x.x>
<xparam Plus: -x.x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Adds or subtracts 'x' to 'xparam' plus value when calculating totals.
- Replace 'xparam' with 'HIT', 'EVA', 'CRI', 'CEV', 'MEV', 'MRF', 'CNT',
  'HRG', 'MRG', 'TRG' to determine which X parameter to modify.
- Replace 'x' with a percentage (ie. 150%) or a rate (ie. 1.5).
- This is used to calculate the 'plus' portion in the Parameter Settings =>
  X Parameter => Formula.

---

<xparam Rate: x%>
<xparam Rate: x.x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Changes 'param' rate to 'x' to alter the total 'xparam' value.
- Replace 'xparam' with 'HIT', 'EVA', 'CRI', 'CEV', 'MEV', 'MRF', 'CNT',
  'HRG', 'MRG', 'TRG' to determine which X parameter to modify.
- Replace 'x' with a percentage (ie. 150%) or a rate (ie. 1.5).
- This is used to calculate the 'paramRate' portion in Parameter Settings =>
  X Parameter => Formula.

---

<xparam Flat: +x%>
<xparam Flat: -x%>

<xparam Flat: +x.x>
<xparam Flat: -x.x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Adds or subtracts 'x' to 'xparam' plus value when calculating totals.
- Replace 'xparam' with 'HIT', 'EVA', 'CRI', 'CEV', 'MEV', 'MRF', 'CNT',
  'HRG', 'MRG', 'TRG' to determine which X parameter to modify.
- Replace 'x' with a percentage (ie. 150%) or a rate (ie. 1.5).
- This is used to calculate the 'flatBonus' portion in Parameter Settings =>
  X Parameter => Formula.

---

<sparam Plus: +x%>
<sparam Plus: -x%>

<sparam Plus: +x.x>
<sparam Plus: -x.x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Adds or subtracts 'x' to 'sparam' plus value when calculating totals.
- Replace 'sparam' with 'TGR', 'GRD', 'REC', 'PHA', 'MCR', 'TCR', 'PDR',
  'MDR', 'FDR', 'EXR' to determine which S parameter to modify.
- Replace 'x' with a percentage (ie. 150%) or a rate (ie. 1.5).
- This is used to calculate the 'plus' portion in the Parameter Settings =>
  S Parameter => Formula.

---

<sparam Rate: x%>
<sparam Rate: x.x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Changes 'param' rate to 'x' to alter the total 'sparam' value.
- Replace 'sparam' with 'TGR', 'GRD', 'REC', 'PHA', 'MCR', 'TCR', 'PDR',
  'MDR', 'FDR', 'EXR' to determine which S parameter to modify.
- Replace 'x' with a percentage (ie. 150%) or a rate (ie. 1.5).
- This is used to calculate the 'paramRate' portion in Parameter Settings =>
  S Parameter => Formula.

---

<sparam Flat: +x%>
<sparam Flat: -x%>

<sparam Flat: +x.x>
<sparam Flat: -x.x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Adds or subtracts 'x' to 'sparam' plus value when calculating totals.
- Replace 'sparam' with 'TGR', 'GRD', 'REC', 'PHA', 'MCR', 'TCR', 'PDR',
  'MDR', 'FDR', 'EXR' to determine which S parameter to modify.
- Replace 'x' with a percentage (ie. 150%) or a rate (ie. 1.5).
- This is used to calculate the 'flatBonus' portion in Parameter Settings =>
  S Parameter => Formula.

---

JavaScript Notetags: Basic, X, and S Parameters

The following are notetags made for users with JavaScript knowledge. These notetags are primarily aimed at Basic, X, and S Parameters.

---

<JS param Plus: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'param' plus value.
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  plus amount for the parameter's total calculation.
- This is used to calculate the 'plus' portion in the Parameter Settings =>
  Basic Parameter => Formula.

---

<JS param Rate: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'param' rate value.
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  param rate amount for the parameter's total calculation.
- This is used to calculate the 'paramRate' portion in Parameter Settings =>
  Basic Parameter => Formula.

---

<JS param Flat: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'param' flat value.
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  flat bonus amount for the parameter's total calculation.
- This is used to calculate the 'flatBonus' portion in Parameter Settings =>
  Basic Parameter => Formula.

---

<JS param Max: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to determine what the max cap for 'param' should be. If there
  are multiple max caps available to the unit, then the highest is selected.
- Replace 'param' with 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI',
  or 'LUK' to determine which parameter to modify.
- Replace 'code' with JavaScript code to determine the max cap for the
  desired parameter.

---

<JS xparam Plus: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'xparam' plus value.
- Replace 'xparam' with 'HIT', 'EVA', 'CRI', 'CEV', 'MEV', 'MRF', 'CNT',
  'HRG', 'MRG', 'TRG' to determine which X parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  plus amount for the X parameter's total calculation.
- This is used to calculate the 'plus' portion in the Parameter Settings =>
  X Parameter => Formula.

---

<JS xparam Rate: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'xparam' rate value.
- Replace 'xparam' with 'HIT', 'EVA', 'CRI', 'CEV', 'MEV', 'MRF', 'CNT',
  'HRG', 'MRG', 'TRG' to determine which X parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  param rate amount for the X parameter's total calculation.
- This is used to calculate the 'paramRate' portion in Parameter Settings =>
  X Parameter => Formula.

---

<JS xparam Flat: code>
- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'xparam' flat value.
- Replace 'xparam' with 'HIT', 'EVA', 'CRI', 'CEV', 'MEV', 'MRF', 'CNT',
  'HRG', 'MRG', 'TRG' to determine which X parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  flat bonus amount for the X parameter's total calculation.
- This is used to calculate the 'flatBonus' portion in Parameter Settings =>
  X Parameter => Formula.

---

<JS sparam Plus: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'sparam' plus value.
- Replace 'sparam' with 'TGR', 'GRD', 'REC', 'PHA', 'MCR', 'TCR', 'PDR',
  'MDR', 'FDR', 'EXR' to determine which S parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  plus amount for the S parameter's total calculation.
- This is used to calculate the 'plus' portion in the Parameter Settings =>
  S Parameter => Formula.

---

<JS sparam Rate: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'sparam' rate value.
- Replace 'sparam' with 'TGR', 'GRD', 'REC', 'PHA', 'MCR', 'TCR', 'PDR',
  'MDR', 'FDR', 'EXR' to determine which S parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  param rate amount for the S parameter's total calculation.
- This is used to calculate the 'paramRate' portion in Parameter Settings =>
  S Parameter => Formula.

---

<JS sparam Flat: code>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Runs 'code' to change the 'sparam' flat value.
- Replace 'sparam' with 'TGR', 'GRD', 'REC', 'PHA', 'MCR', 'TCR', 'PDR',
  'MDR', 'FDR', 'EXR' to determine which S parameter to modify.
- Replace 'code' with JavaScript code to determine how much to change the
  flat bonus amount for the S parameter's total calculation.
- This is used to calculate the 'flatBonus' portion in Parameter Settings =>
  S Parameter => Formula.

---

Battle Setting-Related Notetags

These tags will change the settings for battle regardless of how the battle system is set up normally. Insert these tags in either the noteboxes of maps or the names of troops for them to take effect. If both are present for a specific battle, then priority goes to the setting found in the troop name.

---

<FV>
<Front View>
<Battle View: FV>
<Battle View: Front View>

- Used for: Map Notetags and Troop Name Tags
- Changes the perspective of battle to front view for this specific map or
  battle.
- Make sure you have the enemy image files available in the img/enemies/
  folder as they will used instead of the "sv_enemies" graphics.

---

<SV>
<Side View>
<Battle View: SV>
<Battle View: Side View>

- Used for: Map Notetags and Troop Name Tags
- Changes the perspective of battle to side view for this specific map or
  battle.
- Make sure you have the enemy image files available in the img/sv_enemies/
  folder as they will used instead of the "enemies" graphics.
- Make sure your actors have "sv_actor" graphics attached to them.

---

<DTB>
<Battle System: DTB>

- Used for: Map Notetags and Troop Name Tags
- Changes the battle system to the default battle system (DTB).

---

<TPB Active>
<ATB Active>
<Battle System: TPB Active>
<Battle System: ATB Active>

- Used for: Map Notetags and Troop Name Tags
- Changes the battle system to the time progress battle system (TPB) or
  active turn battle system (ATB) if you have VisuMZ_2_BattleSystemATB
  installed for the game project.

---