mika/pokerogue
1
0
Fork 0
mirror of https://github.com/pagefaultgames/pokerogue.git synced 2025-08-10 01:19:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Bertie690 2025-07-11 13:36:08 +02:00 committed by GitHub
parent 64bb67842a
commit 99dfc1d973
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -891,15 +891,22 @@ class ToxicSpikesTag extends ArenaTrapTag {
* @see {@linkcode DelayedAttackTag} * @see {@linkcode DelayedAttackTag}
*/ */
interface DelayedAttack { interface DelayedAttack {
/** The {@linkcode PID | Pokemon.id} of the {@linkcode Pokemon} initiating the attack. */
sourceId: number; sourceId: number;
/** The {@linkcode MoveId} that was used to trigger the delayed attack. */
move: MoveId; move: MoveId;
/** The {@linkcode BattlerIndex} of the attack's target. */
targetIndex: BattlerIndex; targetIndex: BattlerIndex;
/**
* The number of turns left.
* The attack will trigger once its turn count reaches 0, at which point it is removed.
*/
turnCount: number; turnCount: number;
} }
/** /**
* Arena Tag to manage execution of delayed attacks, such as {@linkcode MoveId.FUTURE_SIGHT} or {@linkcode MoveId.DOOM_DESIRE}. * Arena Tag to manage execution of delayed attacks, such as {@linkcode MoveId.FUTURE_SIGHT} or {@linkcode MoveId.DOOM_DESIRE}.
* Delayed attacks do nothing for the first 3 turns after use (including the turn the move is used), * Delayed attacks do nothing for the first several turns after use (including the turn the move is used),
* dealing damage to the specified slot after the turn count has been elapsed. * dealing damage to the specified slot after the turn count has been elapsed.
*/ */
export class DelayedAttackTag extends ArenaTag { export class DelayedAttackTag extends ArenaTag {
@ -928,7 +935,8 @@ export class DelayedAttackTag extends ArenaTag {
/** /**
* Check whether a delayed attack can be queued against the given target. * Check whether a delayed attack can be queued against the given target.
* @param targetIndex - The {@linkcode BattlerIndex} of the target Pokemon. * @param targetIndex - The {@linkcode BattlerIndex} of the target Pokemon
* @returns Whether another delayed attack can be successfully added.
*/ */
public canAddAttack(targetIndex: BattlerIndex): boolean { public canAddAttack(targetIndex: BattlerIndex): boolean {
return this.delayedAttacks.every(atk => atk.targetIndex !== targetIndex); return this.delayedAttacks.every(atk => atk.targetIndex !== targetIndex);
@ -936,12 +944,12 @@ export class DelayedAttackTag extends ArenaTag {
/** /**
* Tick down all existing delayed attacks, activating them if their timers have elapsed. * Tick down all existing delayed attacks, activating them if their timers have elapsed.
* @returns `true` if at least 1 delayed attack has not been completed * @returns Whether this tag should remain (at least 1 delayed attack still active).
*/ */
override lapse(_arena: Arena): boolean { override lapse(_arena: Arena): boolean {
for (const attack of this.delayedAttacks) { for (const attack of this.delayedAttacks) {
const source = globalScene.getPokemonById(attack.sourceId); const source = globalScene.getPokemonById(attack.sourceId);
const target: Pokemon | null = globalScene.getField()[attack.targetIndex]; const target: Pokemon | undefined = globalScene.getField()[attack.targetIndex];
if (--attack.turnCount > 0) { if (--attack.turnCount > 0) {
// attack still cooking // attack still cooking
@ -976,7 +984,7 @@ export class DelayedAttackTag extends ArenaTag {
/** /**
* Remove all finished attacks from the current queue. * Remove all finished attacks from the current queue.
* @returns Whether at least 1 attack has not finished triggering * @returns Whether at least 1 attack has not finished triggering.
*/ */
removeDoneAttacks(): boolean { removeDoneAttacks(): boolean {
this.delayedAttacks = this.delayedAttacks.filter(a => a.turnCount > 0); this.delayedAttacks = this.delayedAttacks.filter(a => a.turnCount > 0);