mika/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2025-08-23 07:49:36 +02:00
Code Issues Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
innerthunder 2024-10-13 23:29:30 -07:00
parent 682c6b9e88
commit 215dfe2b3c
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/data/arena-tag.ts
View File

@ -261,12 +261,11 @@ export class ConditionalProtectTag extends ArenaTag {
* and protects the target if conditions are met * and protects the target if conditions are met
* @param arena the {@linkcode Arena} containing this tag * @param arena the {@linkcode Arena} containing this tag
* @param simulated `true` if the tag is applied quietly; `false` otherwise. * @param simulated `true` if the tag is applied quietly; `false` otherwise.
* @param args the arguments for this tag's application: * @param isProtected a {@linkcode Utils.BooleanHolder | BooleanHolder} used to flag if the move is protected against
* - `[0]` a {@linkcode Utils.BooleanHolder | BooleanHolder} used to flag if the move is protected against * @param attacker the attacking {@linkcode Pokemon}
* - `[1]` the attacking {@linkcode Pokemon} * @param defender the defending {@linkcode Pokemon}
* - `[2]` the defending {@linkcode Pokemon} * @param moveId the {@linkcode Moves | identifier} for the move being used
* - `[3]` the {@linkcode Moves | identifier} for the move being used * @param ignoresProtectBypass a {@linkcode Utils.BooleanHolder | BooleanHolder} used to flag if a protection effect supercedes effects that ignore protection
* - `[4]` a {@linkcode Utils.BooleanHolder | BooleanHolder} used to flag if a protection effect supercedes effects that ignore protection
* @returns `true` if this tag protected against the attack; `false` otherwise * @returns `true` if this tag protected against the attack; `false` otherwise
*/ */
override apply(arena: Arena, simulated: boolean, isProtected: Utils.BooleanHolder, attacker: Pokemon, defender: Pokemon, override apply(arena: Arena, simulated: boolean, isProtected: Utils.BooleanHolder, attacker: Pokemon, defender: Pokemon,
@ -619,6 +618,13 @@ export class ArenaTrapTag extends ArenaTag {
} }
} }
/**
* Activates the hazard effect onto a Pokemon when it enters the field
* @param arena the {@linkcode Arena} containing this tag
* @param simulated if `true`, only checks if the hazard would activate.
* @param pokemon the {@linkcode Pokemon} triggering this hazard
* @returns `true` if this hazard affects the given Pokemon; `false` otherwise.
*/
override apply(arena: Arena, simulated: boolean, pokemon: Pokemon): boolean { override apply(arena: Arena, simulated: boolean, pokemon: Pokemon): boolean {
if (this.sourceId === pokemon.id || (this.side === ArenaTagSide.PLAYER) !== pokemon.isPlayer()) { if (this.sourceId === pokemon.id || (this.side === ArenaTagSide.PLAYER) !== pokemon.isPlayer()) {
return false; return false;
@ -1145,6 +1151,14 @@ class WaterFirePledgeTag extends ArenaTag {
arena.scene.queueMessage(i18next.t(`arenaTag:waterFirePledgeOnAdd${this.side === ArenaTagSide.PLAYER ? "Player" : this.side === ArenaTagSide.ENEMY ? "Enemy" : ""}`)); arena.scene.queueMessage(i18next.t(`arenaTag:waterFirePledgeOnAdd${this.side === ArenaTagSide.PLAYER ? "Player" : this.side === ArenaTagSide.ENEMY ? "Enemy" : ""}`));
} }
/**
* Doubles the chance for the given move's secondary effect(s) to trigger
* @param arena the {@linkcode Arena} containing this tag
* @param simulated n/a
* @param moveChance a {@linkcode Utils.NumberHolder | NumberHolder} containing
* the move's current effect chance
* @returns `true` if the move's effect chance was doubled (currently always `true`)
*/
override apply(arena: Arena, simulated: boolean, moveChance: Utils.NumberHolder): boolean { override apply(arena: Arena, simulated: boolean, moveChance: Utils.NumberHolder): boolean {
moveChance.value *= 2; moveChance.value *= 2;
return true; return true;