Difference between revisions of "State Tooltip Display (Olivia)"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Created blank page)
 
 
Line 1: Line 1:
 +
{{MvPlugin
 +
|preview = <html><img src='https://img.itch.zone/aW1hZ2UvMzY5NTEyLzE4NTA2NTYuZ2lm/original/FoNfJk.gif'></html>
 +
|link1 = <html><iframe src="https://itch.io/embed/302267" height="167" width="552" frameborder="0"></iframe></html>
  
 +
}}
 +
 +
{{Fallen Angel Olivia}}
 +
 +
== Introduction ==
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NTIuZ2lm/original/7fuDdB.gif'></html>
 +
 +
This is a RPG Maker MV plugin that adds a tooltip window in battle (and other
 +
scenes) dedicated to showing information regarding states. If the player
 +
hovers the mouse over the state icons, the window will appear and display
 +
descriptions about each of the states affecting the battler.
 +
 +
{{Notetags MV}}
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NTgucG5n/original/jgnRd5.png'></html>
 +
 +
<pre>
 +
<Help Description>
 +
insert a help description here
 +
insert another line if you want to
 +
</Help Description>
 +
- Place this in the states that you want to have appear in the tooltip
 +
window. Text codes can be used for the description. If no description is
 +
used, then the state will not appear in the tooltip window.
 +
</pre>
 +
 +
{{Plugin Parameters MV}}
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NjEucG5n/original/RXg%2Fe3.png'></html>
 +
 +
'''Window Scale:''' Scale the size of the contents of the tooltip window down by
 +
this much. Use 1.0 for regular size.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NjIucG5n/original/eLVvEV.png'></html>
 +
 +
'''Window Skin:''' Window skin used for Tooltip window. This can be used to help
 +
tell the player at first glance that the information displayed there is
 +
different from the normal window.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NjMucG5n/original/mhIFwo.png'></html>
 +
 +
'''Window Skin Opacity:''' Opacity of the window skin. Sometimes you don't want
 +
the opacity to be too transparent, as it will make the text on the tooltip
 +
window harder to read.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NjUucG5n/original/2KC%2BAu.png'></html>
 +
 +
'''Text Help Format:''' If you don't want to use the default text format for the
 +
tooltip window entries, change it up to your liking.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NjcucG5n/original/OIUxXb.png'></html>
 +
 +
'''Buff Format, Debuff Format:''' Since buffs and debuffs don't have database
 +
entries, you will change how they appear in the tooltips here.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NjkucG5n/original/embzMn.png'></html>
 +
 +
'''Turn Duration Format:''' Change how you want the turn duration to appear in
 +
your tooltip window.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2NzMucG5n/original/01p2Yx.png'></html>
 +
 +
'''Enabled Windows:''' You can disable which windows tooltips will appear from.
 +
Decide which ones work best for you and which ones don't. Only certain types
 +
of windows are compatible the tooltip window.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2ODAucG5n/original/GEJYqv.png'></html>
 +
 +
'''1. Window_Help:''' This requires [[Battle Engine Core (YEP)|YEP_BattleEngineCore]] and [[Buffs & States Core (YEP)|YEP_BuffsStatesCore]].
 +
Window_Help used in battle that shows the battler's name.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2ODgucG5n/original/BDp9ZX.png'></html>
 +
 +
'''2. Window_SkillStatus:''' Shown in the skill menu. Also used in a variety of
 +
Yanfly's menu revisions.
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2OTAucG5n/original/Bkmues.png'></html>
 +
 +
'''3. Window_BattleSideStates:''' Used with Olivia's [[Side Battle Status UI (Olivia)|Side Battle Status UI]].
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2OTQucG5n/original/JLsHbw.png' width='630'></html>
 +
 +
<html><img src='https://img.itch.zone/aW1nLzE4NTA2OTMucG5n/original/Np3e%2BM.png' width='630'></html>
 +
 +
'''4. Window_BattleStatus:''' Used for the battle status window.
 +
Only compatible with the default and Yanfly's.
 +
 +
== Changelog ==
 +
 +
* 2019 May 17: Bug fix for tooltip not updating unless need new mouse over
 +
* 2019 Feb 12: Added YEP_X_InBattleStatus compatibility
 +
* 2019 Feb 21: Updated tooltips so they won't display the remaining turns if the state has "None" as its auto-removal timing.
 +
 +
<!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
 +
<!-- [[Category: RPG Maker MV Core Plugins]] -->
 +
[[Category: RPG Maker MV Battle Plugins]]
 +
<!-- [[Category: RPG Maker MV Item Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Skill Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Equip Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Status Menu Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Gameplay Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Movement Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Quest Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Options Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Eventing Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Utility Plugins]] -->
 +
<!-- [[Category: RPG Maker MV Mechanical Plugins]] -->
 +
[[Category: RPG Maker MV Visual Plugins]]
 +
[[Category: RPG Maker MV Menu Plugins]]
 +
<!-- [[Category: RPG Maker MV Message Plugins]] -->
 +
[[Category: RPG Maker MV Quality of Life Plugins]]
 +
<!-- [[Category: RPG Maker MV Plugin Tips & Tricks]] -->
 +
<!-- [[Category: Action Sequences (MV)]] -->
 +
<!-- [[Category: Comment Tags (MV)]] -->
 +
<!-- [[Category: Main Menu Manager Integration (MV)]] -->
 +
<!-- [[Category: Notetags (MV)]] -->
 +
<!-- [[Category: Options Core Integration (MV)]] -->
 +
<!-- [[Category: Plugin Commands (MV)]] -->
 +
<!-- [[Category: Script Calls (MV)]] -->
 +
<!-- [[Category: Text Codes (MV)]] -->
 +
<!-- [[Category: Sample Projects (MV)]] -->

Latest revision as of 14:55, 2 July 2019

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 MV.

For help on how to install plugins, click here.

For help on how to update plugins, click here.

Got errors with your RPG Maker MV plugin? Click here.


Masterarbeit Writer

Fallen Angel Olivia

FallenAngelOlivia.png

This is a plugin created by Fallen Angel Olivia.

You can also follow Fallen Angel Olivia on itch.io.

RPG Maker Version

This plugin is made for RPG Maker MV versions 1.6.1 and below. If you update RPG Maker MV past that and this plugin breaks, I am NOT responsible for it.

Terms of Use

You are only allowed to use the plugins made by Atelier Irina if you agree to all of the following:

  1. These plugins may be used in free or commercial games.
  2. 'Fallen Angel Olivia' must be given credit in your games.
  3. You are allowed to edit the code.
  4. Do NOT change the filename, parameters, and information of the plugin.
  5. You are NOT allowed to redistribute these Plugins.
  6. You may NOT take code for your own released Plugins.

Introduction

This is a RPG Maker MV plugin that adds a tooltip window in battle (and other scenes) dedicated to showing information regarding states. If the player hovers the mouse over the state icons, the window will appear and display descriptions about each of the states affecting the battler.

Notetags

NotetagsMV.png

RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.

Here is a list of Notetag(s) that you may use.

--- 

<Help Description>
insert a help description here
insert another line if you want to
</Help Description>
- Place this in the states that you want to have appear in the tooltip
window. Text codes can be used for the description. If no description is
used, then the state will not appear in the tooltip window.

Plugin Parameters

There are Plugin Parameters that you may configure for this plugin.

Window Scale: Scale the size of the contents of the tooltip window down by this much. Use 1.0 for regular size.

Window Skin: Window skin used for Tooltip window. This can be used to help tell the player at first glance that the information displayed there is different from the normal window.

Window Skin Opacity: Opacity of the window skin. Sometimes you don't want the opacity to be too transparent, as it will make the text on the tooltip window harder to read.

Text Help Format: If you don't want to use the default text format for the tooltip window entries, change it up to your liking.

Buff Format, Debuff Format: Since buffs and debuffs don't have database entries, you will change how they appear in the tooltips here.

Turn Duration Format: Change how you want the turn duration to appear in your tooltip window.

Enabled Windows: You can disable which windows tooltips will appear from. Decide which ones work best for you and which ones don't. Only certain types of windows are compatible the tooltip window.

1. Window_Help: This requires YEP_BattleEngineCore and YEP_BuffsStatesCore. Window_Help used in battle that shows the battler's name.

2. Window_SkillStatus: Shown in the skill menu. Also used in a variety of Yanfly's menu revisions.

3. Window_BattleSideStates: Used with Olivia's Side Battle Status UI.

4. Window_BattleStatus: Used for the battle status window. Only compatible with the default and Yanfly's.

Changelog

  • 2019 May 17: Bug fix for tooltip not updating unless need new mouse over
  • 2019 Feb 12: Added YEP_X_InBattleStatus compatibility
  • 2019 Feb 21: Updated tooltips so they won't display the remaining turns if the state has "None" as its auto-removal timing.
Retrieved from "http://www.yanfly.moe/wiki/index.php?title=State_Tooltip_Display_(Olivia)&oldid=2235"