Full Field Recovery VisuStella MZ

From Yanfly.moe Wiki
Revision as of 14:05, 23 November 2022 by Irina (talk | contribs) (Changelog)
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


FullFieldRec Preview1.png

FullFieldRec Preview2.gif


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

FullFieldRec Preview2.gif

Do you shower your players with items only to find out that they don't use them? Or perhaps they're always hoarding the items despite being incredibly low on health while they explore dungeons? This plugin adds in a simple button press for your players to push in order to pull up a Full Field Recovery window and uses items to fully recover the party's HP, MP, and status by using lower cost items first to higher cost ones (or if you want, create your own priority list). This quality of life feature will make the dungeon crawling aspect of your game more comfortable for your players provided that you give them a plethora of items to heal with.

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

  • Adds Quality of Life command that's found throughout most modern JRPG's to let the player quickly heal the party by automatically using items.
  • Items used will automatically prioritized from lowest cost to highest cost as to not waste the player's more valuable items.
  • If you prefer to make your own priority list, you can do so via the Plugin Parameters based on the healing type for HP, MP, and States.
  • Shortcut key on the map allows the player to quickly pull up the Full Field Recovery option.
  • Notetags can be used to include or exclude items from the priority list.

Requirements

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


Tier 4

This plugin is a Tier 4 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.


Understanding Auto-Priority List

FullFieldRec Preview1.png

If you left the Plugin Parameter item lists empty, then you're allowing the plugin to create its own priority list. Here's how the list rulings work for each healing type (State, HP, and MP).

When healing via Full Field Recovery, states are healed first, followed by HP, followed by MP.

---

Automatic State Recovery Item Inclusion Rulings

1. Nonconsumable items are listed at the top of the priority list regardless of their price that can be used with "Always" / "Menu Only".

2. Consumable items are added in order listed by price first then by ID from lowest to highest that can be used with "Always" / "Menu Only". Items must have at least a price of 1.

3. If an item has the notetags <Exclude Field State Recovery> or <Exclude Field Recovery>, then that item is excluded from the list.

4. If an item has the notetag <Include Field State Recovery>, then that item is included into the list.

5. If an item has the "Remove State" type in their database entry's Effects list and nothing else, then that item is included into the list. However, any other effects like "Add State" or "Recover HP" or "Recover MP" or "Gain TP" will invalidate the automatic addition and will therefore require the aid of the <Include Field State Recovery> notetag.

---

Automatic HP Recovery Item Inclusion Rulings

1. Nonconsumable items are listed at the top of the priority list regardless of their price that can be used with "Always" / "Menu Only".

2. Consumable items are added in order listed by price first then by ID from lowest to highest that can be used with "Always" / "Menu Only". Items must have at least a price of 1.

3. If an item has the notetags <Exclude Field HP Recovery> or <Exclude Field Recovery>, then that item is excluded from the list.

4. If an item has the notetag <Include Field HP Recovery>, then that item is included into the list.

5. If an item has the "Recover HP" type in their database entry's Effects list and nothing else, then that item is included into the list. However, any other effects like "Add State" or "Remove State" or "Recover MP" or "Gain TP" will invalidate the automatic addition and will therefore require the aid of the <Include Field HP Recovery> notetag.

---

Automatic MP Recovery Item Inclusion Rulings

1. Nonconsumable items are listed at the top of the priority list regardless of their price that can be used with "Always" / "Menu Only".

2. Consumable items are added in order listed by price first then by ID from lowest to highest that can be used with "Always" / "Menu Only". Items must have at least a price of 1.

3. If an item has the notetags <Exclude Field MP Recovery> or <Exclude Field Recovery>, then that item is excluded from the list.

4. If an item has the notetag <Include Field MP Recovery>, then that item is included into the list.

5. If an item has the "Recover MP" type in their database entry's Effects list and nothing else, then that item is included into the list. However, any other effects like "Add State" or "Remove State" or "Recover MP" or "Gain TP" will invalidate the automatic addition and will therefore require the aid of the <Include Field MP Recovery> notetag.

---

For those wondering why number 5 of each option is so strict as to not allow other effect types, it's in order to streamline the process so that there is no unfavorable prioritization as multi-purpose items have more inherent value than their price typically suggests. However, if you do wish to include these hybrid effect items into your priority lists, either add them through notetags or through the Plugin Parameters.

---

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.

---

Map-Related Notetags

FullFieldRec Preview2.gif

---

<Disable Full Field Recovery>

- Used for: Map Notetags
- Disables Full Field Recovery from being used on this map.

---

Item-Related Notetags

FullFieldRec Preview2.gif

---

<Exclude Field Recovery>
<Exclude Field HP Recovery>
<Exclude Field MP Recovery>
<Exclude Field State Recovery>

- Used for: Item Notetags
- Excludes this specific item from being included into the automatically
  generated lists of field recovery items.
- If using a planned priority list, ignore this notetag.
- The general <Exclude Field Recovery> notetag will exclude from all three
  lists while the HP, MP, and State specific ones target only those lists.

---

<Include Field HP Recovery>
<Include Field MP Recovery>
<Include Field State Recovery>

- Used for: Item Notetags
- Includes this specific item into the automatic field recovery item list.
- If using a planned priority list, ignore this notetag.
- This still requires the item to have an occassion type of "Always" or
  "Menu Only" in order to be usable via Full Field Recovery.

---

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.

---

Map Plugin Commands

FullFieldRec Preview2.gif

FullFieldRec Command1.png

---

Map: Open Full Field Recovery Message
- Open Full Field Recovery Message without shortcut key.
- Full Field Recovery Accessibility required.

---

System Plugin Commands

FullFieldRec Preview2.gif

FullFieldRec Command2.png

---

System: Enable Full Field Recovery?
- Enable/disable Full Field Recovery from being accessible?
- Does NOT bypass <Disable Full Field Recovery> map notetag.

  Enable/Disable?:
  - Enables/disables Full Field Recovery on map scene?
  - Does NOT bypass <Disable Full Field Recovery> map notetag.

---

Plugin Parameters

General Settings

FullFieldRec Preview1.png

FullFieldRec Param1.png

General settings for the Full Field Recovery plugin.

---

Full Field Recovery

 Default Enable?:
 - Enable access to the map Full Field Recovery by default?
 Shortcut Key:
 - What key is used to activate the Full Field Recovery Window?
 Animation ID:
 - Play this animation when the effect activates.

---

Mechanics

 Heal HP?:
 - Use healing items to recover HP?
   HP Item List:
   - Priority list of items to use for HP recovery.
   - Leave empty to automatically populate.
 Heal MP?:
 - Use healing items to recover MP?
   MP Item List:
   - Priority list of items to use for MP recovery.
   - Leave empty to automatically populate.
 Heal States?:
 - Use healing items to recover states?
   States Item List:
   - Priority list of items to use for state recovery.
   - Leave empty to automatically populate.

---

Scene_Map > Message Window

 Vocab: Already Full:
 - Text used when all members are fully healed.
 - You may use text codes.
 Vocab: Lacking Items:
 - Text used when not enough items to heal with.
 - You may use text codes.
 Vocab: Heal Prompt:
 - Text used when not enough items to heal with.
 - You may use text codes.
 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Scene_Map > Choice Window

 Vocab: Heal Option:
 - Text used for the heal option.
 - You may use text codes.
 Vocab: Cancel Option:
 - Text used for the cancel option.
 - You may use text codes.
 Background Type:
 - Select background type for this window.
 Text Alignment:
 - Pick the text alignment for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Sound Settings

FullFieldRec Preview2.gif

FullFieldRec Param2.png

Settings for the Full Field Recovery sound effect

---

Ask Full Recovery

 Filename:
 - Filename of the sound effect played.
 Volume:
 - Volume of the sound effect played.
 Pitch:
 - Pitch of the sound effect played.
 Pan:
 - Pan of the sound effect played.

---

Use Full Recovery

 Filename:
 - Filename of the sound effect played.
 Volume:
 - Volume of the sound effect played.
 Pitch:
 - Pitch of the sound effect played.
 Pan:
 - Pan of the sound effect played.

---


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

Changelog

Version 1.01: November 24, 2022

  • Documentation Update!
    • Updated "Understanding Auto-Priority List" section to given more info on priority healing.
  • Feature Update!
    • Battle-participants will be given priority for healing items first. Once they have received full recovery, reserve party members will then be focused on for full team field recovery.


Version 1.00 Official Release Date: December 9, 2022

  • Finished Plugin!

End of File