Hospital Shop 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.


HospitalShop Preview.png


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

VisuMZ.121.jpg

In most RPG's, inns are often used to allow parties to recover their health, restore their status, etc. It's often a cure-all for a set price. This hospital setting, however, charges based on the amount of damage taken, to the amount of mana consumed, and the state ailments inflicted also have a bearing on the cost. Players can also heal individual members as opposed to all members of their party in the event that they cannot heal the whole party. This provides a challenge to the player and also provides a more cost-proportional way of recovering from damage obtained through battle.

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

  • Heal individual actors based on the amount of HP damage they've taken, MP that they've consumed, or states afflicted upon them.
  • Heals all party members at a single time with a discount, too.
  • Adjust the cost of healing each HP, MP, revival, and state recovery.
  • Special notetags that allow you to change the cost for specific states.
  • Plugin Command allow you to call up the hospital scene from the map.

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.



VisuStella MZ Compatibility

HospitalShop Preview.png

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.

---

Skills and States Core VisuStella MZ

The <No Recover All Clear> notetag can be used on states to prevent them from being cleared in the hospital when selecting an actor to heal.

---

Visual Gold Display VisuStella MZ

The cost of healing per actor will be shown in Visual Gold Display format.

---


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.

---

State-Related Notetags

HospitalShop Preview.png

---

<Hospital Cost: x>

- Used for: State Notetags
- Changes the cost to recover this state in the hospital to 'x'.
- Replace 'x' with a number representing the amount of gold needed to help
  the actor remove this state in the hospital scene.
- If this notetag is not used, use the default cost found in the
  Plugin Parameters.

---

<No Recover All Clear>

- Used for: State Notetags
- Requires VisuMZ_1_SkillsStatesCore!
- This notetag will prevent the hospital and the "Recover All" event command
  from removing this state nor charging for it.

---


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.

Scene Plugin Commands

HospitalShop Preview.png

---

Scene: Open Hospital Shop
- Opens the hospital shop.
- Cannot be used in battle.

  Discount Rate:
  - Determine the discount rate used for party heal.
  - You may use JavaScript code.

---

Plugin Parameters

General Settings

HospitalShop Preview.png

Adjust the general settings for this plugin.

---

Costs

 Cost Per HP:
 - How much gold should it cost to heal each HP?
 Cost Per MP:
 - How much gold should it cost to restore each MP?
 Death Cost by Level:
 - How much gold should it cost to revive from death per level of
   the actor?

---

Defaults

 State Cost:
 - Default gold cost to recover from a state.
 - Bypass with <Hospital Cost: x> state notetag.

---

Maximums

 Max Cost Per Level:
 - Maximum gold cost per actor level.
 - Pick lowest cost between this and global.
 Max Cost Global:
 - Maximum gold cost ever.
 - Pick lowest cost between this and per level.

---


Background Settings

HospitalShop Preview.png

Background settings for Scene_Hospital.

---

Background Settings

 Snapshop Opacity:
 - Snapshot opacity for the scene.
 Background 1:
 - Filename used for the bottom background image.
 - Leave empty if you don't wish to use one.
 Background 2:
 - Filename used for the upper background image.
 - Leave empty if you don't wish to use one.

---


Vocabulary Settings

HospitalShop Preview.png

These settings let you adjust the text displayed for this plugin.

---

Command Window

 Heal Text:
 - Text used for this command.
   Icon:
   - Icon used for this command.
   Help Description:
   - Help window description used for this command.
   - Text codes allowed.
 Cancel Text:
 - Text used for this command.
   Icon:
   - Icon used for this command.
   Help Description:
   - Help window description used for this command.
   - Text codes allowed.

---

Heal List Window

 Actor:
   Help Description:
   - Help window description used for target actor.
   - %1 - Name, %2 - Level, %3 - Class, %4 - Cost, %5 - Gold
 Recover All:
   Command Text:
   - Text displayed for this recovery type command.
   Text Color:
   - Use #rrggbb for custom colors or regular numbers for text colors from
     the Window Skin.
   Help Description:
   - Help window description used for party recovery.
   - %1 - Cost, %2 - Gold
   Discount Text Format:
   - Text format used to display the discount text.
   - %1 - Discount Percentage
     Decimal Places:
     - Decimal places used for discount percentage.

---


Window Settings

HospitalShop Preview.png

These settings let you adjust the windows displayed for this plugin.

---

Help Window

 Background Type:
 - Select background type for this window.

---

Command Window

 Background Type:
 - Select background type for this window.
 Style:
 - How do you wish to draw commands for this window?
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Gold Window

 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Heal List Window

 Add Recover All?:
 - Adds the recover all members command?
 Background Type:
 - Select background type for this window.
 Draw Actor Face?:
 - Draws the face of the actor.
 Draw Actor Name?:
 - Draws the name of the actor.
 Draw HP Gauge?:
 - Draws the HP Gauge of the actor.
 Draw MP Gauge?:
 - Draws the MP Gauge of the actor.
 Draw State Icons?:
 - Draws the actor's state icons.
   Number Drawn:
   - How many icons should be drawn?
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---



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.02: August 17, 2023

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


Version 1.01: May 18, 2023

  • Bug Fixes
    • If faces weren't loaded ahead of time, they wouldn't show up in the shop. This should now be fixed. Fix made by Arisu.


Version 1.00 Official Release Date: May 22, 2023

  • Finished Plugin!

See Also


End of Helpfile