Visual State Effects 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.



VisualStateEffectsPopups.gif

VisualStateEffectsRepeatCycle.gif

VisualStateEffectsHover.gif

VisualStateEffectsToneFrozen.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.


Support VisuStella

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


Introduction

States, buffs, and debuffs are amongst one of the most important aspects of the battle system. Therefore, relaying proper information to the player is extremely important. RPG Maker MZ does relay information to the player about the various states and effects, but it is far from perfect. This plugin allows you to add more detail and visual effects regarding states to relay proper data.

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

  • Choose to display State Overlays and State Icons over actors and enemies.
  • Create text popups for Buffs, Debuffs, and States along with full control over their color, flash, and flash duration.
  • Play animations upon receiving or removing Buffs, Debuffs, and States.
  • States can have repeating animations.
  • States can change the tone of a sprite.
  • States can freeze a sprite in place.
  • Hovering effects that can be visibly applied to trait objects.

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.

---

State Motion Index and State Overlay Index

VisualStateEffectsRepeatCycle.gif

The original RPG Maker MZ functions have been overwritten because they only display the motions and overlays of the highest priority state even if it does not have any motions while lower priority states with motions and overlays will be hidden.

The changed code will now take the highest priority state motion index (or a custom one defined by a notetag) and the highest priority state overlay index to show those instead.

---

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

The following notetags are made for states.

---

<Hide State Popup>

- Used for: State Notetags
- Don't display any of the popups for this state.

---

VisualStateEffectsPopups.gif

<State Popup>
 text color: c
 flash color: r, g, b, a
 flash duration: d
</State Popup>

- Used for: State Notetags
- Changes the settings of the state popup from the defaults declared by the
  Plugin Parameters. Each of the settings are optional. If the lines do not
  appear in the notetag, then the default values from the Plugin Parameters
  will be used instead.
- Replace 'c' #rrggbb for custom colors or insert a regular number for text
  colors from the Window Skin.
- Replace 'r', 'g', 'b', 'a' with number values ranging from 0 to 255 for
  'red', 'green', 'blue', and 'alpha' to determine the flash color.
- Replace 'd' with a number representing the amount of frames you want the
  flash duration to last for.

Examples:

<State Popup>
 text color: 3
</State Popup>

<State Popup>
 text color: #abcdef
 flash color: 255, 255, 0, 160
</State Popup>

<State Popup>
 flash color: 0, 255, 255, 160
 flash duration: 90
</State Popup>

<State Popup>
 flash duration: 777
</State Popup>

---

<Add Animation: x>

- Used for: State Notetags
- Determines the battle animation to play when the state is applied.
- Replace 'x' with a number representing the ID of the animation you wish
  to play when the state is added.
- This does not work for states without icons nor the death state.

---

<Erase Animation: x>

- Used for: State Notetags
- Determines the battle animation to play when the state is removed.
- Replace 'x' with a number representing the ID of the animation you wish
  to play when the state is removed.
- This does not work for states without icons nor the death state.

---

VisualStateEffectsRepeatCycle.gif

<Repeat Animation: x>

- Used for: State Notetags
- Determines the battle animation to play in intervals when the battler is
  affected by it.
- Replace 'x' with a number representing the ID of the animation you wish
  to play on repeat while the battler is affected by the state.
- The battler will cycle through the various repeating state animations
  available through states.
- WARNING: Abusing Repeat Animations can jeopardize game performance.

---

<Repeat Animation Cycle: x>

- Used for: State Notetags
- Determines the cycle/duration of this specific state's repeating animation
  if you do not wish to use the plugin parameter's default setting.
- Replace 'x' with the number of frames you wish to play this animation for
  before moving onto the next animation.
- WARNING: Lower numbers can jeopardize game performance.

---

<State Motion: Walk>
<State Motion: Wait>
<State Motion: Chant>
<State Motion: Guard>
<State Motion: Damage>
<State Motion: Evade>
<State Motion: Thrust>
<State Motion: Swing>
<State Motion: Missile>
<State Motion: Skill>
<State Motion: Spell>
<State Motion: Item>
<State Motion: Escape>
<State Motion: Victory>
<State Motion: Dying>
<State Motion: Abnormal>
<State Motion: Sleep>
<State Motion: Dead>

- Used for: State Notetags
- Lets you determine what kind of state motion to play when the battler is
  affected by the state.
- The battler will only play the highest priority state motion.

---

VisualStateEffectsToneFrozen.gif

<State Motion Lock>

- Used for: State Notetags
- If an actor or animated sideview enemy is affected by a state that has
  this notetag, their animation will be locked in place while this state
  is in effect.

---

VisualStateEffectsToneFrozen.gif

<State Tone: red, green, blue, gray>

- Used for: State Notetags
- Tints the battler with a tone determined by the state.
- Replace 'red', 'green', 'blue' with a value between -255 and 255.
- Replace 'gray' with a value between 0 and 255.
- If a battler has multiple states with tones, then the state with the
  highest priority value is applied to the battler.

---

Hover Notetags

---

VisualStateEffectsHover.gif

<Visual Hover Effect>
 Base: x
 Speed: y
 Rate: z
 Death: case
</Visual Hover Effect>

- Used for: Actor, Class, Skill, Item, Weapon, Armor, Enemy, State Notetags
- Creates a hover effect when tied to a trait object.
- The 'base' value determines the minimum height above the ground for the
  hover effect. Replace 'x' with a number representing the pixel height.
- The 'speed' value determines the flat adjustment towards the wobbling
  change. Replace 'y' with a number representing the speed. Lower values
  move faster while higher values move slower.
- The 'rate' determines the fluctuation rate when the hover effect bobbles
  up and down. Replace 'z' with a number representing the fluctuation rate.
- The 'death' scenario lets you decide if you want the hovering battler to
  remain hovering if they're dead or fall down to the floor. Replace 'case'
  with 'Hover' or 'Floor'.

Example:

<Visual Hover Effect>
 Base: 100
 Speed: 20
 Rate: 5.0
 Death: floor
</Visual Hover Effect>

---

Plugin Parameters

General Settings

VisualStateEffectsParams1.png

General settings for Visual State Effects.

---

Actors

 Show State Overlay?:
 - Show state overlays over an actor's head?
 Show State Icons?:
 - Show state icons over an actor's head?

---

Enemies

 Show State Overlay?:
 - Show state overlays over an enemy's head?
 Show State Icons?:
 - Show state icons over an enemy's head?

---

Buff/Debuff Settings Settings

VisualStateEffectsParams2.png

Buff/Debuff settings for Visual State Effects.

---

VisualStateEffectsPopups.gif

Popups

 Show Popups?:
 - Show Buff/Debuff Popups when applied?
   Buff Format:
   - How do you want the buff text to appear?
   - %1 - Parameter Name
     Text Color:
     - Use #rrggbb for custom colors or regular numbers for text colors
       from the Window Skin.
     Flash Color:
     - Adjust the popup's flash color.
     - Format: [red, green, blue, alpha]
     Flash Duration:
     - What is the frame duration of the flash effect?
   Debuff Format:
   - How do you want the debuff text to appear?
   - %1 - Parameter Name
     Text Color:
     - Use #rrggbb for custom colors or regular numbers for text colors
       from the Window Skin.
     Flash Color:
     - Adjust the popup's flash color.
     - Format: [red, green, blue, alpha]
     Flash Duration:
     - What is the frame duration of the flash effect?

---

Animations

 Show Animations?:
 - Show Buff/Debuff Animations when applied?
   Mirror Animations?:
   - Mirror animations for buffs/debuffs?
   Mute Animations?:
   - Mute animations for buffs/debuffs?

---

Buff Animations

 MaxHP Buff:
 MaxMP Buff:
 ATK Buff:
 DEF Buff:
 MAT Buff:
 MDF Buff:
 AGI Buff:
 LUK Buff:
 - Animation played when applying specific Buffs.

Debuff Animations

 MaxHP Debuff:
 MaxMP Debuff:
 ATK Debuff:
 DEF Debuff:
 MAT Debuff:
 MDF Debuff:
 AGI Debuff:
 LUK Debuff:
 - Animation played when applying specific Debuff.

---

State Settings

VisualStateEffectsParams3.png

Default State settings for Visual State Effects.

---

VisualStateEffectsPopups.gif

Popups

 Show Popups?:
 - Show States Popups when applied and removed?
   Add State Format:
   - How do you want added states to appear?
   - %1 - State Name
   Erase State Format:
   - How do you want erased states to appear?
   - %1 - State Name
   Default Text Color:
   - Use #rrggbb for custom colors or regular numbers for text colors from
     the Window Skin.
     Match Turn Count?:
     - Match turn count color by default?
   Flash Color:
   - Adjust the popup's default flash color.
   - Format: [red, green, blue, alpha]
     Flash Duration:
     - What is the frame duration of the default flash effect?

---

State Animations

 Add/Erase Animations
   Mirror Animations?:
   - Mirror animations for states?
   Mute Animations?:
   - Mute animations for states?

VisualStateEffectsRepeatCycle.gif

 Repeating Animations
   Cycle Time:
   - The amount of frames to wait before each animation cycle.
   - WARNING: Lower numbers can jeopardize game performance.
   Mirror Animations?:
   - Mirror repeating animations for states by default?
   Mute Animations?:
   - Mute repeating animations for states by default?

---


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: September 13, 2020

  • Compatibility Update
    • Added compatibility with Battle Core's newest update for the new distortion effects.

Version 1.01: September 6, 2020

  • Compatibility Update
    • Added compatibility with Battle Core's newest update for the <Battle UI Offset: +x, +y> notetags. Update made by Yanfly.

Version 1.00: September 2, 2020

  • Finished Plugin!

Help File