Iavra Event Popup

じ☆ve冰风

Description


        Allows to display popups messages above events, which can be used for speech bubbles or on chests.


Author


        Iavra


Parameters


@param Popup Width
@desc Default width for the popup window. Overflowing text will be cut away. Default: 200
@default 200

@param Offset X
@desc By default, popups are centered on event.screenX(). This is the X offset. Default: 0
@default 0

@param Offset Y
@desc By default, popups are centered on event.screenY(). This is the Y offset. Default: 0
@default 0

@param Display Duration
@desc How long the popup will be displayed after fading in and before fading out. Default: 200
@default 200

@param Fade In Duration
@desc How long it takes for the popup to fade in. Default: 10
@default 10

@param Fade Out Duration
@desc How long it takes for the popup to fade out. Default: 60
@default 60

@param Font Name
@desc Name of the font to be used. If left empty, default is used instead. Default: (empty)
@default

@param Font Size
@desc Font size to be used. Default: 12
@default 12

@param Line Height
@desc Line height to be used. Should be a bit higher than font size. Default: 18
@default 18

@param Retain On Scene
@desc When one of these scenes becomes active, popups will be hidden, instead of destroyed. Default: Scene_Menu, Scene_Battle
@default Scene_Menu, Scene_Battle




How to Use


        To create a popup, call the following function in a "Script" event command:


IAVRA.EVENTPOPUP.popup(eventId, text, options);


        Where "eventId" is the id of the event you want to show the popup on, "text" is the message you want to show and "options" is an optional object, that can be used to override the default values set via plugin parameters.


        The following list shows all possible options:


width      
The width of the popup window. By default, popups will be horizontally centered on the event.

x         
An offset on the x axis. By default, popups are centered on the event.

y         
An offset on the y axis. By default, popups are centered on the event.

duration   
How long the popup should stay visible after it has faded in and before it starts to fade out.

fadeIn     
How long it takes for the popup to fade in.

fadeOut   
How long it takes for the popup to fade out.

fontName   
The font to be used.

fontSize   
The font size to be used.

lineHeight
Height of a single text line. This should be slightly higher than fontSize.


        The "text" parameter can contain any special characters. Beware that icons have a fixed size and might look strange depending on the fontSize. Also remember that you need to double backslashes on certain escape codes. To display the value of variable 10, you would use \\V[10], for example.


        If you want to remove popups, before they have faded out, you can do so by calling this function:


IAVRA.EVENTPOPUP.clear(eventId);


        This will remove all popups shown for a specific event or all popups if the "eventId" parameter is left out.


        If you don't want to use script calls, you can use the following plugin commands, instead, but note that it's not possible to specify options for the "popup" command:


EventPopup popup eventId textEventPopup clean eventId


        Inside plugin commands, you can use the keyword "this" (without quotes) to show or clear popups on the current event.


Terms of Use


        Free to use for both commercial and non-commercial games. Please give credit.


Download


http://pastebin.com/86ebsSjx


FAQ


        Q: I don't like the black background, can i change it?


        A: Currently, there a no parameters or options to change the background, but you can override "IAVRA.EVENTPOPUP._callbacks.drawBackground" to provide your own function. The same goes for "fadeIn" and "fadeOut", which are both callbacks controlling how a popup fades in and out, respectively.


本贴来自国际rpgmaker官方论坛作者:Iavra处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/iavra-event-popup.48128/