Item Upgrade Slots (YEP)

From Yanfly.moe Wiki
Jump to navigation Jump to search


System

This is a plugin created for RPG Maker MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.

Download

Required Plugins

The following plugins are required in order to use this plugin.

Place the following plugins above this plugin located in the Plugin Manager.

Yanfly Engine Plugins

This plugin is a part of the Yanfly Engine Plugins library.

Click here if you want to help support Team Yanfly on Patreon.

Introduction

This plugin requires YEP_ItemCore.
Make sure this plugin is located under YEP_ItemCore in the plugin list.

This plugin adds Item Upgraders, where you can select the base item and then
apply the appropriate Item Upgraders onto it to boost its parameters.

Notetags

NotetagsMV.png

RPG Maker MV'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 notetags can be used to modify item upgrades.

Weapon, and Armor Notetags
  <Upgrade Slots: x>
  This sets the number of times an item can be upgraded instead of the
  default amount defined in the database.

  <Slot Variance: x>
  This makes it so that there is a random variance for the number of slots
  provided through the item. If this notetag isn't used, it will go by the
  setting in the parameters.

  <Upgrade Sound: filename>
  Changes the upgrade sound played to 'filename'. If this notetag isn't
  used, the 'Default Sound' parameter sound will be used instead.

  <Upgrade Effect>
   effect
   effect
  </Upgrade Effect>
  These are the effects applied (in the order they're listed). Refer to the
  'Upgrade Effects List' in the next section to have those effects applied
  to the upgraded item.

  <Upgrade Item Type: All>
  <Upgrade Item Type: Regular>
  <Upgrade Item Type: Key>
  <Upgrade Item Type: Hidden A>
  <Upgrade Item Type: Hidden B>
  <Upgrade Item Type: Always>
  <Upgrade Item Type: Battle>
  <Upgrade Item Type: Menu>
  <Upgrade Item Type: Never>
  <Upgrade Item Type: string>
  This makes it so this item can be used to upgrade the item that matches
  either the item type or the item occassion. If none of those work for you,
  you can use the following notetag and place an instance for 'string'
  inside of the item upgrade types.

  <Type: string>
  Puts this type into the notebox for items (not weapons nor armors) and it
  will add 'string' as its type. You can insert multiple copies of this
  notetag to enable the item to have more types. Any types in here that
  match the types for the previous notetag will enable the item to be
  upgradeable by that upgrade item type.

  <Upgrade Weapon Type: x>
  <Upgrade Weapon Type: x, x, x>
  <Upgrade Weapon Type: x through x>
  This makes it so that only weapon types x can use this item for upgrade.
  If you use weapon type 0, all weapons can be upgraded using this item.

  <Upgrade Armor Type: x>
  <Upgrade Armor Type: x, x, x>
  <Upgrade Armor Type: x through x>
  This makes it so that only armor types x can use this item for upgrade.
  If you use armor type 0, all armor can be upgraded using this item.

Upgrade Effects List

The following is a list of effects you can use for the <Upgrade Effects>
notetag to have it apply the desired effects to the upgraded item.

Effect Text               Upgrade Effect:
  Base Name: x            - Changes item's base name to x. *Note2
  Boost Count: +x         - Increases Boost Count by x. *Note2
  Boost Count: -x         - Decreases Boost Count by x. *Note2
  Eval: x                 - Runs x as a piece of code. *Note2
  Name: x                 - Changes item's name to x. *Note2
  Icon: x                 - Changes item's icon to x. *Note2
  Picture Image: filename - Changes item's picture image to filename. *Note4
  Picture Hue: x          - Changes item's picture hue to x. *Note4
  Prefix: x               - Changes item's prefix to x. *Note2
  Priority Name: x        - Sets priority name to x. *Note2
  Random Stat: x          - Increases or decreases 'Stat' by 0 to x. *Note1
  Random Stat: +x         - Increases 'Stat' by 0 to x. *Note1
  Random Stat: -x         - Decreases 'Stat' by 0 to x. *Note1
  Reset Base Name         - Resets the base name to default.
  Reset Boost Count       - Resets the Boost Count to 0.
  Reset Icon              - Resets the icon back to the default icon.
  Reset Prefix            - Resets name prefix to default.
  Reset Stat              - Resets 'Stat' back to base stat values. *Note1
  Reset Suffix            - Resets name suffix to default.
  Reset Full              - Resets every single aspect about item. *Note3
  Slots: x                - Changes the slot consumption cost to x. *Note1
  Stat: +x                - Increases 'Stat' by x. *Note1
  Stat: +x%               - Increases 'Stat' by x% of base stat. *Note1
  Stat: -x                - Decreases 'Stat' by x. *Note1
  Stat: -x%               - Decreases 'Stat' by x% of base stat. *Note1
  Suffix: x               - Changes item's suffix to x. *Note2
  Text Color: x           - Changes item's text color to x.

Note1: 'Stat' is to be replaced by 'MaxHP', 'MaxMP', 'ATK', 'DEF', 'MAT',
'MDF', 'AGI', 'LUK', 'SLOTS', 'ALL' or 'CURRENT'. 'ALL' affects all stats.
'CURRENT' affects only non-zero stats. This effect will also increase the
boost count (+x) by 1 and update the item's name.

Note2: This does not alter boost count nor update the item's name unless
it is altered by the effect.

Note3: Because this effect resets absolutely everything about an item, it
will send the player away from the upgrade menu to reset the standings of
the item.

Note4: This requires the Item Picture Images plugin.

Plugin Commands

PluginCommandsMV.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 MV.

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

The following are some Plugin Commands you can use for your game regarding
the upgrade option in the item menu:

Plugin Command:
  ShowItemUpgrade    - Shows the upgrade option in the item menu.
  HideItemUpgrade    - Hides the upgrade option in the item menu.
  DisableItemUpgrade - Disables the upgrade option in the item menu.
  EnableItemUpgrade  - Enables the upgrade option in the item menu.

You can use those Plugin Commands at any time to adjust the upgrade option.

Tips & Tricks

The following Tips & Tricks effects use this plugin:

Changelog

Version 1.10:
- Changed upgrade command from appearing if there are 0 slots as a baseline.

Version 1.09:
- Bypass the isDevToolsOpen() error when bad code is inserted into a script
call or custom Lunatic Mode code segment due to updating to MV 1.6.1.

Version 1.08:
- Updated for RPG Maker MV version 1.5.0.

Version 1.07:
- Lunatic Mode fail safes added.

Version 1.06a:
- Fixed a bug that caused an error with the way items upgraded.
- Fixed a bug that didn't connect with the Equip Customize Command plugin.

Version 1.05:
- Updated for RPG Maker MV version 1.1.0.

Version 1.04:
- Added 'Text Color: x' upgrade effect to allow you to change the text color
of independent items.

Version 1.03:
- Fixed a bug that caused slot variance to not calculate correctly.
- Added 'stat +x%' and 'stat -x%' to upgrade effects.

Version 1.02:
- Fixed a bug that prevented upgrading if the only effect is boosting.

Version 1.01:
- Added 'Show Only' parameter. This will cause the upgrade command to only
appear if the item can be upgraded.

Version 1.00:
- Finished plugin!