Field Skills 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.


FieldSkills Preview1.png

FieldSkills Preview2.gif

FieldSkills Preview3.gif

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.

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

Introduction

FieldSkills Preview1.png

Field Skills differ from Menu skills where they can be also activated from the map to utilize a common event. On top of that, if attached to a battle skill, it allows skills to have a different function in-battle than when out of battle. The Field Skills plugin allows the player to pull up a menu list of skills that the player can select from and activate from the map scene. When selected, the common event attached to the Field Skill will launch and activate, allowing for custom unique effects to occur.

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

  • Field Skills will activate Common Events upon selection and can have a separate usage from their in-battle functionality.
  • Field Skills can be activated from the map scene in a specialized window to keep everything in one scene.
  • Plugin Commands can be used to manually open the Field Skills List Window.
  • Notetags can be used to determine which Field Skills can be enabled, disabled, hidden, or shown via Switches and Region ID's.
  • This means that you can have some conditional Field Skills that can only be used while the player is standing in a specific location marked by certain Region types and/or while certain switches are ON.

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.


Major Changes

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

---

Scene_Skill Activation

FieldSkills Preview2.gif

If the Plugin Parameter for "Scene_Skill > Usable Field Skills?" is enabled, then Field Skills (skills with the <Field Skill Common Event: x> notetag) can be activated from the Skill Scene regardless of their original occassion being limited to "Battle Only" or "Never".

Furthermore, they will have a different effect when activated from the Skill scene than in battle. This new effect will be treated like a skill that can launch a Common Event and immediately take the player to the map scene where the Common Event is reserved and activated.

---

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.

---

Field Skill-Related Notetags

FieldSkills Preview2.gif

---

<Field Skill Common Event: x>

- Used for: Skill Notetags
- Makes the skill into a Field Skill that activates Common Event 'x'.
  - If this is used for a "Battle Only" or "Never" skill while the Plugin
    Parameter for "Scene_Skill > Usable Field Skills?" is on, the skill can
    now be activated through the Skill scene.
  - Field Skills will have a different effect from their battle variants.
- Replace 'x' with a number representing the ID of the Common Event to
  activate for this Field Skill.

---

<Field Skill Help Description>
 text
 text
</Field Skill Help Description>

- Used for: Skill Notetags
- When usable as a Field Skill, display different help description.
- Replace 'text' with the text data you'd like displayed in place of the
  default skill description if this skill can be used as a Field Skill.

---

<Disable Field Skills>

- Used for: Map Notetags
- Disables Field Skills from being able to be used on this map.

---

<Show Field Skill Switch: x>

<Show Field Skill All Switches: x,x,x>
<Show Field Skill Any Switches: x,x,x>

- Used for: Skill Notetags
- Determines the visibility of the Field Skill based on switches.
  - The invisibility will only affect the map Field Skill List Window.
  - However, invisibility will disable the Field Skill in the Skill scene.
- Replace 'x' with the switch ID to determine the skill's visibility.
  - Insert multiple 'x' values to cover more ID's.
- If 'All' notetag variant is used, skill will be hidden until all switches
  are ON. Then, it would be shown.
- If 'Any' notetag variant is used, skill will be shown if any of the
  switches are ON. Otherwise, it would be hidden.

---

<Show Field Skill Region ID: x>
<Show Field Skill Region ID: x,x,x>

- Used for: Skill Notetags
- If the player's current standing tile's Region ID is listed, then the
  Field Skill is considered visible and shown.
  - The invisibility will only affect the map Field Skill List Window.
  - However, invisibility will disable the Field Skill in the Skill scene.
- Replace 'x' with the ID of the region to determine the skill's visibility.
  - Insert multiple 'x' values to cover more ID's.

---

<Hide Field Skill Switch: x>

<Hide Field Skill All Switches: x,x,x>
<Hide Field Skill Any Switches: x,x,x>

- Used for: Skill Notetags
- Determines the visibility of the Field Skill based on switches.
  - The invisibility will only affect the map Field Skill List Window.
  - However, invisibility will disable the Field Skill in the Skill scene.
- Replace 'x' with the switch ID to determine the skill's visibility.
  - Insert multiple 'x' values to cover more ID's.
- If 'All' notetag variant is used, skill will be shown until all switches
  are ON. Then, it would be hidden.
- If 'Any' notetag variant is used, skill will be hidden if any of the
  switches are ON. Otherwise, it would be shown.

---

<Hide Field Skill Region ID: x>
<Hide Field Skill Region ID: x,x,x>

- Used for: Skill Notetags
- If the player's current standing tile's Region ID is listed, then the
  Field Skill is considered invisible and hidden.
  - The invisibility will only affect the map Field Skill List Window.
  - However, invisibility will disable the Field Skill in the Skill scene.
- Replace 'x' with the ID of the region to determine the skill's visibility.
  - Insert multiple 'x' values to cover more ID's.

---

<Enable Field Skill Switch: x>

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

- Used for: Skill Notetags
- Determines the enabled status of the Field Skill based on switches.
  - The usability only affects the Field Skill as a Field Skill and does
    not affect its usability as a battle skill.
- Replace 'x' with the switch ID to determine the skill's enabled status.
  - Insert multiple 'x' values to cover more ID's.
- If 'All' notetag variant is used, skill will be disabled until all
  switches are ON. Then, it would be enabled.
- If 'Any' notetag variant is used, skill will be enabled if any of the
  switches are ON. Otherwise, it would be disabled.

---

<Enable Field Skill Region ID: x>
<Enable Field Skill Region ID: x,x,x>

- Used for: Skill Notetags
- If the player's current standing tile's Region ID is listed, then the
  Field Skill is considered enabled.
  - The usability only affects the Field Skill as a Field Skill and does
    not affect its usability as a battle skill.
- Replace 'x' with the ID of the region to enable the skill.
  - Insert multiple 'x' values to cover more ID's.

---

<Disable Field Skill Switch: x>

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

- Used for: Skill Notetags
- Determines the enabled status of the Field Skill based on switches.
  - The usability only affects the Field Skill as a Field Skill and does
    not affect its usability as a battle skill.
- Replace 'x' with the switch ID to determine the skill's enabled status.
  - Insert multiple 'x' values to cover more ID's.
- If 'All' notetag variant is used, skill will be enabled until all switches
  are ON. Then, it would be disabled.
- If 'Any' notetag variant is used, skill will be disabled if any of the
  switches are ON. Otherwise, it would be enabled.

---

<Disable Field Skill Region ID: x>
<Disable Field Skill Region ID: x,x,x>

- Used for: Skill Notetags
- If the player's current standing tile's Region ID is listed, then the
  Field Skill is considered disabled.
  - The usability only affects the Field Skill as a Field Skill and does
    not affect its usability as a battle skill.
- Replace 'x' with the ID of the region to disable the skill.
  - Insert multiple 'x' values to cover more ID's.

---

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

FieldSkills Preview2.gif

FieldSkills Command1.png

---

Map: Open Field Skills List
- Open Field Skills list without shortcut key.
- Field Skills List Window Accessibility required.

---

System Plugin Commands

FieldSkills Preview3.gif

FieldSkills Command2.png

---

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

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

---

Plugin Parameters

General Settings

FieldSkills Preview2.gif

FieldSkills Param1.png

General settings for the Field Skills plugin.

---

Map Field Skills List

 Default Enable?:
 - Enable access to the Map Field Skills List by default?
 Shortcut Key:
 - What key is used to activate the Map Field Skills List Window?
 Show Help Window?:
 - Show the Help Window when the Map Field Skills List window is active?

---

Scene_Skill

 Usable Field Skills?:
 - In Skill scene, can the player use/activate Field Skills?
 Use Field Skill Help?:
 - In Skill scene, show <Field Skill Help Description> contents in
   Help Window?

---

Scene_Map > Window_Help

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

---

Scene_Map > Window_FieldSkillList

 All Members?:
 - Display which party members for their Field Skills in the window?
 Cancel Button?:
 - Add the Cancel Button to the window?
 Face or Name?:
 - Display the member's face or name?
 Buffer Skill Name:
 - Buffer the distance for the skill name by this much in x.
 Background Type:
 - Select background type for this window.
 JS: X, Y, W, H:
 - Code used to determine the dimensions for this window.

---

Sound Settings

FieldSkills Preview3.gif

FieldSkills Param2.png

Sound Effect played when opening the Field Skills list on the map.

---

Open List

 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 Skill

 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: December 15, 2022

  • Bug Fixes!
    • Fixed an incompatibility with VisuMZ Skill Learn System. Fix by Irina.
  • Compatibility Update!
    • Plugins should be more compatible with one another.


Version 1.00 Official Release Date: December 7, 2022

  • Finished Plugin!


See Also


End of File