From cdd1a274e260d1a0b2ae06d83669ce3ec0cba175 Mon Sep 17 00:00:00 2001 From: innerthunder Date: Sat, 31 Aug 2024 00:37:11 -0700 Subject: [PATCH] Docs for `isTrapped` --- src/field/pokemon.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/field/pokemon.ts b/src/field/pokemon.ts index 8786b60b818..467944b66b4 100644 --- a/src/field/pokemon.ts +++ b/src/field/pokemon.ts @@ -1210,6 +1210,14 @@ export default abstract class Pokemon extends Phaser.GameObjects.Container { return !!this.getTag(GroundedTag) || (!this.isOfType(Type.FLYING, true, true) && !this.hasAbility(Abilities.LEVITATE) && !this.getTag(BattlerTagType.MAGNET_RISEN) && !this.getTag(SemiInvulnerableTag)); } + /** + * Determines whether this Pokemon is prevented from running or switching due + * to effects from moves and/or abilities. + * @param trappedAbMessages `string[]` If defined, ability trigger messages + * (e.g. from Shadow Tag) are forwarded through this array. + * @param simulated `boolean` if `true`, applies abilities via simulated calls. + * @returns + */ isTrapped(trappedAbMessages?: string[], simulated: boolean = true): boolean { if (this.isOfType(Type.GHOST)) { return false;