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

Updated documentation in move.ts

Browse Source
This commit is contained in:
geeilhan 2024-12-01 23:02:15 +01:00 committed by GitHub
parent 810e143376
commit ef46644d57
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/data/move.ts
View File

@ -142,7 +142,7 @@ export default class Move implements Localizable {
public generation: number; public generation: number;
public attrs: MoveAttr[] = []; public attrs: MoveAttr[] = [];
private conditions: MoveCondition[] = []; private conditions: MoveCondition[] = [];
/** contains conditions if move is selectable and should fail or not */ /** contains conditions if move is selectable or not */
private selectableConditions: MoveSelectCondition[] = []; private selectableConditions: MoveSelectCondition[] = [];
/** The move's {@linkcode MoveFlags} */ /** The move's {@linkcode MoveFlags} */
private flags: number = 0; private flags: number = 0;
@ -377,9 +377,9 @@ export default class Move implements Localizable {
} }
/** /**
* Adds a {@linkcode MoveSelectCondition} to the move if it is only selectable/successful under certain conditions * Adds a {@linkcode MoveSelectCondition} to the move. It contains the condition if the move should be selectable in the move menu or not
* @param condition {@linkcode MoveSelectCondition} appends to conditions array a MoveSelectCondition {@linkcode selectableConditions} * @param condition {@linkcode MoveSelectCondition} gets pushed into {@linkcode selectableConditions}
* @returns the called object {@linkcode Move} * @returns this move {@linkcode Move}
*/ */
selectableCondition(condition: MoveSelectCondition): this { selectableCondition(condition: MoveSelectCondition): this {
if (condition) { if (condition) {
@ -683,7 +683,7 @@ export default class Move implements Localizable {
} }
/** /**
* Applies each {@linkcode MoveSelectCondition} function of this move to determine if the move can be used selected during {@linkcode CommandPhase} * Applies each {@linkcode MoveSelectCondition} function of this move to determine if the move can be selected during {@linkcode CommandPhase}
* @param user {@linkcode Pokemon} to apply conditions to * @param user {@linkcode Pokemon} to apply conditions to
* @returns boolean: false if any of the apply()'s return false, else true * @returns boolean: false if any of the apply()'s return false, else true
*/ */
@ -7617,8 +7617,7 @@ export function applyMoveChargeAttrs(attrType: Constructor<MoveAttr>, user: Poke
/** /**
* Base class defining all {@linkcode selectableConditions} * Base class defining all {@linkcode selectableConditions}
* Is used to add {@linkcode UserMoveConditionFunc} in order to check if condition * Is used to add {@linkcode UserMoveConditionFunc} in order to check if move can be selected
* is met and move can be selected/ if move fails
*/ */
export class MoveSelectCondition { export class MoveSelectCondition {
protected func: UserMoveConditionFunc; protected func: UserMoveConditionFunc;
@ -7639,13 +7638,10 @@ export class MoveSelectCondition {
} }
/** /**
* extends {@linkcode MoveSelectCondition} and contains the condition for {@link https://bulbapedia.bulbagarden.net/wiki/Stuff_Cheeks_(move) | Stuff Cheeks} * extends {@linkcode MoveSelectCondition} and contains the condition for
* success * {@link https://bulbapedia.bulbagarden.net/wiki/Stuff_Cheeks_(move) | Stuff Cheeks}s success
*/ */
export class StuffCheeksCondition extends MoveSelectCondition { export class StuffCheeksCondition extends MoveSelectCondition {
/**
* contains function that checks if the {@linkcode user} is currently holding a berry or not
*/
constructor() { constructor() {
super((user, move) => this.selectableCondition(user)); super((user, move) => this.selectableCondition(user));
} }