From 273d26057a8c4f3781898ac8786dae9f2fccf2bb Mon Sep 17 00:00:00 2001 From: Deukhoofd Date: Sat, 7 Jun 2025 11:20:35 +0200 Subject: [PATCH] Adds doccomments to all abilities --- .../PkmnLib.Plugin.Gen7/Scripts/Abilities/Aftermath.cs | 6 ++++++ .../PkmnLib.Plugin.Gen7/Scripts/Abilities/Analytic.cs | 6 ++++++ .../Scripts/Abilities/AngerPoint.cs | 6 ++++++ .../Scripts/Abilities/Anticipation.cs | 6 ++++++ .../PkmnLib.Plugin.Gen7/Scripts/Abilities/ArenaTrap.cs | 6 ++++++ .../PkmnLib.Plugin.Gen7/Scripts/Abilities/AromaVeil.cs | 6 ++++++ .../PkmnLib.Plugin.Gen7/Scripts/Abilities/BadDreams.cs | 6 ++++++ .../PkmnLib.Plugin.Gen7/Scripts/Abilities/Battery.cs | 6 ++++++ .../Scripts/Abilities/BattleBond.cs | 6 ++++++ .../Scripts/Abilities/BeastBoost.cs | 6 ++++++ .../PkmnLib.Plugin.Gen7/Scripts/Abilities/Berserk.cs | 6 ++++++ .../Scripts/Abilities/Bulletproof.cs | 6 ++++++ .../Scripts/Abilities/ChangeMoveTypeAbility.cs | 8 ++++++++ .../Scripts/Abilities/CheekPouch.cs | 6 ++++++ .../Scripts/Abilities/ColorChange.cs | 6 ++++++ .../Scripts/Abilities/IncreasedStabAbility.cs | 6 ++++++ .../Scripts/Abilities/PowerUpTypeAtLowHealth.cs | 10 ++++++++++ .../Scripts/Abilities/PreventStatLowering.cs | 9 +++++++++ .../Scripts/Abilities/SpeedModifierInWeather.cs | 8 ++++++++ .../Scripts/Abilities/SuppressWeatherAbility.cs | 8 ++++++++ 20 files changed, 133 insertions(+) diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Aftermath.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Aftermath.cs index 7eee9eb..9e53410 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Aftermath.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Aftermath.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Aftermath is an ability that causes the attacker to lose 1/4 of its maximum HP if it knocks out the user with a contact move. +/// This effect only triggers if the move that caused the faint was a contact move. +/// +/// Bulbapedia - Aftermath +/// [Script(ScriptCategory.Ability, "aftermath")] public class Aftermath : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Analytic.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Analytic.cs index d6d55ed..d1540f5 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Analytic.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Analytic.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Analytic is an ability that increases the power of the user's move by 30% if the user moves after all other Pokémon in the same turn. +/// This bonus applies only if the Pokémon with Analytic acts last in the turn. +/// +/// Bulbapedia - Analytic +/// [Script(ScriptCategory.Ability, "analytic")] public class Analytic : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/AngerPoint.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/AngerPoint.cs index 763b4eb..ec79d10 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/AngerPoint.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/AngerPoint.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Anger Point is an ability that maximizes the user's Attack stat when it is hit by a critical hit. +/// The user's Attack stat is raised to +6 stages immediately after taking a critical hit. +/// +/// Bulbapedia - Anger Point +/// [Script(ScriptCategory.Ability, "anger_point")] public class AngerPoint : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Anticipation.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Anticipation.cs index bc073b5..6442d68 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Anticipation.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Anticipation.cs @@ -2,6 +2,12 @@ using PkmnLib.Static.Utils; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Anticipation is an ability that alerts the user if any opponent has a super effective, OHKO, or self-destruct move upon entering battle. +/// The alert is triggered if an opponent knows a move that is super effective against the user, or a move with the OHKO or self-destruct effect. +/// +/// Bulbapedia - Anticipation +/// [Script(ScriptCategory.Ability, "anticipation")] public class Anticipation : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ArenaTrap.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ArenaTrap.cs index c8f4b8c..f0c13b2 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ArenaTrap.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ArenaTrap.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Arena Trap is an ability that prevents opposing grounded Pokémon from fleeing or switching out of battle. +/// This effect does not apply to Flying-type Pokémon, those with Levitate, or those holding a Shed Shell. +/// +/// Bulbapedia - Arena Trap +/// [Script(ScriptCategory.Ability, "arena_trap")] public class ArenaTrap : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/AromaVeil.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/AromaVeil.cs index 1a34111..de4042e 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/AromaVeil.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/AromaVeil.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Aroma Veil is an ability that prevents allies from being affected by moves that prevent the use of moves, such as Taunt, Torment, and Disable. +/// This effect applies to all Pokémon on the same side of the field. +/// +/// Bulbapedia - Aroma Veil +/// [Script(ScriptCategory.Ability, "aroma_veil")] public class AromaVeil : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BadDreams.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BadDreams.cs index 5f15005..13507ac 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BadDreams.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BadDreams.cs @@ -2,6 +2,12 @@ using PkmnLib.Static.Utils; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Bad Dreams is an ability that causes sleeping opposing Pokémon to lose 1/8 of their maximum HP at the end of each turn. +/// This effect only applies to sleeping Pokémon on the opposing side of the field. +/// +/// Bulbapedia - Bad Dreams +/// [Script(ScriptCategory.Ability, "bad_dreams")] public class BadDreams : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Battery.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Battery.cs index 5353b14..6abc07e 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Battery.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Battery.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Battery is an ability that increases the power of allies' Special moves by 30%. +/// This effect only applies to allies on the same side of the field. +/// +/// Bulbapedia - Battery +/// [Script(ScriptCategory.Ability, "battery")] public class Battery : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BattleBond.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BattleBond.cs index 03d5684..acccab6 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BattleBond.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BattleBond.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Battle Bond is an ability exclusive to Greninja. When Greninja with this ability knocks out a Pokémon, it transforms into Ash-Greninja. +/// In its Ash-Greninja form, Water Shuriken's base power is increased to 20 and it always hits 3 times. +/// +/// Bulbapedia - Battle Bond +/// [Script(ScriptCategory.Ability, "battle_bond")] public class BattleBond : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BeastBoost.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BeastBoost.cs index 5242670..9125ecb 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BeastBoost.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/BeastBoost.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Beast Boost is an ability that raises the user's highest stat by one stage when it knocks out another Pokémon. +/// If multiple stats are tied for the highest, the stat that is raised is chosen in this order: Attack, Defense, Special Attack, Special Defense, Speed. +/// +/// Bulbapedia - Beast Boost +/// [Script(ScriptCategory.Ability, "beast_boost")] public class BeastBoost : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Berserk.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Berserk.cs index 1aed60e..9e1c051 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Berserk.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Berserk.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Berserk is an ability that raises the user's Special Attack by one stage when its HP drops below half due to damage. +/// This effect only activates if the HP drops below half as a result of damage, not from other effects. +/// +/// Bulbapedia - Berserk +/// [Script(ScriptCategory.Ability, "berserk")] public class Berserk : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Bulletproof.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Bulletproof.cs index 89a9a35..60b0dfc 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Bulletproof.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/Bulletproof.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Bulletproof is an ability that grants immunity to ball and bomb moves. +/// The Pokémon is unaffected by all damage and effects from moves flagged as ballistics, such as Shadow Ball and Sludge Bomb. +/// +/// Bulbapedia - Bulletproof +/// [Script(ScriptCategory.Ability, "bulletproof")] public class Bulletproof : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ChangeMoveTypeAbility.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ChangeMoveTypeAbility.cs index c1bf74a..5112fda 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ChangeMoveTypeAbility.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ChangeMoveTypeAbility.cs @@ -2,6 +2,14 @@ using PkmnLib.Static.Utils; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// ChangeMoveTypeAbility is a generic ability that changes the type of a move from one type to another. +/// This ability is used by abilities like Normalize, Pixilate, and Refrigerate. +/// +/// Bulbapedia - Normalize +/// Bulbapedia - Pixilate +/// Bulbapedia - Refrigerate +/// [Script(ScriptCategory.Ability, "change_move_type")] public class ChangeMoveTypeAbility : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/CheekPouch.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/CheekPouch.cs index a845a78..2642885 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/CheekPouch.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/CheekPouch.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Cheek Pouch is an ability that heals the user for 1/3 of its maximum HP after consuming a berry. +/// This effect applies to any berry item consumed by the Pokémon. +/// +/// Bulbapedia - Cheek Pouch +/// [Script(ScriptCategory.Ability, "cheek_pouch")] public class CheekPouch : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ColorChange.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ColorChange.cs index f589c90..1586a81 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ColorChange.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/ColorChange.cs @@ -1,5 +1,11 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// Color Change is an ability that changes the user's type to match the type of the last move it was hit by. +/// This effect applies to any damaging move that hits the Pokémon. +/// +/// Bulbapedia - Color Change +/// [Script(ScriptCategory.Ability, "color_change")] public class ColorChange : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/IncreasedStabAbility.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/IncreasedStabAbility.cs index f8bb36f..071713d 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/IncreasedStabAbility.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/IncreasedStabAbility.cs @@ -2,6 +2,12 @@ using PkmnLib.Static.Utils; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// IncreasedStab is a generic ability that increases the STAB (Same Type Attack Bonus) modifier from 1.5x to 2.0x. +/// This ability is used by abilities like Adaptability. +/// +/// Bulbapedia - Adaptability +/// [Script(ScriptCategory.Ability, "increased_stab")] public class IncreasedStab : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/PowerUpTypeAtLowHealth.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/PowerUpTypeAtLowHealth.cs index 6ee1199..1a5789e 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/PowerUpTypeAtLowHealth.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/PowerUpTypeAtLowHealth.cs @@ -2,6 +2,16 @@ using PkmnLib.Static.Utils; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// PowerUpTypeAtLowHealth is a generic ability that increases the power of moves of a specific type when the user's HP is below a certain threshold. +/// The power increase is 1.5x when the user's HP falls below the specified threshold. +/// This ability is used by abilities like Blaze, Torrent, Overgrow, and Swarm. +/// +/// Bulbapedia - Blaze +/// Bulbapedia - Torrent +/// Bulbapedia - Overgrow +/// Bulbapedia - Swarm +/// [Script(ScriptCategory.Ability, "power_up_type_at_low_health")] public class PowerUpTypeAtLowHealth : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/PreventStatLowering.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/PreventStatLowering.cs index 719f6fb..0a40116 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/PreventStatLowering.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/PreventStatLowering.cs @@ -2,6 +2,15 @@ using PkmnLib.Static.Utils; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// PreventStatLowering is a generic ability that prevents the user's stats from being lowered by opposing Pokémon. +/// This ability can be configured to prevent lowering of a specific stat or all stats. +/// This ability is used by abilities like Clear Body, White Smoke, and Full Metal Body. +/// +/// Bulbapedia - Clear Body +/// Bulbapedia - White Smoke +/// Bulbapedia - Full Metal Body +/// [Script(ScriptCategory.Ability, "prevent_stat_lowering")] public class PreventStatLowering : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/SpeedModifierInWeather.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/SpeedModifierInWeather.cs index b14990a..cfb56ea 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/SpeedModifierInWeather.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/SpeedModifierInWeather.cs @@ -2,6 +2,14 @@ using PkmnLib.Static.Utils; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// SpeedModifierInWeather is a generic ability that modifies the user's speed in a specific weather condition. +/// This ability is used by abilities like Swift Swim, Chlorophyll, and Sand Rush. +/// +/// Bulbapedia - Swift Swim +/// Bulbapedia - Chlorophyll +/// Bulbapedia - Sand Rush +/// [Script(ScriptCategory.Ability, "speed_modifier_in_weather")] public class SpeedModifierInWeather : Script { diff --git a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/SuppressWeatherAbility.cs b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/SuppressWeatherAbility.cs index cfb6238..51a5085 100644 --- a/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/SuppressWeatherAbility.cs +++ b/Plugins/PkmnLib.Plugin.Gen7/Scripts/Abilities/SuppressWeatherAbility.cs @@ -1,5 +1,13 @@ namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; +/// +/// SuppressWeatherAbility is a generic ability that suppresses the effects of weather conditions. +/// This ability prevents weather effects from being applied while the Pokémon is on the field. +/// This ability is used by abilities like Cloud Nine and Air Lock. +/// +/// Bulbapedia - Cloud Nine +/// Bulbapedia - Air Lock +/// [Script(ScriptCategory.Ability, "suppress_weather")] public class SuppressWeatherAbility : Script {