Animated Map Destination 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.



AniDest Animation.gif

AniDest Circle.gif

AniDest Image.gif

AniDest Square.gif


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

When the player clicks on the map, the player sets a destination for the player character to move to. This destination is, by default, marked with a white square sprite that flashes over and over. This aesthetic does not necessarily fit every type of game project so this plugin will allow you to customize it.

You can change the way the square sprite looks, change it into a circle, use an image file, or even use an animation file. There are various properties for each of these settings, too.

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

  • Change the animated map destination sprite into a graphic of your choice ranging from squares, circles, images, and animations.
  • Change the colors used for square and circle sprites.
  • Select a custom image used for the image sprites.
  • Or use an animation from the database of your choice.
  • Change the scale and rotation speed of the map destination sprite.
  • Be able to control these settings mid-game.

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.


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.

---

System Plugin Commands

---

AniDest Command1.png

System: Alter Destination Type
- Alter the destination animation type.

  Sprite Type:
  - Change the sprite type to this.
  - None - No effect
  - Animation - Uses an animation from the database
  - Circle - Drawn circle effect
  - Image - Uses a custom image from img/system/
  - Square - Default box-like effect

---

AniDest Animation.gif

AniDest Command2.png

System: Change Animation Settings
- Change settings used for a 'Animation' Sprite Type.

  Animation ID:
  - Select an animation to play.

  Mirror Animation?:
  - Mirror the animation played?

  Mute SFX?:
  - Mute any sound effects played by the animation?

---

AniDest Circle.gif

AniDest Command3.png

System: Change Circle Settings
- Change settings used for a 'Circle' Sprite Type.

  Hex Color:
  - Use #rrggbb for a hex color.

  Blend Mode:
  - The blend mode used for the sprite.

  Opacity Multiplier:
  - Alter the opacity of the sprite as it animates.

  Scale Multiplier:
  - Increase the size of this sprite by a scale.
  - Use a value of 1.0 for 100% scale.

---

AniDest Image.gif

AniDest Command4.png

System: Change Image Settings
- Change settings used for a 'Image' Sprite Type.

  Filename:
  - Select an image from img/system/ to use as the sprite's bitmap.

  Blend Mode:
  - The blend mode used for the sprite.

  Opacity Multiplier:
  - Alter the opacity of the sprite as it animates.

  Rotate Speed:
  - Rotation speed for the sprite.
  - Use 0 for no rotation.

  Scale Multiplier:
  - Increase the size of this sprite by a scale.
  - Use a value of 1.0 for 100% scale.

---

AniDest Square.gif

AniDest Command5.png

System: Change Square Settings
- Change settings used for a 'Square' Sprite Type.

  Hex Color:
  - Use #rrggbb for a hex color.

  Blend Mode:
  - The blend mode used for the sprite.

  Opacity Multiplier:
  - Alter the opacity of the sprite as it animates.

  Rotate Speed:
  - Rotation speed for the sprite.
  - Use 0 for no rotation.

  Scale Multiplier:
  - Increase the size of this sprite by a scale.
  - Use a value of 1.0 for 100% scale.

---

Plugin Parameters

General Settings

AniDest Params1.png

These plugin parameters allow you to adjust how the animated map destination sprite appears in-game.

---

Sprite Type

 None - No effect
 Square - Default box-like effect
 Circle - Drawn circle effect
 Image - Uses a custom image from img/system/
 Animation - Uses an animation from the database
 - This is the type of animated map destination used in-game.

---

Animation Settings

AniDest Animation.gif

AniDest Params2.png

- Settings used for a 'Animation' Sprite Type.

 Animation ID:
 - Select an animation to play.
 Mirror Animation?:
 - Mirror the animation played?
 Mute SFX?:
 - Mute any sound effects played by the animation?

---

Circle Settings

AniDest Circle.gif

AniDest Params3.png

- Settings used for a 'Circle' Sprite Type.

 Hex Color:
 - Use #rrggbb for a hex color.
 Blend Mode:
 - The blend mode used for the sprite.
 Opacity Multiplier:
 - Alter the opacity of the sprite as it animates.
 Scale Multiplier:
 - Increase the size of this sprite by a scale.
 - Use a value of 1.0 for 100% scale.

---

Image Settings

AniDest Image.gif

AniDest Params4.png

- Settings used for a 'Image' Sprite Type.

 Filename:
 - Select an image from img/system/ to use as the sprite's bitmap.
 Blend Mode:
 - The blend mode used for the sprite.
 Opacity Multiplier:
 - Alter the opacity of the sprite as it animates.
 Rotate Speed:
 - Rotation speed for the sprite.
 - Use 0 for no rotation.
 Scale Multiplier:
 - Increase the size of this sprite by a scale.
 - Use a value of 1.0 for 100% scale.

---

Square Settings

AniDest Square.gif

AniDest Params5.png

- Settings used for a 'Square' Sprite Type.

 Hex Color:
 - Use #rrggbb for a hex color.
 Blend Mode:
 - The blend mode used for the sprite.
 Opacity Multiplier:
 - Alter the opacity of the sprite as it animates.
 Rotate Speed:
 - Rotation speed for the sprite.
 - Use 0 for no rotation.
 Scale Multiplier:
 - Increase the size of this sprite by a scale.
 - Use a value of 1.0 for 100% scale.

---


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: October 11, 2020

  • Bug Fixes!
    • Image style will no longer be removed from cache upon changing scenes. Fix made by Yanfly.


Version 1.00: October 2, 2020

  • Finished Plugin!

End of File