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

Add intellisense comments

Browse Source
This commit is contained in:
Xavion3 2024-05-07 10:05:01 +10:00
parent 40207fdbe8
commit f00ff67cc0
2 changed files with 67 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
src/data/battler-tags.ts
View File

@ -69,6 +69,11 @@ export class BattlerTag {
: null; : null;
} }
/**
* When given a battler tag or json representing one, load the data for it.
* This is meant to be inherited from by any battler tag with custom attributes
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
this.turnCount = source.turnCount; this.turnCount = source.turnCount;
this.sourceMove = source.sourceMove; this.sourceMove = source.sourceMove;
@ -305,6 +310,10 @@ export class SeedTag extends BattlerTag {
super(BattlerTagType.SEEDED, BattlerTagLapseType.TURN_END, 1, Moves.LEECH_SEED, sourceId); super(BattlerTagType.SEEDED, BattlerTagLapseType.TURN_END, 1, Moves.LEECH_SEED, sourceId);
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.sourceIndex = source.sourceIndex; this.sourceIndex = source.sourceIndex;
@ -415,6 +424,10 @@ export class EncoreTag extends BattlerTag {
super(BattlerTagType.ENCORE, BattlerTagLapseType.AFTER_MOVE, 3, Moves.ENCORE, sourceId); super(BattlerTagType.ENCORE, BattlerTagLapseType.AFTER_MOVE, 3, Moves.ENCORE, sourceId);
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.moveId = source.moveId as Moves; this.moveId = source.moveId as Moves;
@ -569,6 +582,10 @@ export abstract class DamagingTrapTag extends TrappedTag {
this.commonAnim = commonAnim; this.commonAnim = commonAnim;
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.commonAnim = source.commonAnim as CommonAnim; this.commonAnim = source.commonAnim as CommonAnim;
@ -730,6 +747,10 @@ export class ContactDamageProtectedTag extends ProtectedTag {
this.damageRatio = damageRatio; this.damageRatio = damageRatio;
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.damageRatio = source.damageRatio; this.damageRatio = source.damageRatio;
@ -761,6 +782,10 @@ export class ContactStatChangeProtectedTag extends ProtectedTag {
this.levels = levels; this.levels = levels;
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.stat = source.stat as BattleStat; this.stat = source.stat as BattleStat;
@ -888,6 +913,10 @@ export class AbilityBattlerTag extends BattlerTag {
this.ability = ability; this.ability = ability;
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.ability = source.ability as Abilities; this.ability = source.ability as Abilities;
@ -949,6 +978,10 @@ export class HighestStatBoostTag extends AbilityBattlerTag {
super(tagType, ability, BattlerTagLapseType.CUSTOM, 1); super(tagType, ability, BattlerTagLapseType.CUSTOM, 1);
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.stat = source.stat as Stat; this.stat = source.stat as Stat;
@ -997,6 +1030,10 @@ export class WeatherHighestStatBoostTag extends HighestStatBoostTag implements W
this.weatherTypes = weatherTypes; this.weatherTypes = weatherTypes;
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.weatherTypes = source.weatherTypes.map(w => w as WeatherType); this.weatherTypes = source.weatherTypes.map(w => w as WeatherType);
@ -1011,6 +1048,10 @@ export class TerrainHighestStatBoostTag extends HighestStatBoostTag implements T
this.terrainTypes = terrainTypes; this.terrainTypes = terrainTypes;
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.terrainTypes = source.terrainTypes.map(w => w as TerrainType); this.terrainTypes = source.terrainTypes.map(w => w as TerrainType);
@ -1043,6 +1084,10 @@ export class TypeImmuneTag extends BattlerTag {
super(tagType, BattlerTagLapseType.TURN_END, 1, sourceMove); super(tagType, BattlerTagLapseType.TURN_END, 1, sourceMove);
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.immuneType = source.immuneType as Type; this.immuneType = source.immuneType as Type;
@ -1068,6 +1113,10 @@ export class TypeBoostTag extends BattlerTag {
this.oneUse = oneUse; this.oneUse = oneUse;
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.boostedType = source.boostedType as Type; this.boostedType = source.boostedType as Type;
@ -1121,6 +1170,10 @@ export class SaltCuredTag extends BattlerTag {
super(BattlerTagType.SALT_CURED, BattlerTagLapseType.TURN_END, 1, Moves.SALT_CURE, sourceId); super(BattlerTagType.SALT_CURED, BattlerTagLapseType.TURN_END, 1, Moves.SALT_CURE, sourceId);
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.sourceIndex = source.sourceIndex; this.sourceIndex = source.sourceIndex;
@ -1161,6 +1214,10 @@ export class CursedTag extends BattlerTag {
super(BattlerTagType.CURSED, BattlerTagLapseType.TURN_END, 1, Moves.CURSE, sourceId); super(BattlerTagType.CURSED, BattlerTagLapseType.TURN_END, 1, Moves.CURSE, sourceId);
} }
/**
* When given a battler tag or json representing one, load the data for it.
* @param {BattlerTag | any} source A battler tag
*/
loadTag(source: BattlerTag | any): void { loadTag(source: BattlerTag | any): void {
super.loadTag(source); super.loadTag(source);
this.sourceIndex = source.sourceIndex; this.sourceIndex = source.sourceIndex;
@ -1307,6 +1364,11 @@ export function getBattlerTag(tagType: BattlerTagType, turnCount: integer, sourc
} }
} }
/**
* When given a battler tag or json representing one, creates an actual BattlerTag object with the same data.
* @param {BattlerTag | any} source A battler tag
* @return {BattlerTag} The valid battler tag
*/
export function loadBattlerTag(source: BattlerTag | any): BattlerTag { export function loadBattlerTag(source: BattlerTag | any): BattlerTag {
const tag = getBattlerTag(source.tagType, source.turnCount, source.sourceMove, source.sourceId); const tag = getBattlerTag(source.tagType, source.turnCount, source.sourceMove, source.sourceId);
tag.loadTag(source); tag.loadTag(source);

5
src/field/pokemon.ts
View File

@ -3187,6 +3187,11 @@ export class PokemonMove {
return this.getMove().name; return this.getMove().name;
} }
/**
* Copies an existing move or creates a valid PokemonMove object from json representing one
* @param {PokemonMove | any} source The data for the move to copy
* @return {PokemonMove} A valid pokemonmove object
*/
static loadMove(source: PokemonMove | any): PokemonMove { static loadMove(source: PokemonMove | any): PokemonMove {
return new PokemonMove(source.moveId, source.ppUsed, source.ppUp, source.virtual); return new PokemonMove(source.moveId, source.ppUsed, source.ppUp, source.virtual);
} }