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

Remove {} appearing after @param

Browse Source
This commit is contained in:
Sirz Benjie 2025-09-10 12:42:11 -05:00
parent 1eddf2fbd7
commit eecaaffd28
No known key found for this signature in database
GPG Key ID: 4A524B4D196C759E
17 changed files with 73 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/data/abilities/ability.ts
View File

@ -507,7 +507,7 @@ export class ClearWeatherAbAttr extends AbAttr {
private weather: WeatherType[];
/**
* @param weather {@linkcode WeatherType[]} - the weather to be removed
* @param weather - The weather to be removed
*/
constructor(weather: WeatherType[]) {
super(true);
@ -537,7 +537,7 @@ export class ClearTerrainAbAttr extends AbAttr {
private terrain: TerrainType[];
/**
* @param terrain {@linkcode TerrainType[]} - the terrain to be removed
* @param terrain - the terrain to be removed
*/
constructor(terrain: TerrainType[]) {
super(true);
@ -2613,7 +2613,7 @@ export class PostSummonRemoveArenaTagAbAttr extends PostSummonAbAttr {
private arenaTags: ArenaTagType[];
/**
* @param arenaTags {@linkcode ArenaTagType[]} - the arena tags to be removed
* @param arenaTags - The arena tags to be removed
*/
constructor(arenaTags: ArenaTagType[]) {
super(true);
@ -4241,7 +4241,7 @@ function getAnticipationCondition(): AbAttrCondition {
* Creates an ability condition that causes the ability to fail if that ability
* has already been used by that pokemon that battle. It requires an ability to
* be specified due to current limitations in how conditions on abilities work.
* @param {AbilityId} ability The ability to check if it's already been applied
* @param ability The ability to check if it's already been applied
* @returns The condition
*/
function getOncePerBattleCondition(ability: AbilityId): AbAttrCondition {

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

@ -1132,7 +1132,7 @@ class ImprisonTag extends EntryHazardTag {
/**
* This applies the effects of Imprison to any opposing Pokemon that switch into the field while the source Pokemon is still active
* @param {Pokemon} pokemon the Pokemon Imprison is applied to
* @param pokemon the Pokemon Imprison is applied to
* @returns `true`
*/
override activateTrap(pokemon: Pokemon): boolean {

2
src/data/battler-tags.ts
View File

@ -2561,7 +2561,7 @@ export class FormBlockDamageTag extends SerializableBattlerTag {
/**
* Applies the tag to the Pokémon.
* Triggers a form change if the Pokémon is not in its defense form.
* @param {Pokemon} pokemon The Pokémon to which the tag is added.
* @param pokemon The Pokémon to which the tag is added.
*/
onAdd(pokemon: Pokemon): void {
super.onAdd(pokemon);

50
src/data/moves/move.ts
View File

@ -4354,10 +4354,10 @@ const countPositiveStatStages = (pokemon: Pokemon): number => {
export class PositiveStatStagePowerAttr extends VariablePowerAttr {
/**
* @param {Pokemon} user The pokemon that is being used to calculate the amount of positive stats
* @param {Pokemon} target N/A
* @param {Move} move N/A
* @param {any[]} args The argument for VariablePowerAttr, accumulates and sets the amount of power multiplied by stats
* @param user The pokemon that is being used to calculate the amount of positive stats
* @param target N/A
* @param move N/A
* @param args The argument for VariablePowerAttr, accumulates and sets the amount of power multiplied by stats
* @returns Returns true if attribute is applied
*/
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
@ -4378,10 +4378,10 @@ export class PunishmentPowerAttr extends VariablePowerAttr {
private PUNISHMENT_MAX_BASE_POWER = 200;
/**
* @param {Pokemon} user N/A
* @param {Pokemon} target The pokemon that the move is being used against, as well as calculating the stats for the min/max base power
* @param {Move} move N/A
* @param {any[]} args The value that is being changed due to VariablePowerAttr
* @param user N/A
* @param target The pokemon that the move is being used against, as well as calculating the stats for the min/max base power
* @param move N/A
* @param args The value that is being changed due to VariablePowerAttr
* @returns Returns true if attribute is applied
*/
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
@ -5482,10 +5482,10 @@ export class SheerColdAccuracyAttr extends OneHitKOAccuracyAttr {
/**
* Changes the normal One Hit KO Accuracy Attr to implement the Gen VII changes,
* where if the user is Ice-Type, it has more accuracy.
* @param {Pokemon} user Pokemon that is using the move; checks the Pokemon's level.
* @param {Pokemon} target Pokemon that is receiving the move; checks the Pokemon's level.
* @param {Move} move N/A
* @param {any[]} args Uses the accuracy argument, allowing to change it from either 0 if it doesn't pass
* @param user Pokemon that is using the move; checks the Pokemon's level.
* @param target Pokemon that is receiving the move; checks the Pokemon's level.
* @param move N/A
* @param args Uses the accuracy argument, allowing to change it from either 0 if it doesn't pass
* the first if/else, or 30/20 depending on the type of the user Pokemon.
* @returns Returns true if move is successful, false if misses.
*/
@ -7438,10 +7438,10 @@ export class SketchAttr extends MoveEffectAttr {
}
/**
* User copies the opponent's last used move, if possible
* @param {Pokemon} user Pokemon that used the move and will replace Sketch with the copied move
* @param {Pokemon} target Pokemon that the user wants to copy a move from
* @param {Move} move Move being used
* @param {any[]} args Unused
* @param user Pokemon that used the move and will replace Sketch with the copied move
* @param target Pokemon that the user wants to copy a move from
* @param move Move being used
* @param args Unused
* @returns true if the function succeeds, otherwise false
*/
@ -7733,7 +7733,7 @@ export class ShiftStatAttr extends MoveEffectAttr {
/**
* Switches the user's stats based on the {@linkcode statToSwitch} and {@linkcode statToSwitchWith} attributes.
* @param {Pokemon} user the {@linkcode Pokemon} that used the move
* @param user the {@linkcode Pokemon} that used the move
* @param target n/a
* @param move n/a
* @param args n/a
@ -7761,7 +7761,7 @@ export class ShiftStatAttr extends MoveEffectAttr {
/**
* Encourages the user to use the move if the stat to switch with is greater than the stat to switch.
* @param {Pokemon} user the {@linkcode Pokemon} that used the move
* @param user the {@linkcode Pokemon} that used the move
* @param target n/a
* @param move n/a
* @returns number of points to add to the user's benefit score
@ -7838,7 +7838,7 @@ export class DestinyBondAttr extends MoveEffectAttr {
* @param user {@linkcode Pokemon} that is having the tag applied to.
* @param target {@linkcode Pokemon} N/A
* @param move {@linkcode Move} {@linkcode Move.DESTINY_BOND}
* @param {any[]} args N/A
* @param args N/A
* @returns true
*/
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
@ -7858,7 +7858,7 @@ export class AddBattlerTagIfBoostedAttr extends AddBattlerTagAttr {
* @param user {@linkcode Pokemon} using this move
* @param target {@linkcode Pokemon} target of this move
* @param move {@linkcode Move} being used
* @param {any[]} args N/A
* @param args N/A
* @returns true
*/
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
@ -7884,7 +7884,7 @@ export class StatusIfBoostedAttr extends MoveEffectAttr {
* @param user {@linkcode Pokemon} using this move
* @param target {@linkcode Pokemon} target of this move
* @param move {@linkcode Move} N/A
* @param {any[]} args N/A
* @param args N/A
* @returns true
*/
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {
@ -8144,10 +8144,10 @@ export class ResistLastMoveTypeAttr extends MoveEffectAttr {
/**
* User changes its type to a random type that resists the target's last used move
* @param {Pokemon} user Pokemon that used the move and will change types
* @param {Pokemon} target Opposing pokemon that recently used a move
* @param {Move} move Move being used
* @param {any[]} args Unused
* @param user Pokemon that used the move and will change types
* @param target Opposing pokemon that recently used a move
* @param move Move being used
* @param args Unused
* @returns true if the function succeeds
*/
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): boolean {

2
src/data/pokemon-forms/form-change-triggers.ts
View File

@ -289,7 +289,7 @@ export class SpeciesFormChangeRevertWeatherFormTrigger extends SpeciesFormChange
/**
* Checks if the Pokemon has the required ability and the weather is one that will revert
* the Pokemon to its original form or the weather or ability is suppressed
* @param {Pokemon} pokemon the pokemon that is trying to do the form change
* @param pokemon the pokemon that is trying to do the form change
* @returns `true` if the Pokemon will revert to its original form, `false` otherwise
*/
canChange(pokemon: Pokemon): boolean {

20
src/data/trainers/trainer-config.ts
View File

@ -274,8 +274,8 @@ export class TrainerConfig {
/**
* Sets the configuration for trainers with genders, including the female name and encounter background music (BGM).
* @param {string} [nameFemale] The name of the female trainer. If 'Ivy', a localized name will be assigned.
* @param {TrainerType | string} [femaleEncounterBgm] The encounter BGM for the female trainer, which can be a TrainerType or a string.
* @param [nameFemale] The name of the female trainer. If 'Ivy', a localized name will be assigned.
* @param [femaleEncounterBgm] The encounter BGM for the female trainer, which can be a TrainerType or a string.
* @returns The updated TrainerConfig instance.
*/
setHasGenders(nameFemale?: string, femaleEncounterBgm?: TrainerType | string): TrainerConfig {
@ -523,7 +523,7 @@ export class TrainerConfig {
* Initializes the trainer configuration for an evil team admin.
* @param title The title of the evil team admin.
* @param poolName The evil team the admin belongs to.
* @param {SpeciesId | SpeciesId[]} signatureSpecies The signature species for the evil team leader.
* @param signatureSpecies The signature species for the evil team leader.
* @param specialtyType The specialty Type of the admin, if they have one
* @returns The updated TrainerConfig instance.
*/
@ -590,8 +590,8 @@ export class TrainerConfig {
/**
* Initializes the trainer configuration for an evil team leader. Temporarily hardcoding evil leader teams though.
* @param {SpeciesId | SpeciesId[]} signatureSpecies The signature species for the evil team leader.
* @param {PokemonType} specialtyType The specialty type for the evil team Leader.
* @param signatureSpecies The signature species for the evil team leader.
* @param specialtyType The specialty type for the evil team Leader.
* @param boolean Whether or not this is the rematch fight
* @returns The updated TrainerConfig instance.
*/
@ -631,9 +631,9 @@ export class TrainerConfig {
/**
* Initializes the trainer configuration for a Gym Leader.
* @param {SpeciesId | SpeciesId[]} signatureSpecies The signature species for the Gym Leader. Added to party in reverse order.
* @param signatureSpecies The signature species for the Gym Leader. Added to party in reverse order.
* @param isMale Whether the Gym Leader is Male or Not (for localization of the title).
* @param {PokemonType} specialtyType The specialty type for the Gym Leader.
* @param specialtyType The specialty type for the Gym Leader.
* @param ignoreMinTeraWave Whether the Gym Leader always uses Tera (true), or only Teras after {@linkcode GYM_LEADER_TERA_WAVE} (false). Defaults to false.
* @param teraSlot Optional, sets the party member in this slot to Terastallize. Wraps based on party size.
* @returns The updated TrainerConfig instance.
@ -748,7 +748,7 @@ export class TrainerConfig {
/**
* Initializes the trainer configuration for a Champion.
* @param {SpeciesId | SpeciesId[]} signatureSpecies The signature species for the Champion.
* @param signatureSpecies The signature species for the Champion.
* @param isMale Whether the Champion is Male or Female (for localization of the title).
* @returns The updated TrainerConfig instance.
*/
@ -798,8 +798,8 @@ export class TrainerConfig {
/**
* Retrieves the title for the trainer based on the provided trainer slot and variant.
* @param {TrainerSlot} trainerSlot - The slot to determine which title to use. Defaults to TrainerSlot.NONE.
* @param {TrainerVariant} variant - The variant of the trainer to determine the specific title.
* @param trainerSlot - The slot to determine which title to use. Defaults to TrainerSlot.NONE.
* @param variant - The variant of the trainer to determine the specific title.
* @returns - The title of the trainer.
*/
getTitle(trainerSlot: TrainerSlot = TrainerSlot.NONE, variant: TrainerVariant): string {

12
src/field/pokemon.ts
View File

@ -2647,10 +2647,10 @@ export abstract class Pokemon extends Phaser.GameObjects.Container {
/**
* Gets all level up moves in a given range for a particular pokemon.
* @param {number} startingLevel Don't include moves below this level
* @param {boolean} includeEvolutionMoves Whether to include evolution moves
* @param {boolean} simulateEvolutionChain Whether to include moves from prior evolutions
* @param {boolean} includeRelearnerMoves Whether to include moves that would require a relearner. Note the move relearner inherently allows evolution moves
* @param startingLevel Don't include moves below this level
* @param includeEvolutionMoves Whether to include evolution moves
* @param simulateEvolutionChain Whether to include moves from prior evolutions
* @param includeRelearnerMoves Whether to include moves that would require a relearner. Note the move relearner inherently allows evolution moves
* @returns A list of moves and the levels they can be learned at
*/
getLevelMoves(
@ -3552,8 +3552,8 @@ export abstract class Pokemon extends Phaser.GameObjects.Container {
* This method considers various factors such as the user's accuracy level, the target's evasion level,
* abilities, and modifiers to compute the final accuracy multiplier.
*
* @param target {@linkcode Pokemon} - The target Pokémon against which the move is used.
* @param sourceMove {@linkcode Move} - The move being used by the user.
* @param target - The target Pokémon against which the move is used.
* @param sourceMove - The move being used by the user.
* @returns The calculated accuracy multiplier.
*/
getAccuracyMultiplier(target: Pokemon, sourceMove: Move): number {

4
src/game-mode.ts
View File

@ -315,7 +315,7 @@ export class GameMode implements GameModeConfig {
/**
* Checks whether there is a fixed battle on this gamemode on a given wave.
* @param {number} waveIndex The wave to check.
* @param waveIndex The wave to check.
* @returns If this game mode has a fixed battle on this wave
*/
isFixedBattle(waveIndex: number): boolean {
@ -328,7 +328,7 @@ export class GameMode implements GameModeConfig {
/**
* Returns the config for the fixed battle for a particular wave.
* @param {number} waveIndex The wave to check.
* @param waveIndex The wave to check.
* @returns The fixed battle for this wave.
*/
getFixedBattle(waveIndex: number): FixedBattleConfig {

2
src/messages.ts
View File

@ -6,7 +6,7 @@ import i18next from "i18next";
/**
* Retrieves the Pokemon's name, potentially with an affix indicating its role (wild or foe) in the current battle context, translated
* @param pokemon {@linkcode Pokemon} name and battle context will be retrieved from this instance
* @param {boolean} useIllusion - Whether we want the name of the illusion or not. Default value : true
* @param useIllusion - Whether we want the name of the illusion or not. Default value : true
* @returns ex: "Wild Gengar", "Ectoplasma sauvage"
*/
export function getPokemonNameWithAffix(pokemon: Pokemon | undefined, useIllusion = true): string {

15
src/modifier/modifier.ts
View File

@ -73,8 +73,8 @@ export class ModifierBar extends Phaser.GameObjects.Container {
/**
* Method to update content displayed in {@linkcode ModifierBar}
* @param {PersistentModifier[]} modifiers - The list of modifiers to be displayed in the {@linkcode ModifierBar}
* @param {boolean} hideHeldItems - If set to "true", only modifiers not assigned to a Pokémon are displayed
* @param modifiers - The list of modifiers to be displayed in the {@linkcode ModifierBar}
* @param hideHeldItems - If set to "true", only modifiers not assigned to a Pokémon are displayed
*/
updateModifiers(modifiers: PersistentModifier[], hideHeldItems = false) {
this.removeAll(true);
@ -1201,13 +1201,16 @@ export class EvolutionStatBoosterModifier extends StatBoosterModifier {
/**
* Boosts the incoming stat value by a {@linkcode EvolutionStatBoosterModifier.multiplier} if the holder
* can evolve. Note that, if the holder is a fusion, they will receive
* can evolve
*
* @remarks
* Note that, if the holder is a fusion, they will receive
* only half of the boost if either of the fused members are fully
* evolved. However, if they are both unevolved, the full boost
* will apply.
* @param pokemon {@linkcode Pokemon} that holds the item
* @param _stat {@linkcode Stat} The {@linkcode Stat} to be boosted
* @param statValue{@linkcode NumberHolder} that holds the resulting value of the stat
* @param pokemon - The `Pokemon` holding the item
* @param _stat - The `Stat` to be boosted
* @param statValue - Holds the resulting value of the stat
* @returns `true` if the stat boost applies successfully, false otherwise
* @see shouldApply
*/

2
src/touch-controls.ts
View File

@ -143,7 +143,7 @@ export class TouchControl {
* {@link https://stackoverflow.com/a/39778831/4622620|Source}
*
* Prevent zoom on specified element
* @param {HTMLElement} element
* @param element
*/
preventElementZoom(element: HTMLElement | null): void {
if (!element) {

4
src/ui/containers/bgm-bar.ts
View File

@ -53,7 +53,7 @@ export class BgmBar extends Phaser.GameObjects.Container {
/*
* Set the BGM Name to the BGM bar.
* @param {string} bgmName The name of the BGM to set.
* @param bgmName The name of the BGM to set.
*/
setBgmToBgmBar(bgmName: string): void {
this.musicText.setText(`${i18next.t("bgmName:music")}${this.getRealBgmName(bgmName)}`);
@ -71,7 +71,7 @@ export class BgmBar extends Phaser.GameObjects.Container {
/*
Show or hide the BGM bar.
@param {boolean} visible Whether to show or hide the BGM bar.
@param visible Whether to show or hide the BGM bar.
*/
public toggleBgmBar(visible: boolean): void {
/*

6
src/ui/containers/daily-run-scoreboard.ts
View File

@ -202,8 +202,8 @@ export class DailyRunScoreboard extends Phaser.GameObjects.Container {
* The method fetches the total page count if necessary, followed by fetching the rankings for the specified category
* and page. It updates the UI with the fetched rankings or shows an appropriate message if no rankings are found.
*
* @param {ScoreboardCategory} [category=this.category] - The category to fetch rankings for. Defaults to the current category.
* @param {number} [page=this.page] - The page number to fetch. Defaults to the current page.
* @param [category=this.category] - The category to fetch rankings for. Defaults to the current category.
* @param [page=this.page] - The page number to fetch. Defaults to the current page.
*/
update(category: ScoreboardCategory = this.category, page: number = this.page) {
if (this.isUpdating) {
@ -249,7 +249,7 @@ export class DailyRunScoreboard extends Phaser.GameObjects.Container {
/**
* Sets the state of the navigation buttons.
* @param {boolean} [enabled=true] - Whether the buttons should be enabled or disabled.
* @param [enabled=true] - Whether the buttons should be enabled or disabled.
*/
setButtonsState(enabled = true) {
const buttons = [

6
src/utils/common.ts
View File

@ -135,7 +135,7 @@ export function randSeedItem<T>(items: T[]): T {
/**
* Shuffle a list using the seeded rng. Utilises the Fisher-Yates algorithm.
* @param {Array} items An array of items.
* @param items An array of items.
* @returns A new shuffled array of items.
*/
export function randSeedShuffle<T>(items: T[]): T[] {
@ -340,8 +340,8 @@ export function rgbToHsv(r: number, g: number, b: number) {
/**
* Compare color difference in RGB
* @param {Array} rgb1 First RGB color in array
* @param {Array} rgb2 Second RGB color in array
* @param rgb1 First RGB color in array
* @param rgb2 Second RGB color in array
*/
export function deltaRgb(rgb1: number[], rgb2: number[]): number {
const [r1, g1, b1] = rgb1;

4
test/abilities/flower-gift.test.ts
View File

@ -18,8 +18,8 @@ describe("Abilities - Flower Gift", () => {
/**
* Tests reverting to normal form when Cloud Nine/Air Lock is active on the field
* @param {GameManager} game The game manager instance
* @param {AbilityId} ability The ability that is active on the field
* @param game The game manager instance
* @param ability The ability that is active on the field
*/
const testRevertFormAgainstAbility = async (game: GameManager, ability: AbilityId) => {
game.override.starterForms({ [SpeciesId.CASTFORM]: SUNSHINE_FORM }).enemyAbility(ability);

2
test/abilities/gulp-missile.test.ts
View File

@ -21,7 +21,7 @@ describe("Abilities - Gulp Missile", () => {
/**
* Gets the effect damage of Gulp Missile
* See Gulp Missile {@link https://bulbapedia.bulbagarden.net/wiki/Gulp_Missile_(Ability)}
* @param {Pokemon} pokemon The pokemon taking the effect damage.
* @param pokemon The pokemon taking the effect damage.
* @returns The effect damage of Gulp Missile
*/
const getEffectDamage = (pokemon: Pokemon): number => {

2
test/moves/flame-burst.test.ts
View File

@ -16,7 +16,7 @@ describe("Moves - Flame Burst", () => {
* Calculates the effect damage of Flame Burst which is 1/16 of the target ally's max HP
* See Flame Burst {@link https://bulbapedia.bulbagarden.net/wiki/Flame_Burst_(move)}
* See Flame Burst's move attribute {@linkcode FlameBurstAttr}
* @param pokemon {@linkcode Pokemon} - The ally of the move's target
* @param pokemon - The ally of the move's target
* @returns Effect damage of Flame Burst
*/
const getEffectDamage = (pokemon: Pokemon): number => {