Validation
This module allows easy validation of common parameters across functions from Stats, such as Pokémon levels, Effort Values (EVs), Individual Values (IVs) etc.
Methods
isValidPokemonLevel
Returns true if given value is a valid Pokémon level.
Signature
isValidPokemonLevel(level: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
level | number | Yes | The Pokémon's level. |
Returns
A boolean.
Example
isValidPokemonLevel(0) // false
isValidPokemonLevel(100) // true
isValidPokemonLevel(101) // false
isValidBaseStat
Returns true if given value is a valid Pokémon base stat.
Signature
isValidBaseStat(baseStat: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
baseStat | number | Yes | The Base stat of Pokémon. |
Returns
A boolean.
Example
isValidBaseStat(0) // false
isValidBaseStat(100) // true
isValidIV
Returns true if given value is a valid Pokémon Individual Value (IV).
Signature
isValidIV(iv: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
iv | number | Yes | The Pokémon's IV. |
Returns
A boolean.
Example
isValidIV(0) // true
isValidIV(31) // true
isValidIV(32) // false
isValidEV
Returns true if given value is a valid Pokémon Effort Value (EV).
Signature
isValidEV(ev: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
ev | number | Yes | The Pokémon's EV. |
Returns
A boolean.
Example
isValidEV(0) // true
isValidEV(255) // true
isValidEV(256) // false
isValidTotalEVs
Returns true if given value is a valid sum of all Pokémon Effort Values (EV).
Signature
isValidTotalEVs(totalEvs: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
totalEvs | number | Yes | The sum of all Pokémon's EVs. |
Returns
A boolean.
Example
isValidTotalEVs(510) // true
isValidTotalEVs(511) // false
isValidIVPriorGen3
Returns true if given value is a valid Pokémon Individual Value (IV) prior Generation III games.
Signature
isValidIVPriorGen3(iv: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
iv | number | Yes | The Pokémon's IV. |
Returns
A boolean.
Example
isValidIVPriorGen3(0) // true
isValidIVPriorGen3(15) // true
isValidIVPriorGen3(16) // false
isValidEVPriorGen3
Returns true if given value is a valid Pokémon Effort Value (EV) prior Generation III games.
Signature
isValidEVPriorGen3(ev: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
ev | number | Yes | The Pokémon's IV. |
Returns
A boolean.
Example
isValidEVPriorGen3(0) // true
isValidEVPriorGen3(65535) // true
isValidEVPriorGen3(65536) // false
isValidEffortLevel
Returns true if given value is a valid Effort Level on Pokémon Legends Arceus game.
Signature
isValidEffortLevel(effortLevel: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
effortLevel | number | Yes | The Pokémon's Effort Level. |
Returns
A boolean.
Example
isValidEffortLevel(0) // true
isValidEffortLevel(10) // true
isValidEffortLevel(11) // false
isValidAV
Returns true if given value is a valid Pokémon Awakening Value (AV).
Signature
isValidAV(av: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
av | number | Yes | The Pokémon's AV. |
Returns
A boolean.
Example
isValidAV(0) // true
isValidAV(200) // true
isValidAV(201) // false
isValidTotalAVs
Returns true if given value is a valid sum of all Pokémon Awakening Values (AV).
Signature
isValidTotalAVs(totalAvs: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
totalAvs | number | Yes | The sum of all Pokémon's AVs. |
Returns
A boolean.
Example
isValidTotalAVs(0) // true
isValidTotalAVs(1200) // true
isValidTotalAVs(1201) // false
isValidFrienshipValue
Returns true if given value is a valid friendship value.
Signature
isValidFrienshipValue(friendship: number) => boolean
| Parameter | Type | Required | Description |
|---|---|---|---|
friendship | number | Yes | The Pokémon's friendship value. |
Returns
A boolean.
Example
isValidFrienshipValue(0) // true
isValidFrienshipValue(200) // true
isValidFrienshipValue(256) // false