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

chore: fix namings, types and docs

Browse Source 
suggested by @torranx
This commit is contained in:
flx-sta 2024-09-30 13:27:34 -07:00
parent 568959de54
commit 47350dcca2
2 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/battle-scene.ts
View File

@ -2785,11 +2785,11 @@ export default class BattleScene extends SceneBase {
/** /**
* Get all of the modifiers that pass the `modifierFilter` function * Get all of the modifiers that pass the `modifierFilter` function
* @param modifierFilter The function used to filter a target's modifiers * @param modifierFilter The function used to filter a target's modifiers
* @param player Whether to search the player (`true`) or the enemy (`false`); Defaults to `true` * @param isPlayer Whether to search the player (`true`) or the enemy (`false`); Defaults to `true`
* @returns the list of all modifiers that passed the `modifierFilter` function * @returns the list of all modifiers that passed the `modifierFilter` function
*/ */
findModifiers(modifierFilter: ModifierPredicate, player: boolean = true): PersistentModifier[] { findModifiers(modifierFilter: ModifierPredicate, isPlayer: boolean = true): PersistentModifier[] {
return (player ? this.modifiers : this.enemyModifiers).filter(modifierFilter); return (isPlayer ? this.modifiers : this.enemyModifiers).filter(modifierFilter);
} }
/** /**

17
src/modifier/modifier.ts
View File

@ -142,7 +142,7 @@ export abstract class Modifier {
} }
/** /**
* Checks if {@linkcode Modifier} should applied * Checks if {@linkcode Modifier} should be applied
* @param _args parameters passed to {@linkcode Modifier#apply} * @param _args parameters passed to {@linkcode Modifier#apply}
* @returns always `true` by default * @returns always `true` by default
*/ */
@ -485,7 +485,7 @@ export class TempStatStageBoosterModifier extends LapsingPersistentModifier {
* @param statLevel {@linkcode Utils.NumberHolder} that holds the resulting value of the stat stage multiplier * @param statLevel {@linkcode Utils.NumberHolder} that holds the resulting value of the stat stage multiplier
* @returns `true` if the modifier can be applied, false otherwise * @returns `true` if the modifier can be applied, false otherwise
*/ */
override shouldApply(tempBattleStat?: TempBattleStat, statLevel?: Utils.IntegerHolder): boolean { override shouldApply(tempBattleStat?: TempBattleStat, statLevel?: Utils.NumberHolder): boolean {
return !!tempBattleStat && !!statLevel && TEMP_BATTLE_STATS.includes(tempBattleStat) && (tempBattleStat === this.stat) && (statLevel instanceof Utils.NumberHolder); return !!tempBattleStat && !!statLevel && TEMP_BATTLE_STATS.includes(tempBattleStat) && (tempBattleStat === this.stat) && (statLevel instanceof Utils.NumberHolder);
} }
@ -494,7 +494,7 @@ export class TempStatStageBoosterModifier extends LapsingPersistentModifier {
* @param _tempBattleStat {@linkcode TempBattleStat} N/A * @param _tempBattleStat {@linkcode TempBattleStat} N/A
* @param statLevel {@linkcode Utils.NumberHolder} that holds the resulting value of the stat stage multiplier * @param statLevel {@linkcode Utils.NumberHolder} that holds the resulting value of the stat stage multiplier
*/ */
override apply(_tempBattleStat: TempBattleStat, statLevel: Utils.IntegerHolder): boolean { override apply(_tempBattleStat: TempBattleStat, statLevel: Utils.NumberHolder): boolean {
statLevel.value += this.boost; statLevel.value += this.boost;
return true; return true;
} }
@ -524,16 +524,16 @@ export class TempCritBoosterModifier extends LapsingPersistentModifier {
* @param critLevel {@linkcode Utils.NumberHolder} N/A * @param critLevel {@linkcode Utils.NumberHolder} N/A
* @returns `true` if the critical-hit stage boost applies successfully * @returns `true` if the critical-hit stage boost applies successfully
*/ */
override shouldApply(critLevel?: Utils.IntegerHolder): boolean { override shouldApply(critLevel?: Utils.NumberHolder): boolean {
return !!critLevel && (critLevel instanceof Utils.NumberHolder); return !!critLevel && (critLevel instanceof Utils.NumberHolder);
} }
/** /**
* Increases the current critical-hit stage value by 1. * Increases the current critical-hit stage value by 1.
* @param critLevel {@linkcode Utils.IntegerHolder} that holds the resulting critical-hit level * @param critLevel {@linkcode Utils.NumberHolder} that holds the resulting critical-hit level
* @returns `true` if the critical-hit stage boost applies successfully * @returns `true` if the critical-hit stage boost applies successfully
*/ */
override apply(critLevel: Utils.IntegerHolder): boolean { override apply(critLevel: Utils.NumberHolder): boolean {
critLevel.value++; critLevel.value++;
return true; return true;
} }
@ -566,11 +566,6 @@ export class MegaEvolutionAccessModifier extends PersistentModifier {
return new MegaEvolutionAccessModifier(this.type, this.stackCount); return new MegaEvolutionAccessModifier(this.type, this.stackCount);
} }
/**
* Apply {@linkcode MegaEvolutionAccessModifier}
* @param _args N/A
* @returns always `true`
*/
override apply(..._args: unknown[]): boolean { override apply(..._args: unknown[]): boolean {
return true; return true;
} }