|
|
(9 intermediate revisions by the same user not shown) |
Line 1: |
Line 1: |
| {{MzPlugin | | {{MzPlugin |
− | |preview = <youtube>link</youtube> | + | |preview = <youtube>https://www.youtube.com/watch?v=QS6dCJRQJ1w</youtube> |
− | |link1 = <html><iframe frameborder="0" src="https://itch.io/embed/655177" width="552" height="167"><a href="https://visustella.itch.io/visustella-sample-project">Visustella Sample Project by VisuStella, Caz</a></iframe></iframe></html>
| + | |link1 = <html><iframe frameborder="0" src="https://itch.io/embed/760457" width="552" height="167"><a href="https://visustellamz.itch.io/weapon-unleash">Weapon Unleash plugin for RPG Maker MZ by VisuStellaMZ</a></iframe></html> |
− | |link2 = <html><iframe frameborder="0" src="https://itch.io/embed/754729" width="552" height="167"><a href="https://visustellamz.itch.io/wave-3-bundle">[Access Key] Wave 3 Plugins Bundle by VisuStellaMZ</a></iframe></html> | + | |link2 = {{VisuStella Wave 3}} |
| + | |link3 = {{VisuStella All Waves Collection}} |
| | | |
| }} | | }} |
Line 8: |
Line 9: |
| <!-- Preview --> | | <!-- Preview --> |
| | | |
− | {|
| + | [[File:WeaponUnleashMZ.gif]] |
− | | [[File:VisuMZ_Polish.png|400px]]
| |
− | | [[File:VisuMZ_Polish.png|400px]]
| |
− |
| |
− | |-
| |
− | | |
− | | [[File:VisuMZ_Polish.png|400px]]
| |
− | | [[File:VisuMZ_Polish.png|400px]]
| |
− | | |
− | |}
| |
| | | |
| {| style="width: 800px;" cellspacing="0" cellpadding="0" | | {| style="width: 800px;" cellspacing="0" cellpadding="0" |
Line 67: |
Line 59: |
| | | |
| == Understanding Weapon Unleashes and Guard Unleashes == | | == Understanding Weapon Unleashes and Guard Unleashes == |
| + | |
| + | [[File:WeaponUnleashMZ.gif]] |
| | | |
| If a battler (actor or enemy) has an associated Weapon or Guard Unleash | | If a battler (actor or enemy) has an associated Weapon or Guard Unleash |
Line 82: |
Line 76: |
| trigger either. | | trigger either. |
| | | |
− | If a battler has multiple Weapon or Guard Unleash traits, the game will go | + | If a battler has multiple |
− | through each trait one by one, taking whichever Unleash succeeds first.
| |
− | | |
− | When an Unleash triggers, if the Plugin Parameter settings allow for it,
| |
− | then an animation will play (if Core Engine is installed) and a text popup
| |
− | will be shown (if Battle Core is installed). At this point, any JavaScript
| |
− | effects that trigger upon Unleash will also run, too.
| |
− | | |
− | == Notetags ==
| |
− | | |
− | The 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.
| |
− | | |
− | === Unleash-Related Notetags ===
| |
− | | |
− | The following notetags are related to Unleashes, which have a percent chance
| |
− | of trigger upon selecting "Attack" or "Guard" commands in-battle.
| |
− | | |
− | ---
| |
− | | |
− | <Weapon Unleash id: x%>
| |
− | <Weapon Unleash name: x%>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Gives this object a trait that allows the affiliated battler a chance to
| |
− | perform an action other than "Attack" when selected.
| |
− | - Replace 'id' with either the skill's ID or name you wish for the "Attack"
| |
− | command to have a chance of activating.
| |
− | - Replace 'x' with a number representing the percentile chance to activate
| |
− | the Unleash skill.
| |
− | - If a battler has multiple Weapon Unleash traits, the game will go through
| |
− | each trait one by one, taking whichever Unleash skill succeeds first.
| |
− | | |
− | ---
| |
− | | |
− | <Guard Unleash id: x%>
| |
− | <Guard Unleash name: x%>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Gives this object a trait that allows the affiliated battler a chance to
| |
− | perform an action other than "Guard" when selected.
| |
− | - Replace 'id' with either the skill's ID or name you wish for the "Guard"
| |
− | command to have a chance of activating.
| |
− | - Replace 'x' with a number representing the percentile chance to activate
| |
− | the Unleash skill.
| |
− | - If a battler has multiple Guard Unleash traits, the game will go through
| |
− | each trait one by one, taking whichever Unleash skill succeeds first.
| |
− | | |
− | ---
| |
− | | |
− | <Weapon Unleash: +x%>
| |
− | <Weapon Unleash: -x%>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Raises/Lowers the activation chance of all Weapon Unleashes by x%.
| |
− | - Replace 'x' with a number representing the additive increase/decrease of
| |
− | all Weapon Unleash success rates.
| |
− | | |
− | ---
| |
− | | |
− | <Weapon Unleash id: +x%>
| |
− | <Weapon Unleash id: -x%>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Raises/Lowers the activation chance of the listed Weapon Unleash by x%.
| |
− | - Replace 'id' with either the skill's ID or name you wish to increase the
| |
− | Weapon Unleash success rate for.
| |
− | - Replace 'x' with a number representing the additive increase/decrease of
| |
− | the specified Weapon Unleash success rates.
| |
− | | |
− | ---
| |
− | | |
− | <Guard Unleash: +x%>
| |
− | <Guard Unleash: -x%>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Raises/Lowers the activation chance of all Guard Unleashes by x%.
| |
− | - Replace 'x' with a number representing the additive increase/decrease of
| |
− | all Guard Unleash success rates.
| |
− | | |
− | ---
| |
− | | |
− | <Guard Unleash id: +x%>
| |
− | <Guard Unleash id: -x%>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Raises/Lowers the activation chance of the listed Guard Unleash by x%.
| |
− | - Replace 'id' with either the skill's ID or name you wish to increase the
| |
− | Guard Unleash success rate for.
| |
− | - Replace 'x' with a number representing the additive increase/decrease of
| |
− | the specified Guard Unleash success rates.
| |
− | | |
− | ---
| |
− | | |
− | === JavaScript Notetags: Unleash-Related ===
| |
− | | |
− | The following notetags are made for users with JavaScript knowledge to
| |
− | determine which Unleash skill will be used (if at all).
| |
− | | |
− | ---
| |
− | | |
− | <JS Weapon Unleash>
| |
− | code
| |
− | code
| |
− | id = code;
| |
− | </JS Weapon Unleash>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Determines the Weapon Unleash skill ID to use.
| |
− | - Replace 'code' with JavaScript code to determine the skill ID to use.
| |
− | - The 'user' is the battler who is attempting to unleash the skill.
| |
− | - The 'id' variable is the skill ID that the character will use for the
| |
− | "Weapon Unleash".
| |
− | - Hint: The Unleashes occur at a 100% success rate. If you wish to make a
| |
− | percent chance success rate, check for a random number, and make it use
| |
− | the desired skill ID if it passes, and the default attack skill ID if it
| |
− | does not pass.
| |
− | | |
− | ---
| |
− | | |
− | <JS Guard Unleash>
| |
− | code
| |
− | code
| |
− | id = code;
| |
− | </JS Guard Unleash>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Determines the Guard Unleash skill ID to use.
| |
− | - Replace 'code' with JavaScript code to determine the skill ID to use.
| |
− | - The 'user' is the battler who is attempting to unleash the skill.
| |
− | - The 'id' variable is the skill ID that the character will use for the
| |
− | "Guard Unleash".
| |
− | - Hint: The Unleashes occur at a 100% success rate. If you wish to make a
| |
− | percent chance success rate, check for a random number, and make it use
| |
− | the desired skill ID if it passes, and the default attack skill ID if it
| |
− | does not pass.
| |
− | | |
− | ---
| |
− | | |
− | <JS On Unleash>
| |
− | code
| |
− | code
| |
− | code
| |
− | </JS On Unleash>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - This code runs when any kind of Unleash, Weapon or Guard, triggers.
| |
− | - Runs 'code' with JavaScript code to determine any effects that occur.
| |
− | - The 'user' is the battler who is currently using the unleash skill.
| |
− | - The 'id' variable is the skill ID being unleashed.
| |
− | - The 'skill' variable is the skill being unleashed.
| |
− | | |
− | ---
| |
− | | |
− | <JS On Weapon Unleash>
| |
− | code
| |
− | code
| |
− | code
| |
− | </JS On Weapon Unleash>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - This code runs when a Weapon Unleash triggers.
| |
− | - Runs 'code' with JavaScript code to determine any effects that occur.
| |
− | - The 'user' is the battler who is currently using the unleash skill.
| |
− | - The 'id' variable is the skill ID being unleashed.
| |
− | - The 'skill' variable is the skill being unleashed.
| |
− | | |
− | ---
| |
− | | |
− | <JS On Guard Unleash>
| |
− | code
| |
− | code
| |
− | code
| |
− | </JS On Guard Unleash>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - This code runs when a Guard Unleash triggers.
| |
− | - Runs 'code' with JavaScript code to determine any effects that occur.
| |
− | - The 'user' is the battler who is currently using the unleash skill.
| |
− | - The 'id' variable is the skill ID being unleashed.
| |
− | - The 'skill' variable is the skill being unleashed.
| |
− | | |
− | ---
| |
− | | |
− | === Replace-Related Notetags ===
| |
− | | |
− | Skill replacement traits will replace the "Attack" and "Guard" commands in
| |
− | battle with other skills. They will always be replaced unless an Unleash
| |
− | successfully triggers and overrides them.
| |
− | | |
− | ---
| |
− | | |
− | <Replace Attack: id>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Replaces the battler's Attack command in battle with a different skill.
| |
− | - Replace 'id' with the skill's ID or name you wish to replace the battler's
| |
− | Attack command with.
| |
− | - If a Weapon Unleash occurs, the Weapon Unleash will take priority over the
| |
− | Replace Attack skill.
| |
− | - If a battler has multiple Replace Attack traits, the game will go through
| |
− | each trait one by one, taking whichever replaced skill is found first.
| |
− | | |
− | ---
| |
− | | |
− | <Replace Guard: id>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Replaces the battler's Guard command in battle with a different skill.
| |
− | - Replace 'id' with the skill's ID or name you wish to replace the battler's
| |
− | Guard command with.
| |
− | - If a Weapon Unleash occurs, the Weapon Unleash will take priority over the
| |
− | Replace Guard skill.
| |
− | - If a battler has multiple Replace Guard traits, the game will go through
| |
− | each trait one by one, taking whichever replaced skill is found first.
| |
− | | |
− | ---
| |
− | | |
− | === JavaScript Notetags: Replace-Related ===
| |
− | | |
− | The following notetags are made for users with JavaScript knowledge to
| |
− | determine which replacement skill will be used (if at all).
| |
− | | |
− | ---
| |
− | | |
− | <JS Replace Attack>
| |
− | code
| |
− | code
| |
− | id = code;
| |
− | </JS Replace Attack>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Determines the Replace Attack skill ID to use.
| |
− | - Replace 'code' with JavaScript code to determine the skill ID to use.
| |
− | - The 'id' variable is the skill ID that the character will use for the
| |
− | attack replacement.
| |
− | | |
− | ---
| |
− | | |
− | <JS Replace Guard>
| |
− | code
| |
− | code
| |
− | id = code;
| |
− | </JS Replace Guard>
| |
− | | |
− | - Used for: Actor, Class, Skill, Weapon, Armor, Enemy, State Notetags
| |
− | - Determines the Replace Guard skill ID to use.
| |
− | - Replace 'code' with JavaScript code to determine the skill ID to use.
| |
− | - The 'id' variable is the skill ID that the character will use for the
| |
− | attack replacement.
| |
− | | |
− | ---
| |
− | | |
− | == Plugin Parameters ==
| |
− | | |
− | === Weapon Unleash Settings ===
| |
− | | |
− | Special effects regarding Weapon Unleashes. These include animations and
| |
− | text popups that appear visually along with mechanical effects that can be
| |
− | extended upon with JavaScript.
| |
− | | |
− | ---
| |
− | | |
− | Animation
| |
− | | |
− | Animation ID:
| |
− | - Play this animation when the effect activates.
| |
− | - Requires VisuMZ_0_CoreEngine.
| |
− | | |
− | Mirror Animation:
| |
− | - Mirror the effect animation?
| |
− | - Requires VisuMZ_0_CoreEngine.
| |
− | | |
− | Mute Animation:
| |
− | - Mute the effect animation?
| |
− | - Requires VisuMZ_0_CoreEngine.
| |
− | | |
− | ---
| |
− | | |
− | Popups
| |
− | | |
− | Text:
| |
− | - Text displayed upon the effect activating.
| |
− | - Requires VisuMZ_1_BattleCore.
| |
− | | |
− | Text Color:
| |
− | - Use #rrggbb for custom colors or regular numbers for text colors from
| |
− | the Window Skin.
| |
− | | |
− | Flash Color:
| |
− | - Adjust the popup's flash color.
| |
− | - Format: [red, green, blue, alpha]
| |
− | | |
− | Flash Duration:
| |
− | - What is the frame duration of the flash effect?
| |
− | | |
− | ---
| |
− | | |
− | JavaScript
| |
− | | |
− | JS: On Unleash:
| |
− | - Code ran when a Weapon Unleash triggers.
| |
− | | |
− | ---
| |
− | | |
− | === Guard Unleash Settings ===
| |
− | | |
− | Special effects regarding Guard Unleashes. These include animations and
| |
− | text popups that appear visually along with mechanical effects that can be
| |
− | extended upon with JavaScript.
| |
− | | |
− | ---
| |
− | | |
− | Animation
| |
− | | |
− | Animation ID:
| |
− | - Play this animation when the effect activates.
| |
− | - Requires VisuMZ_0_CoreEngine.
| |
− | | |
− | Mirror Animation:
| |
− | - Mirror the effect animation?
| |
− | - Requires VisuMZ_0_CoreEngine.
| |
− | | |
− | Mute Animation:
| |
− | - Mute the effect animation?
| |
− | - Requires VisuMZ_0_CoreEngine.
| |
− | | |
− | ---
| |
− | | |
− | Popups
| |
− | | |
− | Text:
| |
− | - Text displayed upon the effect activating.
| |
− | - Requires VisuMZ_1_BattleCore.
| |
− | | |
− | Text Color:
| |
− | - Use #rrggbb for custom colors or regular numbers for text colors from
| |
− | the Window Skin.
| |
− | | |
− | Flash Color:
| |
− | - Adjust the popup's flash color.
| |
− | - Format: [red, green, blue, alpha]
| |
− | | |
− | Flash Duration:
| |
− | - What is the frame duration of the flash effect?
| |
− | | |
− | ---
| |
− | | |
− | JavaScript
| |
− | | |
− | JS: On Unleash:
| |
− | - Code ran when a Guard Unleash triggers.
| |
− | | |
− | ---
| |
− | | |
− | {{VisuStella MZ Terms of Use}}
| |
− | | |
− | == Credits ==
| |
− | | |
− | If you are using this plugin, credit the following people in your game:
| |
− | | |
− | Team VisuStella
| |
− | | |
− | * [[Yanfly]]
| |
− | * [[Arisu]]
| |
− | * [[Olivia]]
| |
− | * [[Irina]]
| |
− | | |
− | == Changelog ==
| |
− | | |
− | Version 1.00: September 25, 2020
| |
− | * Finished Plugin!
| |
− | | |
− | == End of File ==
| |
− | | |
− | |}
| |
− | | |
− | <!-- This is a comment, remove the arrows surrounding this for the categories you want to show -->
| |
− | <!-- [[Category: RPG Maker MZ Core Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Battle Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Item Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Skill Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Equip Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Status Menu Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Gameplay Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Movement Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Quest Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Options Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Eventing Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Utility Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Mechanical Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Visual Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Menu Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Message Plugins]] -->
| |
− | <!-- [[Category: RPG Maker MZ Quality of Life Plugins]] -->
| |
− | <!-- [[Category: Action Sequences (MZ)]] -->
| |
− | <!-- [[Category: Comment Tags (MZ)]] -->
| |
− | <!-- [[Category: Main Menu Manager Integration (MZ)]] -->
| |
− | <!-- [[Category: Notetags (MZ)]] -->
| |
− | <!-- [[Category: Options Core Integration (MZ)]] -->
| |
− | <!-- [[Category: Plugin Commands (MZ)]] -->
| |
− | <!-- [[Category: Script Calls (MZ)]] -->
| |
− | <!-- [[Category: Text Codes (MZ)]] -->
| |