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

adjusted descriptions according to guideline

Browse Source
This commit is contained in:
Frederico Santos 2024-05-15 09:49:44 +01:00
parent 29824eea19
commit 4b055cd793
2 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/data/move.ts
View File

@ -1844,16 +1844,18 @@ export class HpSplitAttr extends MoveEffectAttr {
/** /**
* Attribute used for moves which split the user and the target's offensive raw stats. * Attribute used for moves which split the user and the target's offensive raw stats.
* This attribute is used for the move Power Split. * @extends MoveEffectAttr
* @see {@link apply}
*/ */
export class PowerSplitAttr extends MoveEffectAttr { export class PowerSplitAttr extends MoveEffectAttr {
/** /**
* Applying Power Split to the user and the target. * Applying Power Split to the user and the target.
* @param {Pokemon} user The pokemon using the move. * @param user The pokemon using the move. {@link Pokemon}
* @param {Pokemon} target The targeted pokemon of the move. * @param target The targeted pokemon of the move. {@link Pokemon}
* @param {Move} move The move used. * @param move The move used. {@link Move}
* @param {any} args N/A * @param args N/A
* @returns {boolean} True if power split is applied successfully. * @returns True if power split is applied successfully.
*/ */
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]) : Promise<boolean> { apply(user: Pokemon, target: Pokemon, move: Move, args: any[]) : Promise<boolean> {
return new Promise(resolve => { return new Promise(resolve => {
@ -1882,16 +1884,17 @@ export class PowerSplitAttr extends MoveEffectAttr {
/** /**
* Attribute used for moves which split the user and the target's defensive raw stats. * Attribute used for moves which split the user and the target's defensive raw stats.
* This attribute is used for the move Guard Split. * @extends MoveEffectAttr
* @see {@link apply}
*/ */
export class GuardSplitAttr extends MoveEffectAttr { export class GuardSplitAttr extends MoveEffectAttr {
/** /**
* Applying Guard Split to the user and the target. * Applying Guard Split to the user and the target.
* @param {Pokemon} user The pokemon using the move. * @param user The pokemon using the move. {@link Pokemon}
* @param {Pokemon} target The targeted pokemon of the move. * @param target The targeted pokemon of the move. {@link Pokemon}
* @param {Move} move The move used. * @param move The move used. {@link Move}
* @param {any} args N/A * @param args N/A
* @returns {boolean} True if power split is applied successfully. * @returns True if power split is applied successfully.
*/ */
apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): Promise<boolean> { apply(user: Pokemon, target: Pokemon, move: Move, args: any[]): Promise<boolean> {
return new Promise(resolve => { return new Promise(resolve => {

7
src/field/pokemon.ts
View File

@ -547,7 +547,7 @@ export default abstract class Pokemon extends Phaser.GameObjects.Container {
/** /**
* Returns the value of the specified stat. * Returns the value of the specified stat.
* @param stat Stat to get the value of. {@link Stat} * @param stat Stat to get the value of. {@link Stat}
* @returns The value of the stat. If the pokemon is already summoned, it uses those values, otherwise uses the base stats. {@link integer} * @returns The value of the stat. If the pokemon is already summoned, it uses those values, otherwise uses the base stats.
*/ */
getStat(stat: Stat): integer { getStat(stat: Stat): integer {
if (!this.summonData) { if (!this.summonData) {
@ -1713,9 +1713,10 @@ export default abstract class Pokemon extends Phaser.GameObjects.Container {
} }
/** /**
* Sets a specific stat to a specific value. Used for summon data, while the pokemon is out until the next time it is retrieved. * Sets a specific stat to a specific value.
* Used for summon data, while the pokemon is out until the next time it is retrieved.
* @param stat Stat to change. {@link Stat} * @param stat Stat to change. {@link Stat}
* @param value Amount to set the stat to. {@link integer} * @param value Amount to set the stat to.
*/ */
changeSummonStat(stat: Stat, value: integer) : void { changeSummonStat(stat: Stat, value: integer) : void {
this.summonData.stats[stat] = value; this.summonData.stats[stat] = value;