A basic abstract class to act as a holder and processor for UI elements.

Hierarchy (view full)

Constructors

Properties

abilityCursor abilityIconElement abilityLabel active assetLoadCancelled awaitingActionInput blockInput canAddParty canCycleAbility canCycleForm canCycleGender canCycleNature canCycleShiny canCycleVariant candyUpgradeIcon candyUpgradeOverlayIcon classicWinIcons cursor cursorObj dexAttrCursor formIconElement formLabel genCursor genCursorHighlightObj genCursorObj genMode genOptionsText genScrollCursor genSpecies genderIconElement genderLabel hiddenAbilityIcons iconAnimHandler instructionRowTextOffset instructionRowX instructionRowY instructionsContainer lastSpecies message mode moveInfoOverlay natureCursor natureIconElement natureLabel onActionInput pendingPrompt pokemonAbilityLabelText pokemonAbilityText pokemonAdditionalMoveCountLabel pokemonCandyCountText pokemonCandyDarknessOverlay pokemonCandyIcon pokemonCandyOverlayIcon pokemonCaughtCountText pokemonCaughtHatchedContainer pokemonEggMoveBgs pokemonEggMoveContainers pokemonEggMoveLabels pokemonEggMovesContainer pokemonFormText pokemonGenderText pokemonGrowthRateLabelText pokemonGrowthRateText pokemonHatchedCountText pokemonHatchedIcon pokemonLuckLabelText pokemonLuckText pokemonMoveBgs pokemonMoveContainers pokemonMoveLabels pokemonMovesContainer pokemonNameText pokemonNatureLabelText pokemonNatureText pokemonNumberText pokemonPassiveLabelText pokemonPassiveText pokemonShinyIcon pokemonSprite pokemonUncaughtText pokerusCursorObjs pokerusCursors pokerusGens prompt scene shinyIconElement shinyIcons shinyLabel shinyOverlay speciesLoaded speciesStarterDexEntry speciesStarterMoves startCursorObj starterAbilityIndexes starterAttr starterCursorObjs starterCursors starterGens starterIcons starterMoveset starterMovesets starterNatures starterPreferences starterSelectCallback starterSelectContainer starterSelectGenIconContainers starterSelectMessageBox starterSelectMessageBoxContainer starterValueLabels statsContainer statsMode textCallbackTimer textTimer tutorialActive type1Icon type2Icon value valueLimitLabel variantIconElement variantLabel

Methods

Constructors

Properties

abilityCursor: number = -1
abilityIconElement: Sprite
abilityLabel: Text
active: boolean = false
assetLoadCancelled: BooleanHolder
awaitingActionInput: boolean
blockInput: boolean = false
canAddParty: boolean
canCycleAbility: boolean
canCycleForm: boolean
canCycleGender: boolean
canCycleNature: boolean
canCycleShiny: boolean
canCycleVariant: boolean
candyUpgradeIcon: Image[]
candyUpgradeOverlayIcon: Image[]
classicWinIcons: Image[]
cursor: number = 0
cursorObj: Image
dexAttrCursor: bigint = ...
formIconElement: Sprite
formLabel: Text
genCursor: number = 0
genCursorHighlightObj: Image
genCursorObj: Image
genMode: boolean
genOptionsText: Text
genScrollCursor: number = 0
genSpecies: default[][] = []
genderIconElement: Sprite
genderLabel: Text
hiddenAbilityIcons: Image[]
iconAnimHandler: default
instructionRowTextOffset: number = 12
instructionRowX: number = 0
instructionRowY: number = 0
instructionsContainer: Container
lastSpecies: default
message: Text
mode: number
moveInfoOverlay: default
natureCursor: number = -1
natureIconElement: Sprite
natureLabel: Text
onActionInput: Function
pendingPrompt: boolean
pokemonAbilityLabelText: Text
pokemonAbilityText: Text
pokemonAdditionalMoveCountLabel: Text
pokemonCandyCountText: Text
pokemonCandyDarknessOverlay: Sprite
pokemonCandyIcon: Sprite
pokemonCandyOverlayIcon: Sprite
pokemonCaughtCountText: Text
pokemonCaughtHatchedContainer: Container
pokemonEggMoveBgs: NineSlice[]
pokemonEggMoveContainers: Container[]
pokemonEggMoveLabels: Text[]
pokemonEggMovesContainer: Container
pokemonFormText: Text
pokemonGenderText: Text
pokemonGrowthRateLabelText: Text
pokemonGrowthRateText: Text
pokemonHatchedCountText: Text
pokemonHatchedIcon: Sprite
pokemonLuckLabelText: Text
pokemonLuckText: Text
pokemonMoveBgs: NineSlice[]
pokemonMoveContainers: Container[]
pokemonMoveLabels: Text[]
pokemonMovesContainer: Container
pokemonNameText: Text
pokemonNatureLabelText: Text
pokemonNatureText: BBCodeText
pokemonNumberText: Text
pokemonPassiveLabelText: Text
pokemonPassiveText: Text
pokemonShinyIcon: Sprite
pokemonSprite: Sprite
pokemonUncaughtText: Text
pokerusCursorObjs: Image[]
pokerusCursors: number[] = []
pokerusGens: number[] = []
prompt: Sprite
scene: default
shinyIconElement: Sprite
shinyIcons: Image[][]
shinyLabel: Text
shinyOverlay: Image
speciesLoaded: Map<Species, boolean> = ...
speciesStarterDexEntry: DexEntry
speciesStarterMoves: Moves[]
startCursorObj: NineSlice
starterAbilityIndexes: number[] = []
starterAttr: bigint[] = []
starterCursorObjs: Image[]
starterCursors: number[] = []
starterGens: number[] = []
starterIcons: Sprite[]
starterMoveset: StarterMoveset
starterMovesets: StarterMoveset[] = []
starterNatures: Nature[] = []
starterPreferences: StarterPreferences
starterSelectCallback: StarterSelectCallback
starterSelectContainer: Container
starterSelectGenIconContainers: Container[]
starterSelectMessageBox: NineSlice
starterSelectMessageBoxContainer: Container
starterValueLabels: Text[]
statsContainer: StatsContainer
statsMode: boolean
textCallbackTimer: TimerEvent
textTimer: TimerEvent
tutorialActive: boolean = false
type1Icon: Sprite
type2Icon: Sprite
value: number = 0
valueLimitLabel: Text
variantIconElement: Sprite
variantLabel: Text

Methods

  • Determines if a passive upgrade is available for the given species ID

    Parameters

    • speciesId: number

      The ID of the species to check the passive of

    Returns boolean

    true if the user has enough candies and a passive has not been unlocked already

  • Determines if an same species egg can be baught for the given species ID

    Parameters

    • speciesId: number

      The ID of the species to check the value reduction of

    Returns boolean

    true if the user has enough candies

  • Determines if 'Animation' based upgrade notifications should be shown

    Returns boolean

    true if upgrade notifications are enabled and set to display an 'Animation'

  • Determines if 'Icon' based upgrade notifications should be shown

    Returns boolean

    true if upgrade notifications are enabled and set to display an 'Icon'

  • Determines if a value reduction upgrade is available for the given species ID

    Parameters

    • speciesId: number

      The ID of the species to check the value reduction of

    Returns boolean

    true if the user has enough candies and all value reductions have not been unlocked already

  • Parameters

    • species: default
    • shiny: boolean
    • formIndex: number
    • female: boolean
    • variant: Variant
    • abilityIndex: number
    • natureIndex: number
    • forSeen: boolean = false

    Returns void

  • Sets a bounce animation if enabled and the Pokemon has an upgrade

    Parameters

    • icon: Sprite

      Phaser.GameObjects.GameObject to animate

    • species: default

      PokemonSpecies of the icon used to check for upgrades

    • startPaused: boolean = false

      Should this animation be paused after it is added?

    Returns void

  • Sets the visibility of a Candy Upgrade Icon given an index

    Parameters

    • index: number

      The UI index of the icon within this generation container

    Returns void

  • Parameters

    • text: string
    • name: string
    • Optional delay: number
    • Optional callback: Function
    • Optional callbackDelay: number
    • Optional prompt: boolean
    • Optional promptDelay: number

    Returns void

  • Parameters

    • text: string
    • Optional delay: number
    • Optional callback: Function
    • Optional callbackDelay: number
    • Optional prompt: boolean
    • Optional promptDelay: number

    Returns void

  • Parameters

    • iconSetting: any
    • gamepadType: any
    • iconElement: any
    • controlLabel: any

    Returns void