Visual Battle Environment 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.



VisualBattleEnv Ani1.gif

VisualBattleEnv Ani2.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

VisualBattleEnv Ani1.gif

VisualBattleEnv Ani2.gif

Add extra layers of images to your battle system for background purposes or foreground purposes. These images can be battlebacks, pictures, parallaxes, whatever you need them to be. Add extra settings to them, such as scrolling, blend modes, different opacity levels, hues, and more.

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

  • Create battle environment images located behind battlers to function as a part of the background.
  • Create battle environment images located in front of battlers to function as a part of the foreground.
  • Apply custom settings to them, such as changing their blend modes, their scrolling speeds, and opacity levels.
  • Customize their hue and if they have a hue shift at all.
  • Apply color tones if needed to give more color control.
  • Alter their opacity levels midway during battle.
  • An unlimited amounts of back environments and front environments to add to the battle scene.
  • Environment images are layered based on their ID's. Lower ID's appear below while higher ID's appear above.

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 2

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


Plugin Commands

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.

---

Back Environment-Type Plugin Commands

VisualBattleEnv Ani2.gif

---

VisualBattleEnv Command1.png

Back Environment: Add/Change
- Adds/changes the target back environment.

  Settings:

    ID:
    - Select the target environment ID to add/change.
    - Lower ID's appear below. Higher ID's appear above.

    Folder and Filename:
    - What is the folder and filename?

  Extra Settings:
  - Extra settings that can be altered for the environment object.
  - For details, refer to section below.

    Duration:
    - How many frames would it take to alter settings?

---

VisualBattleEnv Command2.png

Back Environment: Fade Opacity
- Fades the target back environment(s) opacity to a different value.

  ID(s):
  - Target which back environment(s)?
  - Cannot target the default battlebacks.

  Target Opacity:
  - What opacity level to this value (0-255).
  - You may use JavaScript code to determine the value.

  Duration:
  - How many frames should this change take?
  - You may use JavaScript code to determine the value.

---

VisualBattleEnv Command3.png

Back Environment: Remove
- Removes target back environment(s).

  ID(s):
  - Remove which back environment(s)?
  - Cannot remove the default battlebacks.

---

Front Environment-Type Plugin Commands

VisualBattleEnv Ani1.gif

---

VisualBattleEnv Command4.png

Front Environment: Add/Change
- Adds/changes the target front environment.

  Settings:

    ID:
    - Select the target environment ID to add/change.
    - Lower ID's appear below. Higher ID's appear above.

    Folder and Filename:
    - What is the folder and filename?

  Extra Settings:
  - Extra settings that can be altered for the environment object.
  - For details, refer to section below.

    Duration:
    - How many frames would it take to alter settings?

---

VisualBattleEnv Command5.png

Front Environment: Fade Opacity
- Fades the target front environment(s) opacity to a different value.

  ID(s):
  - Target which front environment(s)?
  - Cannot target the default battlebacks.

  Target Opacity:
  - What opacity level to this value (0-255).
  - You may use JavaScript code to determine the value.

  Duration:
  - How many frames should this change take?
  - You may use JavaScript code to determine the value.

---

VisualBattleEnv Command6.png

Front Environment: Remove
- Removes target front environment(s).

  ID(s):
  - Remove which front environment(s)?
  - Cannot remove the default battlebacks.

---

Extra-Settings

---

VisualBattleEnv Ani1.gif

VisualBattleEnv Ani2.gif

VisualBattleEnv CommandExtra.png

Extra Settings
- These settings are used for both the "Back Environment: Add/Change" and
  "Front Environment: Add/Change" Plugin Commands.

  Appearance:

    Scale Style:
    - The scaling style used for this environment image.
      - Battle Core Setting
      - MZ (MZ's default style)
      - 1:1 (No Scaling)
      - Scale To Fit (Scale to screen size)
      - Scale Down (Scale Downward if Larger than Screen)
      - Scale Up (Scale Upward if Smaller than Screen)

    Opacity:
    - What is the opacity level for this image?
    - You may use JavaScript code.

    Blend Mode:
    - What kind of blend mode do you wish to apply to the image?
    - You may use JavaScript code.
      - Normal
      - Additive
      - Multiply
      - Screen

    Hue:
    - Do you wish to adjust this image's hue?
    - You may use JavaScript code.

    Hue Shift:
    - How much do you want the hue to shift each frame?
    - You may use JavaScript code.

    Color Tone:
    - What tone do you want for the graphic?
    - Format: [Red, Green, Blue, Gray]

  Scrolling:

    Horizontal Scroll:
    - What is the horizontal scroll speed?
    - Use a negative value to invert the direction.

    Vertical Scroll:
    - What is the vertical scroll speed?
    - Use a negative value to invert the direction.

---


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.05: August 6, 2021

  • Bug Fixes!
    • Environments no longer visibly vanish when changing to the Options or Party management scenes. Fix made by Irina.


Version 1.04: July 16, 2021

  • Bug Fixes!
    • Games with UI dimensions that are different from screen dimensions should no longer be affected by the distance difference. Fix made by Irina.


Version 1.03: May 28, 2021

  • Optimization Update!
    • Plugin should run more optimized.


Version 1.02: April 30, 2021

  • Bug Fixes!
    • Added a fail safe for changing color tones in case the value fails to be an array (it will default to zero tone). Fix made by Arisu.


Version 1.01: April 9, 2021

  • Bug Fixes!
    • Crashes should no longer occur when performing a troop transition from the map. Fix made by Olivia.


Version 1.00 Official Release Date: May 10, 2021

  • Finished Plugin!

End of File