Variable Gauges VisuStella MZ
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.
Download
| ||
SystemThis 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. |
VisuStella MZThis plugin is a part of the VisuStella MZ Plugin Library. Click here if you want to help support VisuStella on Patreon. IntroductionThis plugin allows you, the game dev, to place gauges on the screen whose values are governed by variables. These gauges can appear on the map screen or the battle screen to your liking. Their maximum values, placements, type, colors, and more can be adjusted to suit your needs. Mark them with icons and have tooltip windows appear explaining their purpose when the player hovers the mouse cursor over them. Features include all (but not limited to) the following:
RequirementsThis plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker.
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.
VisuStella MZ CompatibilityWhile this plugin is compatible with the majority of the VisuStella MZ plugin library, it is not compatible with specific plugins or specific features. This section will highlight the main plugins/features that will not be compatible with this plugin or put focus on how the make certain features compatible. --- Message Core VisuStella MZWord Wrap does not work the tooltips. This is because the tooltips are automatically sized based on the text at hand. --- Message Keywords VisuStella MZMessage Keywords do not work with the tooltips because you cannot hover the mouse cursor over a window that only appears when hovering over a specific section of the screen. --- NotetagsThe following are notetags that have been added through this plugin. These notetags will not work with your game if this plugin is OFF or not present. --- Map-Related Notetags--- <Hide Variable Gauges> - Used for: Map Notetags - Prevents Variable Gauges from being visible on the current map. --- <Force Variable Gauge: key> <Force Variable Gauges: key, key, key> - Used for: Map Notetags - Overrides map settings for the visible Variable Gauges and makes it so that only the listed Variable Gauges (marked by their keys) are visible while on this map. - No other Variable Gauges are visible while on this map. - Replace 'key' with a string representing the Variable Gauge that should be visible on the map. --- <Extra Variable Gauge: key> <Extra Variable Gauges: key, key, key> - Used for: Map Notetags - Shows extra Variable Gauge(s) in addition to the ones that are normally visible on the map while on this map. - Replace 'key' with a string representing the Variable Gauge that is also visible on the map. --- Plugin CommandsThe following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command. --- Battle Plugin Commands--- Battle: Add Variable Gauge(s) - Adds Variable Gauge(s) to be visible in battle. Key(s): - List the key(s) of the Variable Gauge(s) you want visible in battle. --- Battle: Remove Variable Gauge(s) - Remove Variable Gauge(s) from view in battle. Key(s): - List the key(s) of the Variable Gauge(s) you want removed from battle. --- Battle: Remove All Gauge(s) - Remove All Variable Gauge(s) from view in battle. --- Map Plugin Commands--- Map: Add Variable Gauge(s) - Adds Variable Gauge(s) to be visible on the map. Key(s): - List the key(s) of the Variable Gauge(s) you want visible on the map. --- Map: Remove Variable Gauge(s) - Remove Variable Gauge(s) from view in battle. Key(s): - List the key(s) of the Variable Gauge(s) you want removed from the map scene. --- Map: Remove All Gauge(s) - Remove All Variable Gauge(s) from view on the map. --- Refresh Plugin Commands--- Refresh: All Variable Gauge(s) - Refresh all Variable Gauges currently visible. --- Refresh: Target Variable Gauge(s) - Refresh Target Variable Gauges currently visible. Key(s): - List the key(s) of the Variable Gauge(s) you want refreshed. --- System Plugin Commands--- System: Variable Gauge Visibility - Shows/hides all variable gauges on the screen. Visibility: - Shows/hides all Variable Gauges on the screen. --- Plugin ParametersGauge List SettingsA list of the gauges you wish to show on screen. Here is where you adjust ALL of the settings related to the Variable Gauges that can appear in your game. Every setting needs to be carefully adjusted. --- Main Key: - Identification key used to reference this gauge. - Use unique keys for this to work. - If you do not change the ID Key for this Variable Gauge and leave it as >>>ATTENTION<<<, then the game will not let you move forward. Variable ID: - Select a variable to bind this gauge to. - Use a Variable ID other than 0 for this to work. JS: Maximum Value: - Code used to determine the maximum value for the gauge. --- Gauge Colors Color 1: Color 2: - Use #rrggbb for custom colors or regular numbers for text colors from the Window Skin. --- Default Visibility Map Visible: Battle Visible: - Do you want this gauge to be visible or hidden by default? --- Icon Settings Icon Index: - Pairs the gauge with an icon. - Use 0 to not use any icons. Icon Buffer: - Pixel distance to buffer icon from gauge. - Direction depends on Gauge Type. --- Screen Settings Gauge Type: - What is the gauge type like? - Horizontal - Goes Left to Right - Vertical - Goes Down to Up JS: Position: - Code used to determine the screen position for this gauge. --- Tooltip Settings Tooltip Text: - Tooltip text that's displayed when the mouse hovers over. - Text codes allowed. Does not work with Word Wrap. --- Tooltip SettingsSettings for the Variable Gauges Tooltips Window. --- Appearance Scale: - What scale size do you want for the tooltip? - Use 1.0 for normal size. Skin Filename: - What window skin do you want to use for the tooltip? Skin Opacity: - What opacity setting is used for the tooltip? - Use a number between 0 and 255. --- Offset Offset X: - Offset the tooltip X position from the mouse? - Negative: left. Positive: right. Offset Y: - Offset the tooltip Y position from the mouse? - Negative: up. Positive: down. ---
Terms of Use1. 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. 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. 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は一切の責任を負いません。 5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。 8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。 CreditsIf you are using this plugin, credit the following people in your game: Team VisuStella ChangelogVersion 1.00 Official Release Date: February 11, 2022
End of File |