An open library of RPG Maker MZ plugins, powered by the community.

PGMZ - The Community-Driven Plugin Library for RPG Maker MZ

MZ plugins

TF Balloon Ex - TF_BalloonEx.js

Plugin desc : [Display balloon icon] extension

License : MIT License

Author : Tobishima-Factory

Website : https://github.com/tonbijp/RPGMakerMZ/blob/master/TF_BalloonEx.js

Desc page : http://tonbi.jp/

Download Page : https://raw.githubusercontent.com/tonbijp/RPGMakerMZ/master/TF_BalloonEx.js

File name : TF_BalloonEx.js

Help of plugin :

* @target MZ
 * @plugindesc [Display balloon icon] extension
 * @author Tobishima-Factory
 *
 * @param balloonParamList
 * @desc The presets of balloon animation.
 * @type struct<BalloonParam>[]
 * @default ["{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}","{¥"dx¥":¥"0¥",¥"dy¥":¥"0¥",¥"startPatterns¥":¥"2¥",¥"loopPatterns¥":¥"6¥",¥"endPatterns¥":¥"0¥",¥"loops¥":¥"1¥",¥"speed¥":¥"8¥",¥"waitTime¥":¥"12¥"}"]
 * 
 * @param baseDy
 * @desc The base difference y coordinate for a balloon.
 * @type number
 * @default 0
 * 
 *
 * @help
 * ● Basic usage
 * 		Write the settings to each [Balloon ID] of the plug-in parameter "preset".
 *  ・You can edit the settings for dx, dy, loops, speed, waitTime.
 *  ・Summation of startPatterns, loopPatterns and endPatterns must under or equal 8.
 *  ・For details on the values to be set in parameter "preset", refer to the help text for entering each value.
 *  Now, You execute [Display balloon icon] event command, The animation is played back with the settings according to [Balloon ID].
 *  When combined with Triacontan's BalloonPlaySe.js, the sound can be played automatically, which is convenient.
 *
 * 
 * ● Plug-in command
 *------------------------------
 * TF_START_BALLOON [Event ID] [Balloon ID] [Wait for finish] [dx] [dy]
 *  Start a balloon animation.All parameters can omitted.
 *  [Event ID] 0:This event  -1:Player  -2〜-4:Member 1〜:Event ID (Default:0)
 *   You can use this, player,follower0,follower1,follower2 instead of the number.
 *   And [name] of the event. ( But can't use the name about like identifier of 'this', includes space, and number )
 *  [Balloon ID] 1 to 15 counting from the top of the image( img/system/balloon.png ). (Default:11)
 *   And [name] of the balloon( set at plugin property ).
 *  [Wait for finish] true:Wait for finish  false:Don't stop (Default:false)
 *  [dx] Difference x coordinate. (Default:dx at plug-in parameter)
 *  [dy] Difference y coordinate. (Default:dy at plug-in parameter)
 * 
 *  EX: TF_START_BALLOON -1 5 false 0 20
 *------------------------------
 * TF_SET_BALLOON [Event ID] [Balloon ID] [Pattern Number] [Wait time] [Wait for finish] [dx] [dy]
 *  [Pattern Number] 1 to 8 patterns from the left of the balloon image. (Default:8)
 *  [Wait time] The number of frames to display the balloon( 0:Loop until TF STOP BALLOON is executed ). (Default:64)
 * 
 *  EX: TF_SET_BALLOON 0 9 2 60 true 10 -50
 *------------------------------
 * TF_LOCATE_BALLOON [Event ID] [dx] [dy]
 *  Locate ballon position. Apply to displayed balloon.
 * 
 *  EX: TF_LOCATE_BALLOON 15 0 10
 *------------------------------
 * TF_STOP_BALLOON [Event ID] [Show end animation]
 *  Stop balloon animation.
 *  When executing TF_START_BALLOON specifying the preset [Loop] to 0.
 *  [Show end animation] true:Show end animation  false:Immediately (Default:false)
 * 
 *  EX: TF_STOP_BALLOON 0 true
 *------------------------------
 * All of the numbers of [Event ID][Balloon ID][dx][dy] can set format V[n]. That means variables.
 * 
 *  EX : TF_LOCATE_BALLOON 0 V[1] V[2]
 *------------------------------
 * 
 * 
 * ● Scripts for [route settings]
 *------------------------------
 * this.TF_startBalloon( [Balloon ID], [Wait for finish], [dx], [dy] );
 *  The function of  TF_START_BALLOON.
 *  [Wait for finish], [dx], [dy] can omitted.Default values are confirmed on TF_START_BALLOON.
 *  this.balloon is same syntax of this.TF_startBalloon.
 *  If you use EventEffects.js, Place EventEffects.js over this plug-in.
 *------------------------------
 * this.TF_setBalloon( [Balloon ID], [Pattern Number], [Wait time], [Wait for finish], [dx], [dy] );
 *  The function of TF_SET_BALLOON.
 *------------------------------
 * this.TF_locateBalloon( [dx], [dy] );
 *  The function of  TF_LOCATE_BALLOON.
 *------------------------------
 * this.TF_stopBalloon( [Show end animation] );
 *  The function of  TF_STOP_BALLOON .
 *------------------------------
 *
 * Released under the MIT License.

スポンサードリンク

-MZ plugins

Copyright© PGMZ - The Community-Driven Plugin Library for RPG Maker MZ , 2026 All Rights Reserved.