Class TrainerConfig

constructor

• new TrainerConfig(trainerType, allowLegendaries?): TrainerConfig

• Parameters

  • trainerType: TrainerType
  • Optional allowLegendaries: boolean

  Returns TrainerConfig

battleBgm

defeatMessages

doubleDefeatMessages

doubleEncounterBgm

doubleEncounterMessages

doubleOnly

doubleVictoryMessages

encounterBgm

encounterMessages

femaleDefeatMessages

femaleEncounterBgm

femaleEncounterMessages

femaleVictoryMessages

genModifiersFunc

hasCharSprite

hasDouble

hasGenders

hasStaticParty

isBoss

mixedBattleBgm

modifierRewardFuncs

moneyMultiplier

name

nameDouble

nameFemale

partyMemberFuncs

partyTemplateFunc

partyTemplates

specialtyTypes

speciesFilter

speciesPools

title

titleDouble

trainerType

trainerTypeDouble

useSameSeedForAllMembers

victoryBgm

victoryMessages

getDerivedType

• getDerivedType(trainerTypeToDeriveFrom?): TrainerType

• Returns the derived trainer type for a given trainer type.

  Parameters

  • trainerTypeToDeriveFrom: TrainerType = null

    The trainer type to derive from. (If null, the this.trainerType property will be used.)

  Returns TrainerType

  • The derived trainer type.

getKey

• getKey(): string

• Returns string

getSpriteKey

• getSpriteKey(female?, isDouble?): string

• Parameters

  • Optional female: boolean
  • isDouble: boolean = false

  Returns string

getTitle

• getTitle(trainerSlot?, variant): string

• Retrieves the title for the trainer based on the provided trainer slot and variant.

  Parameters

  • trainerSlot: TrainerSlot = TrainerSlot.NONE

    The slot to determine which title to use. Defaults to TrainerSlot.NONE.
  • variant: TrainerVariant

    The variant of the trainer to determine the specific title.

  Returns string

  • The title of the trainer.

initForChampion

• initForChampion(signatureSpecies, isMale): TrainerConfig

• Initializes the trainer configuration for a Champion.

  Parameters

  • signatureSpecies: (Species | Species[])[]

    The signature species for the Champion.
  • isMale: boolean

    Whether the Champion is Male or Female (for localization of the title).

  Returns TrainerConfig

  • The updated TrainerConfig instance.

initForEliteFour

• initForEliteFour(signatureSpecies, isMale, ...specialtyTypes): TrainerConfig

• Initializes the trainer configuration for an Elite Four member.

  Parameters

  • signatureSpecies: (Species | Species[])[]

    The signature species for the Elite Four member.
  • isMale: boolean

    Whether the Elite Four Member is Male or Female (for localization of the title).
  • Rest ...specialtyTypes: Type[]

    The specialty types for the Elite Four member.

  Returns TrainerConfig

  • The updated TrainerConfig instance.

initForGymLeader

• initForGymLeader(signatureSpecies, isMale, ...specialtyTypes): TrainerConfig

• Initializes the trainer configuration for a Gym Leader.

  Parameters

  • signatureSpecies: (Species | Species[])[]

    The signature species for the Gym Leader.
  • isMale: boolean

    Whether the Gym Leader is Male or Not (for localization of the title).
  • Rest ...specialtyTypes: Type[]

    The specialty types for the Gym Leader.

  Returns TrainerConfig

  • The updated TrainerConfig instance.

loadAssets

• loadAssets(scene, variant): Promise<void>

• Parameters

  • scene: default
  • variant: TrainerVariant

  Returns Promise<void>

setBattleBgm

• setBattleBgm(battleBgm): TrainerConfig

• Parameters

  • battleBgm: string

  Returns TrainerConfig

setBoss

• setBoss(): TrainerConfig

• Returns TrainerConfig

setDoubleMessages

• setDoubleMessages(nameDouble): void

• Sets the encounter and victory messages for double trainers.

  Parameters

  • nameDouble: string

    The name of the pair (e.g. "red_blue_double").

  Returns void

setDoubleOnly

• setDoubleOnly(): TrainerConfig

• Returns TrainerConfig

setDoubleTitle

• setDoubleTitle(titleDouble): TrainerConfig

• Sets the title for double trainers

  Parameters

  • titleDouble: string

    the key for the title in the i18n file. (e.g., "champion_double").

  Returns TrainerConfig

  • The updated TrainerConfig instance.

setDoubleTrainerType

• setDoubleTrainerType(trainerTypeDouble): TrainerConfig

• Sets the trainer type for double battles.

  Parameters

  • trainerTypeDouble: TrainerType

    The TrainerType of the partner in a double battle.

  Returns TrainerConfig

  • The updated TrainerConfig instance.

setEncounterBgm

• setEncounterBgm(encounterBgm): TrainerConfig

• Parameters

  • encounterBgm: string | TrainerType

  Returns TrainerConfig

setGenModifiersFunc

• setGenModifiersFunc(genModifiersFunc): TrainerConfig

• Parameters

  • genModifiersFunc: GenModifiersFunc

  Returns TrainerConfig

setHasCharSprite

• setHasCharSprite(): TrainerConfig

• Returns TrainerConfig

setHasDouble

• setHasDouble(nameDouble, doubleEncounterBgm?): TrainerConfig

• Sets the configuration for trainers with double battles, including the name of the double trainer and the encounter BGM.

  Parameters

  • nameDouble: string

    The name of the double trainer (e.g., "Ace Duo" for Trainer Class Doubles or "red_blue_double" for NAMED trainer doubles).
  • Optional doubleEncounterBgm: string | TrainerType

    The encounter BGM for the double trainer, which can be a TrainerType or a string.

  Returns TrainerConfig

  • The updated TrainerConfig instance.

setHasGenders

• setHasGenders(nameFemale?, femaleEncounterBgm?): TrainerConfig

• Sets the configuration for trainers with genders, including the female name and encounter background music (BGM).

  Parameters

  • Optional nameFemale: string

    The name of the female trainer. If 'Ivy', a localized name will be assigned.
  • Optional femaleEncounterBgm: string | TrainerType

    The encounter BGM for the female trainer, which can be a TrainerType or a string.

  Returns TrainerConfig

  • The updated TrainerConfig instance.

setMixedBattleBgm

• setMixedBattleBgm(mixedBattleBgm): TrainerConfig

• Parameters

  • mixedBattleBgm: string

  Returns TrainerConfig

setModifierRewardFuncs

• setModifierRewardFuncs(...modifierTypeFuncs): TrainerConfig

• Parameters

  • Rest ...modifierTypeFuncs: (() => ModifierTypeFunc)[]

  Returns TrainerConfig

setMoneyMultiplier

• setMoneyMultiplier(moneyMultiplier): TrainerConfig

• Parameters

  • moneyMultiplier: number

  Returns TrainerConfig

setName

• setName(name): TrainerConfig

• Parameters

  • name: string

  Returns TrainerConfig

setPartyMemberFunc

• setPartyMemberFunc(slotIndex, partyMemberFunc): TrainerConfig

• Parameters

  • slotIndex: number
  • partyMemberFunc: PartyMemberFunc

  Returns TrainerConfig

setPartyTemplateFunc

• setPartyTemplateFunc(partyTemplateFunc): TrainerConfig

• Parameters

  • partyTemplateFunc: PartyTemplateFunc

  Returns TrainerConfig

setPartyTemplates

• setPartyTemplates(...partyTemplates): TrainerConfig

• Parameters

  • Rest ...partyTemplates: TrainerPartyTemplate[]

  Returns TrainerConfig

setSpecialtyTypes

• setSpecialtyTypes(...specialtyTypes): TrainerConfig

• Parameters

  • Rest ...specialtyTypes: Type[]

  Returns TrainerConfig

setSpeciesFilter

• setSpeciesFilter(speciesFilter, allowLegendaries?): TrainerConfig

• Parameters

  • speciesFilter: PokemonSpeciesFilter
  • Optional allowLegendaries: boolean

  Returns TrainerConfig

setSpeciesPools

• setSpeciesPools(speciesPools): TrainerConfig

• Parameters

  • speciesPools: Species[] | TrainerTierPools

  Returns TrainerConfig

setStaticParty

• setStaticParty(): TrainerConfig

• Returns TrainerConfig

setTitle

• setTitle(title): TrainerConfig

• Parameters

  • title: string

  Returns TrainerConfig

setUseSameSeedForAllMembers

• setUseSameSeedForAllMembers(): TrainerConfig

• Returns TrainerConfig

setVictoryBgm

• setVictoryBgm(victoryBgm): TrainerConfig

• Parameters

  • victoryBgm: string

  Returns TrainerConfig