Items and Equips Core VisuStella MZ

From Yanfly.moe Wiki
Jump to navigation Jump to search

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.



Download

System

This is a plugin created for RPG Maker MZ.

InstallPluginsMz.png

UpdatePlugins.png

Troubleshooting.jpg

Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.

Click here to learn how to update plugins.

Click here for how to troubleshoot plugins if you get an error.


Masterarbeit Writer


ItemsEquipsCoreEquipTypes.png ItemsEquipsCoreShopStatus.png
ItemsEquipsCoreEquipChange.png ItemsEquipsCoreShopEquip.png

Extension Plugins

The following plugins are Extension Plugins that require this plugin as its Parent Plugin.

Place the following plugins below this plugin located in the Plugin Manager if you plan on using them.


VisuStella MZ

This plugin is a part of the VisuStella MZ Plugin Library.

Click here if you want to help support VisuStella on Patreon.

Introduction

The Items & Equips Core makes improvements to the RPG Maker MZ item and equipment dedicated scenes (including the shop) and how they're handled. From more item categories, better parameter control, rulings, and more, game devs are able to take control over key aspects of their game's items.

Features include all (but not limited to) the following:

  • Modifying the appearances to the Item Scene, Equip Scene, and Shop Scene.
  • Categorizing items in unique and multiple categories.
  • Item Scene and Shop Scene will now display detailed information on items.
  • NEW! marker can be displayed over recently acquired items in-game.
  • Equipment notetags to adjust parameters past the editor limitations.
  • Equipment Rulings to adjust what slot types can and can't be unequipped and/or optimized.
  • Equipment Type Handling offers more control over equipment loadouts.
  • Items sold in shops can be hidden/shown based on Switches.
  • Items sold in shops can have varying prices adjusted by notetags.

Requirements

This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.


Tier 1

This plugin is a Tier 1 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5).

This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library.


Major Changes: New Hard-Coded Features

This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them.

---

Equipment Type Handling

ItemsEquipsCoreEquipTypes.png

Characters will no longer have one universal equipment slot setting. Classes can have different equipment type loadouts, made possible through the usage of notetags. Also, equipment types of matching names would be treated as the same type, where previously, they would be different types. This means if you have two "Accessory" slots, be it in the form of notetags or through the Database > Types tab, they can both equip the same type of accessories.

The Change Equip event command is now updated to reflect this new change. When processing an equip change, the slot changed will go to the first empty slot of matching type. If all of the actor's matching slot types are equipped, then the equip will replace the last slot available.

---

Shop Status Window

ItemsEquipsCoreShopStatus.png

The Status Window found in the Shop Scene was originally barren and did not display much information at all. This is changed through this plugin's new features. While the contents of the Shop Status Window can be customized through the Plugin Parameters, it is a change that cannot be reversed and for the better since it gives players the much needed information revolving around the game's items.

---

Core Engine Compatibility: Modern Controls

ItemsEquipsCoreShopEquip.png

If the VisuStella Core Engine is added to your game with Modern Controls enabled, then the Item Menu Scene, Equip Menu Scene, and Shop Menu Scene's controls will be changed a bit.

The Item Menu Scene will automatically have the Item List Window active, with using the Left/Right (for single column) or Page Up/Page Down (for multi-columns) to navigate between the Item Categories. Similar will occur when trying to sell items in the Shop Menu Scene.

The Equip Menu Scene will automatically have the Equip Slots Window active and only activate the command window upon moving up to it.

---

VisuStella MZ Compatibility

While this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins or specific features. This section will highlight the main plugins/features that will not be compatible with this plugin or put focus on how the make certain features compatible.

---

Battle Core VisuStella MZ

ItemsEquipsCore 37 Comp 1.png

Changing the "Damage Multiplier" or "Healing Multiplier" vocabulary for the Item and Equip Core's Shop Status Window is not done with the Item and Equip Core's Plugin Parameters if you have the Battle Core installed.

Instead, go to Battle Core's Plugin Parameters, Damage Settings, Damage Styles, and adjust the style's version of the "Damage Multiplier" or "Healing Multiplier" text instead.

Why does this work this way? Because not all damage styles work off "Multipliers" so in order for it to convey the proper message to the player, each damage style has its own vocabulary to be more accurate.

ItemsEquipsCore 37 Comp 2.png

In case you forget about that, when you visit the Item and Equip Core's plugin parameters for these, it should also remind you in the parameter's description on where to change it.

---

Weapon Swap System VisuStella MZ

The custom equip slots feature from the VisuStella MZ Items and Equips Core allowed you to add in extra weapon slots. This is now curated up to a max of one weapon slot per character. This needs to be done to make the Weapon Swap System viable.

---

Notetags

RPG Maker MZ's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.


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.

General

ItemsEquipsCoreShopStatus.png

These notetags affect the Items, Weapons, and Armors on a general scale.

---

<Max: x>

- Used for: Item, Weapon, Armor Notetags
- Determines the maximum quantity that can be held for this item.
- Replace 'x' with a number value to determine the maximum amount.

---

ItemsEquipsCoreItemColor.png

<Color: x>
<Color: #rrggbb>

- Used for: Item, Weapon, Armor, Skill Notetags
- Determines the color of the object inside the in-game menus.
- Replace 'x' with a number value depicting a window text color.
- Replace 'rrggbb' with a hex color code for a more custom color.

---

<Category: x>

- Used for: Item, Weapon, Armor Notetags
- Arranges items into certain/multiple categories to work with the Category
  Plugin Parameter setting: "Category:x".
- Replace 'x' with a category name to mark this item as.

---

<Categories>
 x
 x
</Categories>

- Used for: Item, Weapon, Armor Notetags
- Arranges items into certain/multiple categories to work with the Category
  Plugin Parameter setting: "Category:x".
- Replace each 'x' with a category name to mark this item as.

---

<Conserve: x%>

- Used for: Item
- Gives the item a percent chance when used to not consume the item.
- Replace 'x' with a number representing the percent chance to successfully
  conserve the item.
- If an item cannot be consumed, conserve chance will be 100% regardless.

---

Item Accessibility Notetags

The following notetags allow you to choose when items can/cannot be used based on switches.

---

<Enable Switch: x>

<Enable All Switches: x,x,x>
<Enable Any Switches: x,x,x>

- Used for: Item Notetags
- Determines the enabled status of the item based on switches.
- Replace 'x' with the switch ID to determine the item's enabled status.
- If 'All' notetag variant is used, item will be disabled until all
  switches are ON. Then, it would be enabled.
- If 'Any' notetag variant is used, item will be enabled if any of the
  switches are ON. Otherwise, it would be disabled.

---

<Disable Switch: x>

<Disable All Switches: x,x,x>
<Disable Any Switches: x,x,x>

- Used for: Item Notetags
- Determines the enabled status of the item based on switches.
- Replace 'x' with the switch ID to determine the item's enabled status.
- If 'All' notetag variant is used, item will be enabled until all switches
  are ON. Then, it would be disabled.
- If 'Any' notetag variant is used, item will be disabled if any of the
  switches are ON. Otherwise, it would be enabled.

---

JavaScript Notetags: Item Accessibility

The following are notetags made for users with JavaScript knowledge to determine if an item can be accessible by code.

---

<JS Item Enable>
 code
 code
 enabled = code;
</JS Item Enable>

- Used for: Item Notetags
- Determines the enabled status of the item based on JavaScript code.
- If the actor this is disabled for is the only party member, it will not be
  visible in the item list unless the VisuStella Battle Core is installed.
  - If the VisuStella Battle Core is installed, then all battle scope items
    will be visible even if they're disabled.
- Replace 'code' to determine the type enabled status of the item.
- The 'enabled' variable returns a boolean (true/false) to determine if the
  item will be enabled or not.
- The 'user' variable refers to the user with the item.
- The 'item' variable refers to the item being checked.
- All other item conditions must be met in order for this to code to count.

---

Equipment Notetags

The following notetags provide equipment-related effects from deciding what equip slots can be given to classes to the base parameter changes asigned to weapons and armors.

---

ItemsEquipsCoreEquipTypes.png

<Equip Slots>
 slotName
 slotName
 slotName
</Equip Slots>

- Used for: Class Notetags
- Changes the equipment slot loadout for any actor who is that class.
- Replace 'slotName' with an Equipment Type name from Database > Types.
  This is case-sensitive.
- Insert or remove as many "slotName" equipment types as needed.

---

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

- Used for: Weapon, Armor Notetags
- Changes the base parameter value for the equip item.
- Replace 'param' with any of the following: 'MaxHP', 'MaxMP', 'ATK', 'DEF',
  'MAT', 'MDF', 'AGI', or 'LUK' to change that specific parameter's value.
  - These notetags do NOT work with X Parameters, S Parameters, or any
    custom parameters. These notetags ONLY work with the base parameters.
- Replace 'x' with a number value to set the parameter value to.
- This allows you to bypass the Database Editor's number limitations.

---

<Equip Copy Limit: x>

- Used for: Weapon, Armor Notetags
- Sets a maximum number of copies that the actor can wear of this equipment.
- Replace 'x' with a number value to determine the copy limit.
- This can be bypassed using Event Commands and/or Script Calls.
- Usage Example: Actors can only equip one copy of the "One-of-a-Kind Ring"
  on at any time despite having empty accessory slots because the ring has a
  <Equip Copy Limit: 1> notetag.

---

<Equip Weapon Type Limit: x>

- Used for: Weapon
- This weapon cannot be equipped with other weapons of the same type once
  the limited amount has been reached.
- Replace 'x' with a number value to determine the weapon type limit.
- This can be bypassed using Event Commands and/or Script Calls.
- Usage Example: A dualwielding warrior who can only equip one sword and a
  dagger but never two swords or two daggers because the swords and daggers
  all have the <Equip Weapon Type Limit: 1> notetags on them.

---

<Equip Armor Type Limit: x>

- Used for: Armor
- This armor cannot be equipped with other armors of the same type once the
  limited amount has been reached.
- Replace 'x' with a number value to determine the armor type limit.
- This can be bypassed using Event Commands and/or Script Calls.
- Usage Example: People cannot equip more than two glove accessories on at a
  time because the glove is a "Glove" armor-type and each glove item has the
  <Equip Armor Type Limit: 2> notetags on them.

---

<Party Artifact>
<Troop Artifact>

<Stackable Party Artifact>
<Stackable Troop Artifact>

- Used for: Armor
- This armor cannot be equipped at all. However, by simply being in the
  party's inventory, its parameter bonuses and traits will be applied
  globally throughout the whole party or troop (depending on the notetag).
- Add both notetags to affect both groups.
- The normal versions of the notetag is only applied once regardless of the
  number of copies are found in the party's inventory.
- The stackable versions of the notetag will have the bonuses and traits
  stacked multiple times relative to the number of copies found in the
  party's inventory.
- This item will NOT be added during the setup phase for Battle Tests.
  - If you want to add the item, do it manually.

---

<Equip For Class Only: x>
<Equip For Classes Only: x, x, x>
<Equip For Class Only: name>
<Equip For Classes Only: name, name, name>

- Used for: Weapon, Armor Notetags
- This piece of equipment can only be worn by members with 'x' as the main
  class. If there are multiple classes listed, at least one of them need to
  be the actor's main class.
- Replace 'x' with a number representing the ID of the class required.
- For the 'name' variant, replace 'name' with the name of the required class
  the actor needs to have in order to equip this object.

---

<Equip Requirements>
 requirement
 requirement
 requirement
</Equip Requirements>

- Used for: Weapon, Armor Notetags
- Defines a requirement(s) for the actor to meet in order for the equip item
  to be equippable.
- Failure to meet these requirements will cause the equipment to unequip
  automatically.
  - Keep in mind that in some cases, this will not happen immediately.
    Things like switches will require the actor to meet its cache clear
    in order to trigger the automatic unequip.
  - Some ways to trigger a cache clear would be to change the actor's HP/MP,
    or adding and then removing a state for the actor (preferrably an unused
    state that has no real effect).
- Replace 'requirement' with one of the settings bellow:
- Add multiple 'requirement' lines for more requirements.

  Requirements:

  param > x
  param >= x
  param === x
  param <= x
  param < x
  - Replace 'param' with 'level', 'maxhp', 'maxmp', 'atk', 'def', 'mat',
    'mdf', 'agi', or 'luk'.
  - This will make the piece of equipment require the actor's base parameter
    to be greater than (>), greater than or equal to (>=), equal to (===),
    less than or equal to (<=), or less than (<).
  - This is NOT the value for the total parameter, only the base parameter.
  - The base parameter is calculated by the user's class parameter value and
    any bonuses received through permanent stat increases.

  learned skill: x
  learned skill: name
  - This will make the piece of equipment require the actor to have learned
    skill 'x'.
  - If 'name' is used, priority will be given to the skill with the highest
    ID in the database.
  - The actor needs to have LEARNED the skill. This means that if you have
    added a skill to the actor's kit through a trait, it will not count.

  switch: x
  - This will require switch X to be on.
  - If it isn't, the piece of equipment cannot be worn.
  - Insert multiple of these to add more switches that are are required to
    be on.

  ***NOTE 1***
  There is no "class: x" for these equip requirements. Instead, use the
  <Equip For Class Only: x> notetags.

  ***NOTE 2***
  For those wondering where "unique only" is, that does not exist in this
  plugin. Instead, use the <Equip Copy Limit: x> notetag listed above.

  Example A:

    <Equip Requirements>
    level >= 20
    </Equip Requirements>

    - Requires the user to be at least level 20 in order to equip.

  Example B:

    <Equip Requirements>
    atk >= 50
    def <= 50
    </Equip Requirements>
    - Requires the user have at least 50 base ATK to equip.
    - Requires the user to be under 50 base DEF to equip.

---

<Added EType: x>
<Added ETypes: x, x, x>

- Used for: Armor Notetags
- This is for armors only and does NOT work with weapons!
- Allows a piece of armor to belong to multiple ETypes. This means a glove
  can be equipped as "Armgear" or as an "Accessory" if you so choose.
- Replace 'x' with a number representing the ID of the EType you wish to add
  to the list of ETypes.
  - Insert multiple 'x' entries to add more than one EType ID.

---

<Cursed>

- Used for: Weapon, Armor Notetags
- If this weapon or armor is equipped, it cannot manually be removed by the
  player until it is purified.
- To remove it, it must be done by event commands, script calls, or through
  the Purify-related Plugin Commands provided by this plugin.
- Once purified, the weapon or armor will become unequipped unless it has a
  purify transformation.
  - If the newly transformed weapon/armor is equippable, it will remain in
    the actor's equipment slots.
- If you are using VisuMZ_2_WeaponSwapSystem, weapons cannot become cursed
  in order to allow free weapon swapping. Weaponry will not be cursed
  if VisuMZ_2_WeaponSwapSystem is installed.

---

<Purify Transform: id>
<Purify Transform: name>

- Used for: Weapon, Armor Notetags
- If this notetag is present on a <Cursed> weapon or armor, then upon the
  actor receiving purification, the weapon or armor will transform into a
  different item.
- Replace 'id' with a number representing the transformed weapon/armor's ID.
- Replace 'name' with text representing the transformed weapon/armor's name.
- Weapons can only transform into weapons.
- Armors can only transform into armors.

---

JavaScript Notetags: Equipment

The following are notetags made for users with JavaScript knowledge to adjust the parameter through code.

---

ItemsEquipsCoreShopEquip.png

<JS Parameters>
 MaxHP = code;
 MaxMP = code;
 ATK = code;
 DEF = code;
 MAT = code;
 MDF = code;
 AGI = code;
 LUK = code;
</JS Parameters>

- Used for: Weapon, Armor Notetags
- Uses JavaScript to determine the values for the basic parameters based on
  the code used to calculate its value.
- The variables 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT', 'MDF', 'AGI', and
  'LUK' are used to determine the finalized value of the parameter. This
  variable is case sensitive.
- If a parameter is not present, its value will be treated as +0.

---

Status Window Notetags

The following notetags will affect the Shop Status Window info. If for any reason the data that is displayed is not to your liking or insufficient, you can change it up using the following notetags.

---

ItemsEquipsCoreStatusText.png

<Status Info>
 key: data
 key: data
 key: data
</Status Info>

- Used for: Skill, Item Notetags
- If you do not like the generated data that's displayed, you can change it
  using this notetag to display what you want.
- Replace 'key' with one of the following:
  - Consumable
  - Quantity
  - Occasion
  - Scope
  - Speed
  - Success Rate
  - Repeat
  - Hit Type
  - Element
  - Damage Multiplier
  - HP Recovery
  - MP Recovery
  - TP Recovery
  - HP Damage
  - MP Damage
  - TP Damage
  - User TP Gain
  - Added Effects
  - Removed Effects
- Replace 'data' with the text data you want to visually appear. You may use
  text codes for this.
- This only affects info entries that are already visible and won't make
  other categories suddenly appear.
- Insert or remove as many "key: data" lines as needed.

---

ItemsEquipsCoreStatusText.png

<Custom Status Info>
 key: data
 key: data
 key: data
</Custom Status Info>

- Used for: Skill, Item Notetags
- If you want custom categories and data to be displayed for your items that
  aren't provided by the Shop Status Window Info to begin with, you can use
  this notetag to add in your own entries.
- Replace 'key' with text of the exact label you want. You may use text
  codes for this.
- Replace 'data' with text of the exact text data you want. You may use text
  codes for this.
- Insert or remove as many "key: data" lines as needed.

---

ItemsEquipsCore ShopPicture.png

<Shop Picture Name: filename>

- Used for: Skill, Item, Weapon, Armor Notetags
- Enables a shop picture for the status window. This image can be seen in
  the item scene, shop scene, and skill scene if enabled.
- If this notetag is not used, there will be no image.
- Replace 'filename' with the filename of the graphic to use from the game
  project's img/pictures/ folder. Filenames are case sensitive. Leave out
  the filename extension from the notetag.
- Use the supporting notetags to determine where the image appears. If not,
  they will default to the background, fit to the window dimensions,
  centered at the middle of the window.

---

ItemsEquipsCore ShopPicture.png

<Shop Picture Layer: Background>
<Shop Picture Layer: Foreground>

- Used for: Skill, Item, Weapon, Armor Notetags
- Determines which layer the graphic will be drawn on.
- If the background layer is selected, the picture will appear behind the
  data text.
- If the foreground layer is selected, the picture will appear in front of
  the data text.
- If this notetag is not used, it will default to the background layer.

---

ItemsEquipsCore ShopPicture.png

<Shop Picture Max Width: x>
<Shop Picture Max Height: y>
<Shop Picture Max Dimensions: x, y>

- Used for: Skill, Item, Weapon, Armor Notetags
- Determines the maximum width and/or height for the image.
- This means the image will be automatically scaled proportionally to that
  width or height as long as everything else does not break boundaries.
- Replace 'x' and 'y' with number values representing the maximum dimensions
  the image can be in pixels.
- If these notetags are not used, the image will be automatically scaled to
  the dimensions of the shop status window.

---

ItemsEquipsCore ShopPicture.png

<Shop Picture Alignment: Left>
<Shop Picture Alignment: Center>
<Shop Picture Alignment: Right>

- Used for: Skill, Item, Weapon, Armor Notetags
- Adjusts the horizontal alignment for the image.
- Left, center, right determines how it's aligned horizontally if the
  image does not horizontally fit in the width of the window.
- If any of these notetags are not used, the image will default to the
  'center' alignment.

---

ItemsEquipsCore ShopPicture.png

<Shop Picture Position: Top>
<Shop Picture Position: Middle>
<Shop Picture Position: Bottom>

- Used for: Skill, Item, Weapon, Armor Notetags
- Adjusts the vertical position for the image.
- Top, middle, bottom determines how it's positioned vertically if the
  image does not vertically fit in the width of the window.
- If any of these notetags are not used, the image will default to the
  'middle' position.

---

ItemsEquipsCore ShopPicture.png

<Shop Picture Offset X: +x>
<Shop Picture Offset X: -x>

<Shop Picture Offset Y: +y>
<Shop Picture Offset Y: -y>

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

- Used for: Skill, Item, Weapon, Armor Notetags
- Offsets the X and Y positions of the image in the shop status window.
- X offsets adjust the horizontal position by x pixels.
  - Positive goes right.
  - Negative goes left.
- Y offsets adjust the horizontal position by y pixels.
  - Positive goes down.
  - Negative goes up.
- Replace 'x' and 'y' with number values representing the pixels to offset
  the image by. The '+' and '-' signs are required.
- If none of these notetags are used, there will be no offsets.

---

ItemsEquipsCore ShopPicture.png

<Shop Picture Opacity: x>
<Shop Picture Opacity: x%>

- Used for: Skill, Item, Weapon, Armor Notetags
- Adjusts the opacity of the image used.
- When using 'x' and not 'x%', use a number between 0 and 255.
  - The closer to 0, the more transparent the image is.
  - The closer to 255, the more opaque the image is.
- When using 'x%' and not 'x', use a number between 0% and 100%.
  - The closer to 0%, the more transparent the image is.
  - The closer to 100%, the more opaque the image is.

---

Shop Menu Notetags

ItemsEquipsCoreShopEquip.png

These notetags adjust how prices and such are managed inside the Shop Menu as well as whether or not some items are visible depending on switch states.

---

<Price: x>

- Used for: Item, Weapon, Armor Notetags
- Adjusts the buying price for this item.
- Replace 'x' with a number depicting the desired value for the buy price.
- This allows you to bypass the RPG Maker MZ editor's limitation of 999,999.

---

<Can Sell>
<Cannot Sell>

- Used for: Item, Weapon, Armor Notetags
- Makes the item either always sellable or cannot be sold.
- This bypasses the game's internal hard-coding to prevent items with a
  price of 0 from being able to be sold.
- This bypasses the game's internal hard-coding to always allow items with
  a price value of being able to be sold.

---

<Sell Price: x>

- Used for: Item, Weapon, Armor Notetags
- Changes the sell price to be something different than the default amount.
- Replace 'x' with a number depicting the desired value for the sell price.

---

<Show Shop Switch: x>

<Show Shop All Switches: x,x,x>
<Show Shop Any Switches: x,x,x>

- Used for: Item, Weapon, Armor Notetags
- Determines the visibility of the shop item based on switches.
- Replace 'x' with the switch ID to determine the shop item's visibility.
- If 'All' notetag variant is used, item will be hidden until all switches
  are ON. Then, it would be shown.
- If 'Any' notetag variant is used, item will be shown if any of the
  switches are ON. Otherwise, it would be hidden.

---

<Hide Shop Switch: x>

<Hide Shop All Switches: x,x,x>
<Hide Shop Any Switches: x,x,x>

- Used for: Item, Weapon, Armor Notetags
- Determines the visibility of the shop item based on switches.
- Replace 'x' with the switch ID to determine the shop item's visibility.
- If 'All' notetag variant is used, item will be shown until all switches
  are ON. Then, it would be hidden.
- If 'Any' notetag variant is used, item will be hidden if any of the
  switches are ON. Otherwise, it would be shown.

---

<Cannot Sell Switch: x>

<Cannot Sell All Switches: x,x,x>
<Cannot Sell Any Switches: x,x,x>

- Used for: Item, Weapon, Armor Notetags
- Determines the sellability of the shop item based on switches.
- Replace 'x' with the switch ID to determine the shop item's sellability.
- If 'All' notetag variant is used, item cannot be sold until all switches
  are ON. Otherwise, it can be sold.
- If 'Any' notetag variant is used, item cannot be sold if any of the
  switches are ON. Otherwise, it can be sold.

---

<Buy Turn On Switch: x>
<Buy Turn On Switches: x, x, x>

- Used for: Item, Weapon, Armor Notetags
- When this item, weapon, or armor is bought in the shop scene, turn on the
  switch(es) 'x'.
- Replace 'x' with a number representing the ID of the switch to turn on.
  - Insert multiple 'x' values to turn on multiple switches upon buying.

---

<Buy Turn Off Switch: x>
<Buy Turn Off Switches: x, x, x>

- Used for: Item, Weapon, Armor Notetags
- When this item, weapon, or armor is bought in the shop scene, turn off the
  switch(es) 'x'.
- Replace 'x' with a number representing the ID of the switch to turn off.
  - Insert multiple 'x' values to turn off multiple switches upon buying.

---

<Sell Turn On Switch: x>
<Sell Turn On Switches: x, x, x>

- Used for: Item, Weapon, Armor Notetags
- When this item, weapon, or armor is sold in the shop scene, turn on the
  switch(es) 'x'.
- Replace 'x' with a number representing the ID of the switch to turn on.
  - Insert multiple 'x' values to turn on multiple switches upon selling.

---

<Sell Turn Off Switch: x>
<Sell Turn Off Switches: x, x, x>

- Used for: Item, Weapon, Armor Notetags
- When this item, weapon, or armor is sold in the shop scene, turn off the
  switch(es) 'x'.
- Replace 'x' with a number representing the ID of the switch to turn off.
  - Insert multiple 'x' values to turn off multiple switches upon selling.

---

JavaScript Notetags: Shop Menu

The following are notetags made for users with JavaScript knowledge. These notetags are primarily aimed at Buy and Sell prices.

---

<JS Buy Price>
 code
 code
 price = code;
</JS Buy Price>

- Used for: Item, Weapon, Armor Notetags
- Replace 'code' to determine the buying 'price' of the item.
- Insert the final buy price into the 'price' variable.
- The 'item' variable refers to the item being bought.

---

<JS Sell Price>
 code
 code
 price = code;
</JS Sell Price>

- Used for: Item, Weapon, Armor Notetags
- Replace 'code' to determine the selling 'price' of the item.
- Insert the final sell price into the 'price' variable.
- The 'item' variable refers to the item being sold.

---

Plugin Commands

PluginCommandsMZ.png

Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MZ.

Here is a list of Plugin Command(s) that you may use:

---


The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command.

---

Actor Plugin Commands

--

ItemsEquipsCoreEquipTypes.png

ItemsEquipsCoreUpdate16 Command1.png

Actor: Change Equip Slots
- Forcefully change the actor(s) equip slots.
- These will persist through class changes.

  Actor ID(s):
  - Select which Actor ID(s) to affect.

  Equip Slots:
  - Insert the equip slots you want the actor(s) to have.
  - These entries are case-sensitive.

--

ItemsEquipsCoreEquipTypes.png

ItemsEquipsCoreUpdate16 Command2.png

Actor: Reset Equip Slots
- Reset any forced equip slots for the actor(s).
- Equip slots will then be based on class.

  Actor ID(s):
  - Select which Actor ID(s) to affect.

---

Purify Plugin Commands

---

ItemsEquipsCore Command1.png

Purify: Target Actor(s)
- Purifies target actor(s) of any cursed weapons or armors.
- Cannot be used in battle.

  Actor ID(s):
  - Select which Actor ID(s) to affect.

---

ItemsEquipsCore Command2.png

Purify: Whole Party
- Purifies whole party of any cursed weapons or armors.
- Cannot be used in battle.

---

Shop Plugin Commands

---

ItemsEquipsCoreShopEquip.png

ItemsEquipsCorePluginCommand1.png

Shop: Advanced
- Make it easier to put together inventories for a shop.
- WARNING: Does not allow for event-specific prices.

  Step 1: Item ID's
  - Select which Item ID ranges to add.

  Step 2: Weapon ID's
  - Select which Weapon ID ranges to add.

  Step 3: Armor ID's
  - Select which Armor ID ranges to add.

  Step 4: Purchase Only?
  - Make the shop purchase-only?

  Optional:

    Blacklist
    - A list of categories to blacklist from the shop.
    - Not used if empty. Mark categories with <Category: x>

    Whitelist
    - A list of categories to whitelist for the shop.
    - Not used if empty. Mark categories with <Category: x>

This Plugin Command primarily functions as an alternative to the editor's
"Shop Processing" event command as that one requires you to add items one at
a time, making it extremely tedious to add large amounts of items. This
Plugin Command will mitigate that by allowing ID ranges to determine which
items to make available.

---

Plugin Parameters

Item Menu Settings

ItemsEquipsCoreShopStatus.png

ItemsEquipsCoreParams01.png

The Item Menu Settings allow you to adjust specifics on how key objects and windows in the Item Menu Scene operate.

---

General Window

 Use Updated Layout:
 - Use the Updated Item Menu Layout provided by this plugin?
 - This will automatically enable the Status Window.
 - This will override the Core Engine windows settings.
 Layout Style:
 - If using an updated layout, how do you want to style the menu scene?
   - Upper Help, Left Input
   - Upper Help, Right Input
   - Lower Help, Left Input
   - Lower Help, Right Input

---

List Window

 Columns:
 - Number of maximum columns.
 - If you are using the VisuStella MZ Core Engine and the "Modern Controls"
   Plugin Parameter, please read through that section in case you have any
   questions about how to switch between categories when using multiple
   columns of items at a time.

---

Item Quantity

 Item Max:
 Weapon Max:
 Armor Max:
 - The default maximum quantity for items, weapons, and/or armors.
 Quantity Format:
 - How to display an item's quantity.
 - %1 - Item Quantity
 Font Size:
 - Default font size for item quantity.

---

Shop Status Window

 Show in Item Menu?:
 - Show the Shop Status Window in the Item Menu?
 - This is enabled if the Updated Layout is on.
 Adjust List Window?:
 - Automatically adjust the Item List Window in the Item Menu if using the
   Shop Status Window?
 Background Type:
 - Select background type for this window.
   - 0 - Window
   - 1 - Dim
   - 2 - Transparent
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this Status Window in the
   Item Menu.

---

Button Assist Window

 Switch Category:
 - Button assist text used for switching categories.
 - For VisuStella MZ's Core Engine's Button Assist Window.

---

Item Categories

ItemsEquipsCoreCategories.png

ItemsEquipsCoreParams02.png

Item Categories appear both in the Item Menu Scene and Shop Menu Scene (but only under the Sell command). These Plugin Parameters give you the ability to add in the specific categories you want displayed, remove the ones you don't, and associate them with icons.

---

List

 Category List
 - A list of the item categories displayed in the Item/Shop menus.
   Type:
   - A list of the item categories displayed in the Item/Shop menus.
   - Replace x with ID numbers or text.
   - AllItems, RegularItems, KeyItems
   - HiddenItemA, HiddenItemB
   - Consumable, Nonconsumable
   - AlwaysUsable, BattleUsable, FieldUsable, NeverUsable
   - AllWeapons, WType:x
   - AllArmors, AType:x, EType:x
   - Category:x
   Icon:
   - Icon used for this category.
   - Use 0 for no icon.
   Visibility Switch:
   - This Switch must be turned ON in order for the category to show.
   - Use 0 for no Switch requirement.
 Style:
 - How do you wish to draw categorie entries in the Category Window?
 - Text Only: Display only the text.
 - Icon Only: Display only the icon.
 - Icon + Text: Display the icon first, then the text.
 - Auto: Determine which is better to use based on the size of the cell.
 Text Alignment
 - Decide how you want the text to be aligned.

---

Vocabulary

 Hidden Item A
 Hidden Item B
 Consumable
 Nonconsumable
 Always Usable
 Battle Usable
 Field Usable
 Never Usable
 - How these categories are named in the Item Menu.

---

NEW! Labels

ItemsEquipsCoreNew.png

ItemsEquipsCoreParams03.png

Whenever the player receives a new item(s), a NEW! Label can be placed on top of the item's icon when browsing a menu displaying the item(s). This is a quality of life addition from more modern RPG's to help players figure out what they've recently received. The following are Plugin Parameters made to adjust how the NEW! Labels are handled in-game.

---

NEW! Labels

 Use NEW! Labels?:
 - Use the NEW! Labels or not?
 Icon:
 - The icon index used to represent the NEW! text.
 - Use 0 to not draw any icons.
 Text:
 - The text written on the NEW! Label.
   Font Color:
   - Use #rrggbb for custom colors or regular numbers for text colors from
     the Window Skin.
   Font Size:
   - The font size used for the NEW! text.
 Fade Limit:
 - What's the upper opaque limit before reversing?
 Fade Speed:
 - What's the fade speed of the NEW! Label?
 Offset X:
 - How much to offset the NEW! Label's X position by.
 Offset Y:
 - How much to offset the NEW! Label's Y position by.

---

Equip Menu Settings

ItemsEquipsCoreEquipTypes.png

ItemsEquipsCoreParams04.png

These Plugin Parameters adjust the Equipment Menu Scene, ranging from using a more updated and modern layout, changing the styles of other windows, and other key visual aspects of the Equip Menu Scene. Other settings here allow you to adjust how equipment operate under certain rulings, too.

---

General

 Use Updated Layout:
 - Use the Updated Equip Layout provided by this plugin?
 - This will override the Core Engine windows settings.
   Param Font Size:
   - The font size used for parameter values.
   Show Menu Portraits?:
   - If Main Menu Core is installed, display the Menu Portraits instead of
     the actor's face in the status window?
   JS: Portrait Upper:
   - If Menu Portraits are available, this is code used to draw the upper
     data like this in the Status Window.
   JS: Face Upper:
   - If faces used used, this is code used to draw the upper data like this
     in the Status Window.
   JS: Parameter Lower:
   - Code to determine how parameters are drawn in the Status Window.
 Layout Style:
 - If using an updated layout, how do you want to style the menu scene?
   - Upper Help, Left Input
   - Upper Help, Right Input
   - Lower Help, Left Input
   - Lower Help, Right Input
 Status Window Width:
 - The usual width of the status window if using the non-Updated Equip
   Menu Layout.
 Show Back Rectangles?:
 - Show back rectangles of darker colors to display information better?
   Back Rectangle Color:
   - Use #rrggbb for custom colors or regular numbers for text colors
     from the Window Skin.
 Cursed Equip Popup:
 - Text popup appears when an actor equips a cursed weapon/armor.
 - Text codes allowed.
 - Requires VisuMZ_0_CoreEngine!
 - Empty to not use.
 -  %1 - Actor, %2 - Equip, %3 - Icon.

---

Command Window

 Style:
 - How do you wish to draw commands in the Command Window?
 - Text Only: Display only the text.
 - Icon Only: Display only the icon.
 - Icon + Text: Display the icon first, then the text.
 - Auto: Determine which is better to use based on the size of the cell.
 Text Align:
 - Text alignment for the Command Window.
 Equip Icon:
 - The icon used for the Equip command.
   Help Description:
   - Help description used when this command is selected.
   - Text codes allowed.
 Add Optimize Command?:
 - Add the "Optimize" command to the Command Window?
   Help Description:
   - Help description used when this command is selected.
   - Text codes allowed.
   Optimize Icon:
   - The icon used for the Optimize command.
 Add Clear Command?:
 - Add the "Clear" command to the Command Window?
   Help Description:
   - Help description used when this command is selected.
   - Text codes allowed.
   Clear Icon:
   - The icon used for the Clear command.

---

Remove Equip

 Icon:
 - Icon used for equipment removal.
 Text:
 - Text used for equipment removal.
 Use SHIFT Shortcut?:
 - Add the "Shift" button as a shortcut key to removing items?

---

Rulings

 Equip-Adjust HP/MP:
 - Adjust HP/MP differences after changing equips with MaxHP/MaxMP values.
 Non-Removable Types:
 - Insert ID's of the Equipment Types that must always have an item
   equipped and cannot be empty.
 Non-Optimized Types:
 - Insert ID's of the Equipment Types that will be ignored when equipment
   is being optimized.

---

Button Assist Window

 SHIFT: Remove:
 - Button assist text used for the SHIFT Remove Shortcut.
 - For VisuStella MZ's Core Engine's Button Assist Window.

---

Shop Menu Settings

ItemsEquipsCoreShopEquip.png

ItemsEquipsCoreParams05.png

These Plugin Parameters allow you a number of options to adjust the Shop Menu Scene. These options range from enabling an updated and modern layout, adjust how various key visual aspects appear, and determine how prices can be affected when it comes to selling them or buying them (for coders).

---

General

 Use Updated Layout:
 - Use the Updated Shop Layout provided by this plugin?
 - This will override the Core Engine windows settings.
 Layout Style:
 - If using an updated layout, how do you want to style the menu scene?
   - Upper Help, Left Input
   - Upper Help, Right Input
   - Lower Help, Left Input
   - Lower Help, Right Input

---

ItemsEquipsCore Update28 Params1.png

Switches

 Switch: Buy:
 - Buying items in the Shop Scene turns this Switch to ON.
 - Switch reverts to OFF whenever the Shop Scene opens.
 Switch: Sell
 - Selling items in the Shop Scene turns this Switch to ON.
 - Switch reverts to OFF whenever the Shop Scene opens.

---

Command Window

 Hide Unavailable?:
 - Hide all unavailable commands like when a shop is set to Purchase Only?
 Style:
 - How do you wish to draw commands in the Command Window?
 - Text Only: Display only the text.
 - Icon Only: Display only the icon.
 - Icon + Text: Display the icon first, then the text.
 - Auto: Determine which is better to use based on the size of the cell.
 Text Align:
 - Text alignment for the Command Window.
 Buy Icon:
 - The icon used for the Buy command.
 Sell Icon:
 - The icon used for the Sell command.
 Cancel Icon:
 - The icon used for the Cancel command.
 Rename "Cancel":
 - Rename Cancel to something more logical for the Shop Menu Scene.

---

Prices

 Sell Price Rate:
 - The default sell price rate.
 JS: Buy Price:
 - Modificatons made to the buy price before finalizing it.
 JS: Sell Price:
 - Modificatons made to the sell price before finalizing it.

---

Button Assist Window

 Small Increment:
 Large Increment:
 - Text used for changing amount bought/sold.
 - For VisuStella MZ's Core Engine's Button Assist Window.

---

Shop Status Window

ItemsEquipsCoreShopStatusWindow.png

ItemsEquipsCoreParams06.png

These Plugin Parameters focuses on the Shop Status Window and determines how its data is displayed.

---

General

 Window Width:
 - The usual width of the status window.
 Parameter Font Size:
 - Font size used for parameter changes.
 Translucent Opacity:
 - Opacity setting used for translucent window objects.
 Show Back Rectangles?:
 - Show back rectangles of darker colors to display information better?
   Back Rectangle Color:
   - Use #rrggbb for custom colors or regular numbers for text colors
     from the Window Skin.

---

Equipment Data

 Already Equipped:
 - Marker used to show an actor cannot equip an item.
 Can't Equip:
 - Marker used to show an actor cannot equip an item.
 Delay MS:
 - How many milliseconds (MS) to delay the preview update?
 - This is to prevent lag spikes for equips only.
 No Changes:
 - Marker used to show no changes have occurred.
 JS: Draw Equip Data:
 - Code used to draw the equipment data for the Shop Status Window.

---

Item Data

 Max State/Buff Icons:
 - Maximum number of icons that can be displayed for Add/Remove
   States/Buffs.
 Multiplier Standard:
 - Constant standard to filter out random values when calculating the
   damage multiplier.
 JS: Draw Item Data:
 - Code used to draw the item data for the Shop Status Window.

---

Vocabulary

 Consumable:
 Occasions:
 Scope:
 Speed:
 Success Rate:
 Repeats:
 Hit Type:
 Element:
 Damage Type:
 Effects:
 - Vocabulary used for these data entries.
 - Some of these have Plugin Parameters have sub-entries.
 NOTE: Regarding Damage Labels
 If Visu_1_BattleCore is installed, priority goes to its Damage Style
 settings. The label displayed is based on the damage style settings in
 place for that specific skill or item.
 Go to Battle Core > Plugin Parameters > Damage Settings > Style List >
 pick the damage style you want to edit > Damage Label and change the
 text settings you'd like there.

---


Terms of Use

1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com.

2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella".

3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code.

4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com.

5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code.

6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations.

7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4.

8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed.

Terms of Use: Japanese


『VisuStella MZ』利用規約

1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。

2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。

3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。

4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。

5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。

6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。

7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。

8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。

Credits

If you are using this plugin, credit the following people in your game:

Team VisuStella

  • Yanfly
  • Arisu
  • Olivia
  • Irina

Changelog

Version 1.51: December 14, 2023

  • Bug Fixes!
    • Fixed a bug where if an item is unequipped, it may cause a crash. Fix made by Arisu.
    • Fixed a bug where <Proxy: id> did not properly give the proxy item. Fix made by Arisu.


Version 1.50: November 16, 2023

  • Bug Fixes!
    • <JS Buy Price> and <JS Sell Price> was not working properly. Fix made by Irina.
  • Documentation Update!
    • Help file updated for new features.
  • Optimization Update!
    • Plugin should run more optimized.
  • New Features!
    • New Notetags added by Arisu:
      • <Cursed>
        • If this weapon or armor is equipped, it cannot manually be removed by the player until it is purified.
        • To remove it, it must be done by event commands, script calls, or through the Purify-related Plugin Commands provided by this plugin.
        • Once purified, the weapon or armor will become unequipped unless it has a purify transformation.
        • If the newly transformed weapon/armor is equippable, it will remain in the actor's equipment slots.
        • If you are using VisuMZ_2_WeaponSwapSystem, weapons cannot become cursed in order to allow free weapon swapping. Weaponry will not be cursed if VisuMZ_2_WeaponSwapSystem is installed.
      • <Purify Transform: id>
      • <Purify Transform: name>
        • If this notetag is present on a <Cursed> weapon or armor, then upon the actor receiving purification, the weapon or armor will transform into a different item.
    • New Plugin Commands added by Arisu:
      • Purify: Target Actor(s)
        • Purifies target actor(s) of any cursed weapons or armors.
      • Purify: Whole Party
        • Purifies whole party of any cursed weapons or armors.
    • Added "Cursed Equip Popup" to Equip Scene Plugin Parameters.
      • Text popup appears when an actor equips a cursed weapon/armor.
    • Added "Ally or Enemy" or "Enemy or Ally" scopes to Shop Status Window Plugin Parameters.
      • If unused, will default to "1 Ally" or "1 Enemy" like usual. Added by Irina.


Version 1.49: October 12, 2023

  • Bug Fixes!
    • Fixed a problem where for weapon types, all weapon types are listed in the equip menu even when the actor cannot equip them (though they would be disabled). Fix made by Olivia.
  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New notetags added by Olivia and sponsored by AndyL:
      • <Added EType: x>
      • <Added ETypes: x, x, x>
        • This is for armors only and does NOT work with weapons!
        • Allows a piece of armor to belong to multiple ETypes. This means a glove can be equipped as "Armgear" or as an "Accessory" if you so choose.


Version 1.48: September 14, 2023

  • Bug Fixes!
    • Fixed a problem where the help window position of the non-updated layout would appear in the wrong position. Fix made by Irina.
  • Optimization Update!
    • Plugin should run more optimized when weapons and armors exceed 2000 in database quantity.


Version 1.47: July 13, 2023

  • Bug Fixes!
    • Fixed a bug that would cause the shop status window to display incorrect removed buffs and debuffs. Fix made by Olivia.
  • Compatibility Update!
    • Added compatibility functionality for future plugins.
  • Documentation Update!
    • Help file updated for new features.
  • Feature Updates!
    • Changes made to dynamic shop listings in order to update upon listing changes rather than having to enter and exit the shop again. Update made by Arisu.
  • New Features!
    • New notetag effects added by Arisu and sponsored by AndyL:
      • <Conserve: x%>
        • Gives the item a percent chance when used to not consume the item.
      • <Buy Turn On Switches: x, x, x>
      • <Buy Turn Off Switches: x, x, x>
      • <Sell Turn On Switches: x, x, x>
      • <Sell Turn Off Switches: x, x, x>
        • When buying/selling an item, weapon, or armor with these notetags, turn on/off switch(es) 'x'.
      • New Plugin Parameters added by Arisu:
        • Params > Settings > Shop Status Window > Equipment Data > Delay MS:
          • How many milliseconds (MS) to delay the preview update?
          • This is to prevent lag spikes for equips only.


Version 1.46: June 15, 2023

  • Bug Fixes!
    • Fixed a problem where the help and input modes are not adequately adjusted when not used with the updated layout or without the Options Core custom UI placement. Fix made by Arisu.


Version 1.45: May 18, 2023

  • Bug Fixes!
    • Fixed a bug that would cause equip slots to not be recognized properly if the equip slot name ends in a space.


Version 1.44: April 13, 2023

  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New notetag effects added by Arisu and sponsored by Anon:
      • <Equip For Class Only: x>
      • <Equip For Classes Only: x, x, x>
      • <Equip For Class Only: name>
      • <Equip For Classes Only: name, name, name>
        • The piece of equipment can only be worn by the listed classes.
      • <Equip Requirements> notetag added.
        • Define multiple requirements that the actor needs to meet in order for this equip item to be equippable.
        • See help file for more information on the types of requirements that can be added.


Version 1.43: March 16, 2023

  • Bug Fixes!
    • Artifact armors should now update and refresh the party members' cache upon acquisition. Fix made by Olivia.


Version 1.42: February 16, 2023

  • Bug Fixes!
    • Proxy items should no longer cause infinite loops if they're made to reference other proxy items in a circular fashion. Instead, they just give the exact first found proxy instead of cycling through others. Fix made by Arisu.


Version 1.41: December 15, 2022

  • Compatibility Update!
    • Added compatibility functionality for future plugins.
  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New Plugin Parameters added by Arisu and sponsored by Anon:
      • Equip Scene > Equip Command > Help Description
      • Equip Scene > Optimize Command > Help Description
      • Equip Scene > Clear Command > Help Description
        • Help description used when these commands are selected.


Version 1.40: October 20, 2022

  • Feature Update!
    • For the shop status window, when comparing equipment of a type where there are multiple equipment slots (such as accessories), the plugin will now check for an empty equipment slot first and then make calculations there. Otherwise, it will use the first available equipment slot of that type regardless of the equipped item. Update made by Arisu.
  • Optimization Update!
    • Plugin should run more optimized.


Version 1.39: September 29, 2022:

  • Feature Update!
    • Changed the default code for the equip scene's status window display to prevent the face graphic and basic actor stats from going above the window boundaries if there are too many parameters displayed in the status window at a time.
    • If you already have this plugin installed the changes will not be reflected unless you do the following:
        • BACKUP your game project.
        • REMOVE this plugin from the Plugin Manager list.
        • REINSTALL this plugin into the Plugin Manager list.
        • SAVE the game project.


Version 1.38: March 3, 2022

  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New mechanics and notetags added by Olivia and sponsored by Anon:
      • <Party Artifact>
      • <Troop Artifact>
      • <Stackable Party Artifact>
      • <Stackable Troop Artifact>
        • Armors only! This armor cannot be equipped at all. However, by simply being in the party's inventory, its parameter bonuses and traits will be applied globally throughout the whole party or troop (depending on the notetag). Add both notetags to affect both groups.
        • The normal versions of the notetag is only applied once regardless of the number of copies are found in the party's inventory.
        • The stackable versions of the notetag will have the bonuses and traits stacked multiple times relative to the number of copies found in the party's inventory.
        • This item will NOT be added during the setup phase for Battle Tests.
          • If you want to add the item, do it manually.


Version 1.37: December 23, 2021

  • Compatibility Update
    • Created foundation for proxy items to be used in any applicable system and extension plugins. Update made by Arisu.


Version 1.36: December 2, 2021

  • Feature Update!
    • For those using custom parameters from the Core Engine and do not have the parameters all-capitalized, the plugin will automatically do it for you to prevent errors. Update made by Olivia.


Version 1.35: November 18, 2021

  • Compatibility Update!
    • If this plugin's updated scene is disabled, the Help Window locations for the Item, Equip, and Shop Scenes should now be at their designated locations as calculated by the VisuMZ Core Engine instead of the RMMZ default location. Update made by Irina.


Version 1.34: October 28, 2021

  • Feature Update
    • Added fail safe checks for projects that are using old data for starting equipment that no longer exist, thus preventing the game from opening. Update made by Arisu.


Version 1.33: August 6, 2021

  • Documentation Update!
    • Removed "Weapon" and "Armor" from "Used For" for <Status Info>. This was an unintended piece of documentation.


Version 1.32: July 23, 2021

  • Bug Fixes!
    • Fixed a bug that would cause armor duplication when changing to classes with unaligned equipment slot types. Fix made by Arisu.


Version 1.31: July 9, 2021

  • Feature Update!
    • Added a failsafe for price manipulation JavaScript to never have prices drop below 0 if possible. Update made by Arisu.


Version 1.30: July 2, 2021

  • Documentation Update!
    • Added an extra note to the help file for the following: Plugin Parameters > Item Menu Settings > List Window > Columns
      • If you are using the VisuStella MZ Core Engine and the "Modern Controls" Plugin Parameter, please read through that section in case you have any questions about how to switch between categories when using multiple columns of items at a time.


Version 1.29: June 25, 2021

  • Compatibility Update
    • Compatibility update with RPG Maker MZ 1.3.0+.
  • Feature Update!
    • Phantom data when changing equipment types in the database should no longer affect actors with cached equip ID's. Update made by Arisu.


Version 1.28: June 4, 2021

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.27: May 21, 2021

  • Bug Fixes!
    • Using the mouse right click in the Equip Scene while inside of the item to slot window will no longer exit the Equip Scene. Fix made by Yanfly.


Version 1.26: April 30, 2021

  • Documentation Update!
    • Help file updated for new features.
    • "VisuStella MZ Compatibility" added VisuMZ_1_BattleCore section regarding Damage Multiplier and Healing Multiplier vocabulary settings to reduce commonly asked questions.
  • New Features!
    • New notetags added by Irina and sponsored by Archeia:
      • <Shop Picture Name: filename>
      • <Shop Picture Layer: x>
      • <Shop Picture Max Width: x>
      • <Shop Picture Max Height: y>
      • <Shop Picture Max Dimensions: x, y>
      • <Shop Picture Alignment: x>
      • <Shop Picture Position: y>
      • <Shop Picture Offset X: +x>
      • <Shop Picture Offset X: -x>
      • <Shop Picture Offset Y: +y>
      • <Shop Picture Offset Y: -y>
      • <Shop Picture Offset: +x, +y>
      • <Shop Picture Offset: -x, -y>
      • <Shop Picture Opacity: x>
      • <Shop Picture Opacity: x%>
        • Add images from the game project's img/pictures/ folder to display in the Shop Status Window.


Version 1.25: April 23, 2021

  • Documentation Update!
    • Added clarity to the <param: +x> and <param: -x> notetags:
      • These notetags do NOT work with X Parameters, S Parameters, or any custom parameters. These notetags ONLY work with the base parameters.


Version 1.24: April 16, 2021

  • Bug Fixes!
    • Changing an actor's equipment slots to past their original amount will no longer yield errors with duplicate slot types. Fix made by Arisu.
    • Completely selling an item should now refresh the help window to the new selected item's help description. Fix made by Arisu.
  • Optimization Update!
    • Non-removable equipment restrictions for the equipment scene are now better optimized. Update made by Olivia.


Version 1.23: April 2, 2021

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.22: March 26, 2021

  • Documentation Update!
    • Added "VisuStella MZ Compatibility" section for detailed compatibility explanations with the VisuMZ_4_BreakShields plugin.


Version 1.21: March 5, 2021

  • Feature Update!
    • Custom equipment slots are disabled during Battle Testing for better accuracy and results.


Version 1.20: February 26, 2021

  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New Plugin Parameters added by Irina and sponsored by AndyL:
      • Plugin Parameters > Shop Menu Settings > Switches > Switch: Buy
      • Plugin Parameters > Shop Menu Settings > Switches > Switch: Sell
        • Buying/selling items in the Shop Scene turns this Switch to ON.
        • Switch reverts to OFF whenever the Shop Scene opens.
        • These switches can be used after a "Shop Processing" event command to determine if the player has bought an item, bought and sold an item, sold an item, or neither.


Version 1.19: January 29, 2021

  • Documentation Update!
    • Help file updated for new features.
  • New Features!
    • New notetags added by Irina.
      • <Equip Copy Limit: x>
        • Sets a maximum number of copies that the actor can wear of this equipment. Usage Example: Actors can only equip one copy of the "One-of-a-Kind Ring" on at any time despite having empty accessory slots because the ring has a <Equip Copy Limit: 1> notetag.
      • <Equip Weapon Type Limit: x>
        • This weapon cannot be equipped with other weapons of the same type once the limited amount has been reached. Usage Example: A dualwielding warrior who can only equip one sword and a dagger but never two swords or two daggers because the swords and daggers all have the <Equip Weapon Type Limit: 1> notetags on them.
      • <Equip Armor Type Limit: x>
        • This armor cannot be equipped with other armors of the same type once the limited amount has been reached. Usage Example: People cannot equip more than two glove accessories on at a time because the glove is a "Glove" armor-type and each glove item has the <Equip Armor Type Limit: 2> notetags on them.


Version 1.18: January 15, 2021

  • Bug Fixes!
    • Pressing "Shift" to remove equipment will now refresh the status window unlike before. Fix made by Olivia.
  • Documentation Update!
    • Help file updated for new features.
  • New Feature!
    • New Plugin Parameters added
      • Plugin Parameters > Item Menu Settings > Background Type


Version 1.17: January 1, 2021

  • Bug Fixes!
    • Equipping should be working properly again. Fix made by Yanfly.


Version 1.16: December 25, 2020

  • Bug Fixes!
    • Equip-Adjust HP/MP should work properly now. Fix made by Yanfly.
  • Documentation Update!
    • Added more clarity for <JS Item Enable> to state that if the VisuStella Battle Core is installed, then all battle scope items are visible, but not necessarily enabled if they are disabled otherwise.


Version 1.15: December 18, 2020

  • Bug Fixes!
    • RPG Maker MZ Bug: Unusable items on an individual-actor basis will no longer be overwritten by party-based usability for battle. Fix by Yanfly.
  • Documentation Update!
    • Added more clarity for <JS Item Enable> to state that it removes the usable item from visibility as well if the actor unable to use it is the only person in the party.


Version 1.14: December 11, 2020

  • Compatibility Update!
    • Added compatibility functionality for future plugins.


Version 1.13: December 4, 2020

  • Documentation Update!
    • Added documentation for new feature(s)!
  • New Features!
    • New Plugin Commands added by Arisu!
      • Actor: Change Equip Slots
      • Actor: Reset Equip Slots
        • These plugin commands allow you to forcefully change the equip slots available to an actor regardless of the slots provided by its class as well as reset them.


Version 1.12: November 15, 2020

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.11: November 8, 2020

  • Bug Fix!
    • Font size ratio for the shop status window now scales to a hard coded value to prevent smaller font sizes from expanding icon sizes. Fix made by Arisu.
  • Feature Update!
    • Currency display in the shop menu is now reflected upon how the plugin parameters set them to display. Update made by Arisu.


Version 1.10: November 1, 2020

  • Feature Update!
    • Modern Controls compatibility with Core Engine no longer enables the Item Categories window and child classes to utilize the Home/End keys.


Version 1.09: October 25, 2020

  • Bug Fixes!
    • "All Items" category should now display the "Items" text. Fix by Irina.
    • WType, AType, and EType categories now work with text. Fix by Irina.


Version 1.08: October 18, 2020

  • Compatibility Update!
    • Plugins should be more compatible with one another.


Version 1.07: October 11, 2020

  • Bug Fixes!
    • XParams and SParams in the Window_EquipStatus window will no longer show a non-percentile difference if the original value is not a whole value. Fix made by Yanfly.


Version 1.06: October 4, 2020

  • Bug Fixes!
    • Select Item event command now displays the default amount of columns instead of whatever setting is made with the plugin parameters.


Version 1.05: September 27, 2020

  • Bug Fixes!
    • When using the updated shop layout, leaving the sell option will no longer cause the dummy window to appear.
  • Documentation Update
    • "Use Updated Layout" plugin parameters now have the added clause: "This will override the Core Engine windows settings." to reduce confusion. Added by Irina.


Version 1.04: September 13, 2020

  • Bug Fixes!
    • Pressing Shift to quickly remove equipment should no longer crash the game. This will also clear the help window text. Fix made by Arisu.


Version 1.03: September 6, 2020

  • Bug Fixes!
    • If both Optimize and Clear commands have been removed and using modern controls, pressing up at the top of the slot window list will not go to the window. Fix made by Yanfly.
    • If both Optimize and Clear commands have been removed, the window will no longer appear and the slot window will be moved upward to fill any empty spaces. Fix made by Yanfly.
  • New Features!
    • New Plugin Parameter added in NEW! Label to let you adjust the font face.
    • New Plugin Parameters added in Equip Menu Scene Settings for disabling the back rectangles and/or changing their colors.
    • New Plugin Parameters added in Shop Status Window Settings for disabling the back rectangles and/or changing their colors.


Version 1.02: August 30, 2020

  • Documentation Fix!
    • Added: NOTE: Regarding Damage Labels
      • If Visu_1_BattleCore is installed, priority goes to its Damage Style settings. The label displayed is based on the damage style settings in place for that specific skill or item.
      • Go to Battle Core > Plugin Parameters > Damage Settings > Style List > pick the damage style you want to edit > Damage Label and change the text settings you'd like there.
      • Documentation update added by Yanfly.


Version 1.01: August 23, 2020

  • Added failsafe to prevent non-existent equipment (because the database entries have been deleted) from being equipped as initial equipment. Fix made by Olivia.


Version 1.00: August 20, 2020

  • Finished Plugin!

See Also


End of File