Limited Skill Uses 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.

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


UpdatePlugins.png

Click here to learn how to update plugins.


Troubleshooting.jpg

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



LimitedSkillUses Preview1.png

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.


VisuStella MZ

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


Support VisuStella

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


Introduction

LimitedSkillUses Preview1.png

This plugin enables you to set a limited amount of times certain skills (or all skills) can be used per battle or ever. This adds a different type of skill currency and balance mechanic in limiting the amount of times a skill can be used without directly having to alter MP, TP, or the like.

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

  • Determine globally or individually how many skill uses a battler can use per battle (does not apply to basic attack and guard skills).
  • Determine how many uses are restored per battle.
  • Use notetag effects to alter the amount of uses a user or target has globally, for specific skill types, or for specific individual skills.
  • Adjust how the limited uses are displayed in-game.
  • Equipment, class types, states, etc. can all affect the maximum quantity of uses for skills, too.

Requirements

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

Required Plugin List

This plugin requires the above listed plugins to be installed inside your game's Plugin Manager list in order to work. You cannot start your game with this plugin enabled without the listed plugins.


Tier 3

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


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.

---

Basic Limited Use-Related Notetags

LimitedSkillUses Preview1.png

---

<Limited Uses: x>

- Used for: Skill Notetags
- Sets the limited use maximum base amount for this skill.
- This value will override the Plugin Parameter settings for a base value if
  "All Skills Limited?" is turned on.
- Replace 'x' with a number value representing the base maximum uses this
  skill can have.

---

<Unlimited Use>

- Used for: Skill Notetags
- If the Plugin Parameter "All Skills Limited?" is turned on, this will
  disable limited uses for this skill, allowing it to be used in unlimited
  amounts independent of the Limited Use base.

---

Use Recovery-Related Notetags

LimitedSkillUses Preview1.png

---

<Victory Uses Recover: x>
<Escape Uses Recover: x>
<Defeat Uses Recover: x>
<After Battle Uses Recover: x>

- Used for: Skill Notetags
- Determines how many limited uses are recovered at the end of each battle
  depending on the result.
  - Victory notetag variant requires winning the battle.
  - Escape notetag variant requires escaping the battle.
  - Defeat notetag variant requires losing the battle.
  - After Battle notetag variant applies to all cases.
- Replace 'x' with how many uses are restored upon completing a battle.

---

<Bypass Recover All Uses>

- Used for: Skill Notetags
- This prevents the skill from recovering all uses with the "Recover All"
  event command.

---

<Allow Recover All Uses>

- Used for: Skill Notetags
- This allows the skill to recover all uses with the "Recover All" event
  command when the "Recover All?" plugin parameter is disabled.

---

Use Alteration-Related Notetags

LimitedSkillUses Preview1.png

---

<User Global Uses: +x>
<User Global Uses: -x>

<User SType id Uses: +x>
<User SType id Uses: -x>
<User SType name Uses: +x>
<User SType name Uses: -x>

<User Skill id Uses: +x>
<User Skill id Uses: -x>
<User Skill name Uses: +x>
<User Skill name Uses: -x>

- Used for: Skill, Item Notetags
- Alters the limited use amounts for the action's user.
  - Global notetag variant affects all limited uses.
  - SType notetag variant effects all skills with a matching type.
  - Skill notetag viarant effects a specific matching skill.
- Replace 'id' with the ID of the skill type.
- Replace 'name' with the name of the skill type (without text codes).
- Replace 'x' with the amount to alter the remaining uses by. Positive
  values restore uses while negative values reduce remaining uses.

---

<Target Global Uses: +x>
<Target Global Uses: -x>

<Target SType id Uses: +x>
<Target SType id Uses: -x>
<Target SType name Uses: +x>
<Target SType name Uses: -x>

<Target Skill id Uses: +x>
<Target Skill id Uses: -x>
<Target Skill name Uses: +x>
<Target Skill name Uses: -x>

- Used for: Skill, Item Notetags
- Alters the limited use amounts for the action's target.
  - Global notetag variant affects all limited uses.
  - SType notetag variant effects all skills with a matching type.
    - Replace 'id' with the ID of the skill type.
    - Replace 'name' with the name of the skill type (without text codes).
  - Skill notetag viarant effects a specific matching skill.
    - Replace 'id' with the ID of the skill.
    - Replace 'name' with the name of the skill.
- Replace 'x' with the amount to alter the remaining uses by. Positive
  values restore uses while negative values reduce remaining uses.

---

Trait Based-Related Notetags

LimitedSkillUses Preview1.png

---

<Gloal Use Max: +x>
<Gloal Use Max: -x>

<SType id Use Max: +x>
<SType id Use Max: -x>
<SType name Use Max: +x>
<SType name Use Max: -x>

<Skill id Use Max: +x>
<Skill id Use Max: -x>
<Skill name Use Max: +x>
<Skill name Use Max: -x>

- Used for: Actor, Class, Weapon, Armor, Enemy, State Notetags
- Changes the maximum limited uses for all skills, skills of a particular
  type, or individual skills.
  - Global notetag variant affects all limited uses.
  - SType notetag variant effects all skills with a matching type.
    - Replace 'id' with the ID of the skill type.
    - Replace 'name' with the name of the skill type (without text codes).
  - Skill notetag viarant effects a specific matching skill.
    - Replace 'id' with the ID of the skill.
    - Replace 'name' with the name of the skill.
- Replace 'x' with the amount to adjust the maximum uses by. Positive values
  increase the maximum uses while negative values decrease them.
  - These will be hard capped by the settings found in the Plugin Parmeters.

---

Plugin Parameters

General Settings

LimitedSkillUses Preview1.png

LimitedSkillUses Param1.png

General settings regarding Limited Skill Uses.

---

General

 Limited Use Icon:
 - Icon used for representing Limited Uses in the cost.
 Cost Format:
 - Format for Limited Use cost display.
 - %1 - Remaining, %2 - Max Uses, %3 - Times Used, %4 - Icon
 Empty Format:
 - Format for Limited Use cost display when empty.
 - %1 - Remaining, %2 - Max Uses, %3 - Times Used, %4 - Icon
 Cost Position Front?:
 - Put the Limited Uses at the front of skill/item costs?

---

Mechanics Settings

LimitedSkillUses Preview1.png

LimitedSkillUses Param2.png

Mechanical settings regarding Limited Skill Uses.

---

All Limited

 All Skills Limited?:
 - Make all skills have limited uses?
 - Does not apply to basic attack and guard.
   Default Max:
   - If all skills are limited, what is the default maximum uses?

---

Hard Caps

 Maximum:
 - What is the maximum hardcap for limited uses?
 Minimum:
 - What is the minimum hardcap for limited uses?

---

Recovery

 Battle Victory:
 - How many uses for each skill does a victory restore by default?
 Battle Escape:
 - How many uses for each skill does an escape restore by default?
 Battle Defeat:
 - How many uses for each skill does a defeat restore by default?
 Recover All?:
 - Does the "Recover All" command restore Limited Skill Uses?

---


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: March 26, 2021

  • Compatibility Update!
    • Skill type limited uses now affect all skill types with skills that have multiple skill types declared through the Skills and States Core.


Version 1.00 Official Release Date: March 10, 2021

  • Finished Plugin!

End of File