PokéRogue
    Preparing search index...

    Class PartyUiHandler

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    active awaitingActionInput blockInput cursor fieldIndex iconAnimHandler lastCursor lastLeftPokemonCursor lastRightPokemonCursor localizedOptions message mode moveInfoOverlay moveSelectFilter onActionInput options optionsBg optionsContainer optionsCursor optionsCursorObj optionsMode optionsScroll optionsScrollCursor optionsScrollTotal partyBg partyCancelButton partyContainer partyDiscardModeButton partyMessageBox partySlots partySlotsContainer partyUiMode pendingPrompt prompt selectCallback selectFilter showMovePp textCallbackTimer textTimer tmMoveId transferAll transferCursor transferMode transferOptionCursor transferQuantities transferQuantitiesMax tutorialActive tutorialOverlay NoEffectMessage

    Methods

    addCancelAndScrollOptions addCommonOptions allowBatonModifierSwitch allowCancel clear clearOptions clearPartySlots clearText clearTransfer destroy doDiscard doRelease eraseOptionsCursor FilterChallengeLegal getCursor getFilterResult getFormChangeItemsModifiers getItemModifiers getOptionsCursorWithScroll getReleaseMessage getTransferrableItemsFromPokemon getUi initPromptSprite initTutorialOverlay isBatonPassMove isItemManageMode isTextAnimationInProgress moveOptionCursor populatePartySlots processActionButtonForOptions processDiscardMenuInput processInput processModifierTransferModeInput processModifierTransferModeLeftRightInput processModifierTransferModeUpDownInput processOptionMenuInput processPartyActionInput processPartyCancelInput processPartyDirectionalInput processPokedexOption processReleaseOption processRememberMoveModeInput processRememberMoveModeUpDownInput processRenameOption processSummaryOption processTransferOption processTutorialInput processUnpauseEvolutionOption processUnspliceOption setCursor setMouseCursorStyle setOptionsCursor setup show showDialogue showOptions showPartyText showPrompt showText startTransfer updateOptions updateOptionsHardcore updateOptionsWindow updateOptionsWithModifierTransferMode updateOptionsWithMoveModifierMode updateOptionsWithRememberMoveModifierMode FilterAll FilterAllMoves FilterFainted FilterItemMaxStacks FilterNonFainted

    Constructors

    Properties

    active: boolean = false
    awaitingActionInput: boolean
    blockInput: boolean
    cursor: number = 0
    fieldIndex: number
    iconAnimHandler: PokemonIconAnimHelper
    lastCursor: number = 0
    lastLeftPokemonCursor: number = 0
    lastRightPokemonCursor: number = 0
    localizedOptions: PartyOption[] = ...
    message: Text
    mode: null | number
    moveInfoOverlay: MoveInfoOverlay
    moveSelectFilter: PokemonMoveSelectFilter
    onActionInput: null | Function
    options: number[]
    optionsBg: NineSlice
    optionsContainer: Container

    This is only public for test/ui/transfer-item.test.ts

    optionsCursor: number = 0
    optionsCursorObj: null | Image
    optionsMode: boolean
    optionsScroll: boolean
    optionsScrollCursor: number = 0
    optionsScrollTotal: number = 0
    partyBg: Image
    partyCancelButton: PartyCancelButton
    partyContainer: Container
    partyDiscardModeButton: PartyDiscardModeButton
    partyMessageBox: NineSlice
    partySlots: PartySlot[]
    partySlotsContainer: Container
    partyUiMode: PartyUiMode
    pendingPrompt: boolean
    prompt: Sprite
    selectCallback: null | PartySelectCallback | PartyModifierTransferSelectCallback
    selectFilter: PokemonSelectFilter | PokemonModifierTransferSelectFilter
    showMovePp: boolean
    textCallbackTimer: null | TimerEvent
    textTimer: null | TimerEvent
    tmMoveId: MoveId
    transferAll: boolean

    Whether to transfer all items

    transferCursor: number
    transferMode: boolean
    transferOptionCursor: number
    transferQuantities: number[]

    Current quantity selection for every item held by the pokemon selected for the transfer

    transferQuantitiesMax: number[]

    Stack size of every item that the selected pokemon is holding

    tutorialActive: boolean = false
    tutorialOverlay: Rectangle
    NoEffectMessage: string = ...

    Methods

    • Return whether this UI handler is responsible for managing items. Used to ensure proper placement of mode toggle buttons in the UI, etc.

      Returns boolean

      Whether the current handler is responsible for managing items.

    • Parameters

      • text: string
      • Optional_name: string
      • Optionaldelay: null | number
      • Optionalcallback: null | Function
      • OptionalcallbackDelay: null | number
      • Optionalprompt: null | boolean
      • OptionalpromptDelay: null | number

      Returns void

    • Parameters

      • text: string
      • Optionaldelay: null | number
      • Optionalcallback: null | Function
      • OptionalcallbackDelay: null | number
      • Optionalprompt: null | boolean
      • OptionalpromptDelay: null | number

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    addCancelAndScrollOptionsaddCommonOptionsallowBatonModifierSwitchallowCancelclearclearOptionsclearPartySlotsclearTextclearTransferdestroydoDiscarddoReleaseeraseOptionsCursorFilterChallengeLegalgetCursorgetFilterResultgetFormChangeItemsModifiersgetItemModifiersgetOptionsCursorWithScrollgetReleaseMessagegetTransferrableItemsFromPokemongetUiinitPromptSpriteinitTutorialOverlayisBatonPassMoveisItemManageModeisTextAnimationInProgressmoveOptionCursorpopulatePartySlotsprocessActionButtonForOptionsprocessDiscardMenuInputprocessInputprocessModifierTransferModeInputprocessModifierTransferModeLeftRightInputprocessModifierTransferModeUpDownInputprocessOptionMenuInputprocessPartyActionInputprocessPartyCancelInputprocessPartyDirectionalInputprocessPokedexOptionprocessReleaseOptionprocessRememberMoveModeInputprocessRememberMoveModeUpDownInputprocessRenameOptionprocessSummaryOptionprocessTransferOptionprocessTutorialInputprocessUnpauseEvolutionOptionprocessUnspliceOptionsetCursorsetMouseCursorStylesetOptionsCursorsetupshowshowDialogueshowOptionsshowPartyTextshowPromptshowTextstartTransferupdateOptionsupdateOptionsHardcoreupdateOptionsWindowupdateOptionsWithModifierTransferModeupdateOptionsWithMoveModifierModeupdateOptionsWithRememberMoveModifierModeFilterAllFilterAllMovesFilterFaintedFilterItemMaxStacksFilterNonFainted