Icon Balloons VisuStella MZ

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.	Click here to learn how to update plugins.	Click here for how to troubleshoot plugins if you get an error.

Masterarbeit Writer

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 RPG Maker MZ provides us with 15 Balloon Animations to use to allow our events to show emotions with. Sometimes, this just isn't enough. However, this plugin allows you to use icons from your IconSet to extend the number of balloon types you can use as well as animate them frame by frame. Features include all (but not limited to) the following: Select any icon found in your game project's iconset to display as a balloon animation. Use your own custom balloon skin or use an automatically modified one with the default RTP set. Displayed icons can be individual icons or animated icons. Animated icons can be displayed through a range of icons or through specific sets of icons. Play these balloon animations on events, the player character, or the player's followers. Gain back access to RPG Maker MV's script calls that allowed custom Event Move Routes to use the "this._balloonId = x" script call once again. 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. Major Changes This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them. --- Automatically Modified Icon Balloon Spritesheet If you choose to not use a custom balloon skin found in the /img/system/ folder, then the plugin will create its own balloon skin (without any emotion markers) through usage of the currently existing balloon image spritesheet. This best works with the RTP balloon spritesheet provided by RPG Maker MZ. --- Event Move Route Script Call Previously in RPG Maker MV, using "this._balloonId = x" in the script call of an event's custom Move Route would allow it to display balloons at specific points in their move route. This was no longer the case in RPG Maker MZ due to how the balloon activation calls were changed. This plugin brings back this capability to allow for balloon animation requests to work again the way it used to. --- 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. --- Balloon Plugin Commands --- Balloon: Event with Single Icon Balloon - Plays a single icon balloon animation on target event. - Can only be used on the map scene. Event ID: - Insert the ID of the target event. - Use 0 for the current event. Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Balloon: Event with Icon Range Balloon - Plays an icon range balloon animation on target event. - Can only be used on the map scene. Event ID: - Insert the ID of the target event. - Use 0 for the current event. Starting Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Ending Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Balloon: Event with Specific Icons Balloon - Plays specific icons balloon animation on target event. - Can only be used on the map scene. Event ID: - Insert the ID of the target event. - Use 0 for the current event. Icons: - Insert the ID(s) of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Balloon: Follower with Single Icon Balloon - Plays a single icon balloon animation on target follower. - Can only be used on the map scene. Follower ID: - Select which follower ID to show a balloon on. - Follower ID's start at 1. Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Balloon: Follower with Icon Range Balloon - Plays an icon range balloon animation on target follower. - Can only be used on the map scene. Follower ID: - Select which follower ID to show a balloon on. - Follower ID's start at 1. Starting Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Ending Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Balloon: Follower with Specific Icons Balloon - Plays specific icons balloon animation on target follower. - Can only be used on the map scene. Follower ID: - Select which follower ID to show a balloon on. - Follower ID's start at 1. Icons: - Insert the ID(s) of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Balloon: Player with Single Icon Balloon - Plays a single icon balloon animation on the player. - Can only be used on the map scene. Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Balloon: Player with Icon Range Balloon - Plays an icon range balloon animation on the player. - Can only be used on the map scene. Starting Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Ending Icon Index: - Insert the ID of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Balloon: Player with Specific Icons Balloon - Plays specific icons balloon animation on the player. - Can only be used on the map scene. Icons: - Insert the ID(s) of the icon to show. - Tip: Right click > Insert Icon Index Wait for Completion: - Wait for balloon animation completion before continuing? --- Script Calls The following are Script Calls that can be used with this plugin. These are made for JavaScript proficient users. We are not responsible if you use them incorrectly or for unintended usage. --- Move Route-Related Script Calls --- this._balloonId = x - Use in Custom Move Route script calls. - Allows the target to call forth a balloon animation using the specific emotion indexed by 'x'. - Replace 'x' with a number representing the following emotion: - 1 : Exclamation - 2 : Question - 3 : Music Note - 4 : Heart - 5 : Anger - 6 : Sweat - 7 : Frustration - 8 : Silence - 9 : Light Bulb - 10 : Zzz - 11 : User-defined 1 - 12 : User-defined 2 - 13 : User-defined 3 - 14 : User-defined 4 - 15 : User-defined 5 - Examples: - this._balloonId = 2 - this._balloonId = 4 - this._balloonId = 6 - --- this._balloonId = [x, x, x] - Use in Custom Move Route script calls. - Allows the target to call forth a ballon animation using the specific icons 'x' in that sequence. - Replace 'x' with the icon index of the icons you wish to display and in the sequence that they are displayed in. - Examples: - this._balloonId = [87] - this._balloonId = [87, 88, 89] - this._balloonId = [162, 163, 164, 165, 160, 161] --- Plugin Parameters General Settings These are the general settings used for this plugin. --- Custom Balloon Skin Filename: - Filename of the custom balloon skin used. - Found in /img/system/ --- Icon Offset Offset X: - Offsets the icon's x position. - Negative: left. Positive: right. Offset Y: - Offsets the icon's y position. - Negative: up. Positive: down. --- Shrink Start Shrink Single Icon?: - Starts icons small or at full size when they appear. - Used for single icon balloons. Shrink Multi-Icon?: - Starts icons small or at full size when they appear. - Used for icon balloons with multiple icons. --- 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 Yanfly Arisu Olivia Irina Changelog Version 1.00 Official Release Date: July 28, 2023 Finished Plugin! See Also Inspiration Behind Enchanted Explorers Volume 2 End of Helpfile