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

Improve jsdoc clarity

Browse Source
This commit is contained in:
Sirz Benjie 2025-02-06 21:26:28 -06:00
parent 519cdf3212
commit e61b3473e9
No known key found for this signature in database
GPG Key ID: 4A524B4D196C759E
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -623,6 +623,11 @@ export default class Move implements Localizable {
* calling this method for {@linkcode MoveFlags.MAKES_CONTACT | MAKES_CONTACT}
* will return `false` if the user has a {@linkcode Abilities.LONG_REACH} that is not being suppressed.
*
* **Note:** This method only checks if the move should have effectively have the flag applied to its use.
* It does *not* check whether the flag will trigger related effects.
* For example using this method to check {@linkcode MoveFlags.WIND_MOVE}
* will not consider {@linkcode Abilities.WIND_RIDER | Wind Rider }.
*
* To simply check whether the move has a flag, use {@linkcode hasFlag}.
* @param flag {@linkcode MoveFlags} MoveFlag to check on user and/or target
* @param user {@linkcode Pokemon} the Pokemon using the move