Adds doccomments to all abilities
All checks were successful
Build / Build (push) Successful in 50s

This commit is contained in:
Deukhoofd 2025-06-07 11:20:35 +02:00
parent b2ba3d96ba
commit 273d26057a
Signed by: Deukhoofd
GPG Key ID: F63E044490819F6F
20 changed files with 133 additions and 0 deletions

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Aftermath_(Ability)">Bulbapedia - Aftermath</see>
/// </summary>
[Script(ScriptCategory.Ability, "aftermath")] [Script(ScriptCategory.Ability, "aftermath")]
public class Aftermath : Script public class Aftermath : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Analytic_(Ability)">Bulbapedia - Analytic</see>
/// </summary>
[Script(ScriptCategory.Ability, "analytic")] [Script(ScriptCategory.Ability, "analytic")]
public class Analytic : Script public class Analytic : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Anger_Point_(Ability)">Bulbapedia - Anger Point</see>
/// </summary>
[Script(ScriptCategory.Ability, "anger_point")] [Script(ScriptCategory.Ability, "anger_point")]
public class AngerPoint : Script public class AngerPoint : Script
{ {

View File

@ -2,6 +2,12 @@ using PkmnLib.Static.Utils;
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Anticipation_(Ability)">Bulbapedia - Anticipation</see>
/// </summary>
[Script(ScriptCategory.Ability, "anticipation")] [Script(ScriptCategory.Ability, "anticipation")]
public class Anticipation : Script public class Anticipation : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Arena_Trap_(Ability)">Bulbapedia - Arena Trap</see>
/// </summary>
[Script(ScriptCategory.Ability, "arena_trap")] [Script(ScriptCategory.Ability, "arena_trap")]
public class ArenaTrap : Script public class ArenaTrap : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Aroma_Veil_(Ability)">Bulbapedia - Aroma Veil</see>
/// </summary>
[Script(ScriptCategory.Ability, "aroma_veil")] [Script(ScriptCategory.Ability, "aroma_veil")]
public class AromaVeil : Script public class AromaVeil : Script
{ {

View File

@ -2,6 +2,12 @@ using PkmnLib.Static.Utils;
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Bad_Dreams_(Ability)">Bulbapedia - Bad Dreams</see>
/// </summary>
[Script(ScriptCategory.Ability, "bad_dreams")] [Script(ScriptCategory.Ability, "bad_dreams")]
public class BadDreams : Script public class BadDreams : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Battery_(Ability)">Bulbapedia - Battery</see>
/// </summary>
[Script(ScriptCategory.Ability, "battery")] [Script(ScriptCategory.Ability, "battery")]
public class Battery : Script public class Battery : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Battle_Bond_(Ability)">Bulbapedia - Battle Bond</see>
/// </summary>
[Script(ScriptCategory.Ability, "battle_bond")] [Script(ScriptCategory.Ability, "battle_bond")]
public class BattleBond : Script public class BattleBond : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Beast_Boost_(Ability)">Bulbapedia - Beast Boost</see>
/// </summary>
[Script(ScriptCategory.Ability, "beast_boost")] [Script(ScriptCategory.Ability, "beast_boost")]
public class BeastBoost : Script public class BeastBoost : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Berserk_(Ability)">Bulbapedia - Berserk</see>
/// </summary>
[Script(ScriptCategory.Ability, "berserk")] [Script(ScriptCategory.Ability, "berserk")]
public class Berserk : Script public class Berserk : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Bulletproof_(Ability)">Bulbapedia - Bulletproof</see>
/// </summary>
[Script(ScriptCategory.Ability, "bulletproof")] [Script(ScriptCategory.Ability, "bulletproof")]
public class Bulletproof : Script public class Bulletproof : Script
{ {

View File

@ -2,6 +2,14 @@ using PkmnLib.Static.Utils;
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Normalize_(Ability)">Bulbapedia - Normalize</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Pixilate_(Ability)">Bulbapedia - Pixilate</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Refrigerate_(Ability)">Bulbapedia - Refrigerate</see>
/// </summary>
[Script(ScriptCategory.Ability, "change_move_type")] [Script(ScriptCategory.Ability, "change_move_type")]
public class ChangeMoveTypeAbility : Script public class ChangeMoveTypeAbility : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Cheek_Pouch_(Ability)">Bulbapedia - Cheek Pouch</see>
/// </summary>
[Script(ScriptCategory.Ability, "cheek_pouch")] [Script(ScriptCategory.Ability, "cheek_pouch")]
public class CheekPouch : Script public class CheekPouch : Script
{ {

View File

@ -1,5 +1,11 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Color_Change_(Ability)">Bulbapedia - Color Change</see>
/// </summary>
[Script(ScriptCategory.Ability, "color_change")] [Script(ScriptCategory.Ability, "color_change")]
public class ColorChange : Script public class ColorChange : Script
{ {

View File

@ -2,6 +2,12 @@ using PkmnLib.Static.Utils;
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Adaptability_(Ability)">Bulbapedia - Adaptability</see>
/// </summary>
[Script(ScriptCategory.Ability, "increased_stab")] [Script(ScriptCategory.Ability, "increased_stab")]
public class IncreasedStab : Script public class IncreasedStab : Script
{ {

View File

@ -2,6 +2,16 @@ using PkmnLib.Static.Utils;
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Blaze_(Ability)">Bulbapedia - Blaze</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Torrent_(Ability)">Bulbapedia - Torrent</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Overgrow_(Ability)">Bulbapedia - Overgrow</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Swarm_(Ability)">Bulbapedia - Swarm</see>
/// </summary>
[Script(ScriptCategory.Ability, "power_up_type_at_low_health")] [Script(ScriptCategory.Ability, "power_up_type_at_low_health")]
public class PowerUpTypeAtLowHealth : Script public class PowerUpTypeAtLowHealth : Script
{ {

View File

@ -2,6 +2,15 @@ using PkmnLib.Static.Utils;
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Clear_Body_(Ability)">Bulbapedia - Clear Body</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/White_Smoke_(Ability)">Bulbapedia - White Smoke</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Full_Metal_Body_(Ability)">Bulbapedia - Full Metal Body</see>
/// </summary>
[Script(ScriptCategory.Ability, "prevent_stat_lowering")] [Script(ScriptCategory.Ability, "prevent_stat_lowering")]
public class PreventStatLowering : Script public class PreventStatLowering : Script
{ {

View File

@ -2,6 +2,14 @@ using PkmnLib.Static.Utils;
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Swift_Swim_(Ability)">Bulbapedia - Swift Swim</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Chlorophyll_(Ability)">Bulbapedia - Chlorophyll</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Sand_Rush_(Ability)">Bulbapedia - Sand Rush</see>
/// </summary>
[Script(ScriptCategory.Ability, "speed_modifier_in_weather")] [Script(ScriptCategory.Ability, "speed_modifier_in_weather")]
public class SpeedModifierInWeather : Script public class SpeedModifierInWeather : Script
{ {

View File

@ -1,5 +1,13 @@
namespace PkmnLib.Plugin.Gen7.Scripts.Abilities; namespace PkmnLib.Plugin.Gen7.Scripts.Abilities;
/// <summary>
/// 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.
///
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Cloud_Nine_(Ability)">Bulbapedia - Cloud Nine</see>
/// <see href="https://bulbapedia.bulbagarden.net/wiki/Air_Lock_(Ability)">Bulbapedia - Air Lock</see>
/// </summary>
[Script(ScriptCategory.Ability, "suppress_weather")] [Script(ScriptCategory.Ability, "suppress_weather")]
public class SuppressWeatherAbility : Script public class SuppressWeatherAbility : Script
{ {