==============================================================================
TERMS OF USE
==============================================================================
Credit goes to: LTN Games
Exclusive to rpgmakermv.co, please don't share anywhere else unless given
strict permission by the author of the plugin.
The plugin and all graphics included may be used in commerical and
non-commerical products. Credit must be given!
Please report all bugs to
http://www.rpgmakermv.co/threads/window-pop.1432/
==============================================================================
INSTRUCTIONS
==============================================================================
Change the setting in the plugin manager to adjust how the Window Pop appears
on map.
If Auto pop is enabled in the plugin manager, a window will pop up For each
item or gold gained or lost.
==============================================================================
USING PLUGIN COMMANDS, SCRIPT CALLS, & Notetags
==============================================================================
----------===========----------------------
COLLECTION MODE
----------===========----------------------
You can now use collection mode for window pop. The window will still popup
for every item/gold gained but with a few extra plugin commands you can setup
some in game variables and keep track of how many of each item has been gained.
The window will now reflect this as well, so instead of displaying
"Obtained x1 Potion"
it will now display a max value and how much of each item is gained like so
"Obtained 2/10 Potion(s)"
-----------------------------------
PLUGIN COMMANDS FOR COLLECTION MODE
------------------------------------
WPOPCMODE TRUE/FALSE
This command turns collection mode on / true and off / false
WPOPCSET ITEM VARIABLE MAXVALUE
This is where you setup all your items and match them with a variable & max value.
ITEM = Item ID, the number in the database.. eg: 1 = Potion in database
VARIABLE = The in game variable you want to set the item to.
Max Value = The max value for the item.. 1/10 <-- 10 is the max value
WPOPCRESET ITEM
This will remove the item from the collection array and the next time you
collect an item it will no longer display in collection mode.
ITEM = The item ID in the database
----------------------------
EXAMPLES FOR COLLECTION MODE
-------------------------------
WPOPCMODE TRUE -- Turn on collection mode
WPOPCSET 1 1 25 --- Set Item 1, to Variable 1 in game & the max amount to
collect is 25.
WPOPCSET 5 2 15 --- Set item 5, to Variable 2, & the max amount is 15
Now whenever I gain these items above, it will display the amount I have already
collected and the amount I still need to collect.
I collected all of the items above and now I want to remove them and reset the
variable so I will do something like this.
WPOPCRESET 1
WPOPCRESET 5
The above WPOPCRESET commands will remove the items from the array and reset
the in game variable back to 0. In other words the items will now act as they
should before collection mode was turned on.
----------===========----------------------
MAP DISPLAY NAME CUSTOMIZATIONS
----------===========----------------------
If enabled in the plugin manager, window pop will take control of the
Map Display Name, so you can add message codes to make the name pop out!
You can now use message codes for your maps display name!
All you have to do is go into the maps setting from the editor
and add your own message code to the Map Display Name text field.
You can use the icon message code if you want to include icons.
----------===========----------------------
THE ITEM NOTETAG:
----------===========----------------------
You can now use a notetag in the items section of the database to chnage the
colors of the items, when they auto pop up. This can be good for Item Rarity.
Notetag to use: <WPOP_Color: x> (x = the # of the color code you want to use)
-------------------------------------------
EXAMPLE NOTETAGS
--------------------------------------------
<WPOP_Color: 1> // Changes to white
<WPOP_Color: 2> // Changed to color 2 in the color pallete of window.png
To set a custom window pop, you can use either a plugin command or Script
call.
----------===========----------------------
THE PLUGIN COMMAND FOR CUSTOM POPUP:
----------===========----------------------
Plugin Command: WPOP Duration Align Icon String
In the Icon slot put the icon index # - No icon = 0
In the Duration slot put a number to set how long before window fades out.
In the Align slot, put left, right or center, to align your string in the window.
In the string slot put the string you want to pop up.
-------------------------------------------
EXAMPLE COMMANDS
---------------------------------------------
Message codes work with window pop, I would recommend only sticking with The
codes that change color, show variables, actor name, etc. Some codes like text
size, and draw icon, may break the alignment of the message.
Example: WPOP 120 Left 5 Welome To Oakville
WPOP 120 Center 5 \C[3] Quest Log Updated
WPOP 120 Center 2 \C[2] \N[1] \C[3]Is Poisoned!
----------===========----------------------
THE SCRIPT CALL FOR CUSTOM POP UP:
----------===========----------------------
this.setWindowPop(Icon, 'String', Duration, 'Align')
Icon = The icon index number of the icon you want to display.
String = The string you want displayed in the pop up window. Remember quotes''
Duration = How long should the window stay before dissappearing.Recommended 150
Align = A string 'left', 'right', or 'center' that aligns the string in the window.
EG: this.setWindowPop(5, 'Quest Log Updated', 150, 'left')
This will activate the window to show Icon 5, with the string Quest Log Updated!
for 150 as the duration.
----------===========----------------------
NOTES TO REMEBER:
----------===========----------------------
In all events be sure to add a wait command between each gain item, gold, etc
to add space in between the pop ups when gaining items. This ensures there is
enough space between each popup for it to have smooth transitions.
