Minor TSDoc improvement to BattleScene#getPlayerField

This commit is contained in:
NightKev 2025-06-23 00:06:43 -07:00
parent adb2ad8a4c
commit cde822e170
2 changed files with 2 additions and 2 deletions

View File

@ -800,7 +800,7 @@ export default class BattleScene extends SceneBase {
// TODO: Add `undefined` to return type // TODO: Add `undefined` to return type
/** /**
* Returns an array of PlayerPokemon of length 1 or 2 depending on if in a double battle or not. * Returns an array of PlayerPokemon of length 1 or 2 depending on if in a double battle or not.
* @param active - Whether to consider only active on-field pokemon ({@see {@linkcode Pokemon.isActiveZ} for more information}); default `false` * @param active - (Default `false`) Whether to consider only {@linkcode Pokemon.isActive | active} on-field pokemon
* @returns array of {@linkcode PlayerPokemon} * @returns array of {@linkcode PlayerPokemon}
*/ */
public getPlayerField(active = false): PlayerPokemon[] { public getPlayerField(active = false): PlayerPokemon[] {