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
    constructor
    active awaitingActionInput blockInput cursor fieldIndex iconAnimHandler lastCursor lastLeftPokemonCursor lastRightPokemonCursor localizedOptions message modifierItemId moveInfoOverlay moveSelectFilter nameBoxContainer? onActionInput optionPrefixes options optionsBg optionsContainer optionsCursor optionsCursorObj optionsMode optionsScroll optionsScrollCursor optionsScrollTotal partyBg partyCancelButton partyContainer partyDiscardModeButton partyMessageBox partySlots partySlotsContainer partySwitchCursor partyUiMode pendingPrompt prompt selectCallback selectFilter showMovePp textCallbackTimer textTimer tmMoveId transferAll transferCursor transferMode transferOptionCursor transferQuantities transferQuantitiesMax tutorialActive tutorialOverlay wordWrapWidth NoEffectMessage
    addCancelAndScrollOptions addCommonOptions allowBatonModifierSwitch allowCancel clear clearOptions clearPartySlots clearPartySwitch clearPartySwitchSelection clearText clearTransfer destroy doDiscard doRelease eraseOptionsCursor FilterChallengeLegal getCursor getFilterResult getFormChangeItemsModifiers getItemModifiers getOptionsCursorWithScroll getReleaseMessage getTransferrableItemsFromPokemon getUi hideNameText hideText initNameBox initPromptSprite initTutorialOverlay isBatonPassMove isItemManageMode isSwappable 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 showNameText showOptions showPartyText showPrompt showText startPartySwitch startTransfer swapPartyMembers updateOptions updateOptionsHardcore updateOptionsWindow updateOptionsWithModifierTransferMode updateOptionsWithMoveModifierMode updateOptionsWithRememberMoveModifierMode updatePartyMessageBox FilterAll FilterAllMoves FilterFainted FilterItemMaxStacks FilterNonFainted
    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
    modifierItemId: EvolutionItem | FormChangeItem | undefined
    moveInfoOverlay: MoveInfoOverlay
    moveSelectFilter: PokemonMoveSelectFilter
    nameBoxContainer?: Container

    The container for the name box

    This will be undefined unless this.initNameBox() was called

    onActionInput: AnyFn<any> | null
    optionPrefixes: (Sprite | Text | null)[] = []

    Prefix for memory mushroom options

    options: number[]
    optionsBg: NineSlice
    optionsContainer: Container

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

    optionsCursor: number = 0
    optionsCursorObj: Image | null
    optionsMode: boolean
    optionsScroll: boolean
    optionsScrollCursor: number = 0
    optionsScrollTotal: number = 0
    partyBg: Image
    partyCancelButton: PartyCancelButton
    partyContainer: Container
    partyDiscardModeButton: PartyDiscardModeButton
    partyMessageBox: NineSlice
    partySlots: PartySlot[]
    partySlotsContainer: Container
    partySwitchCursor: number = -1
    partyUiMode: PartyUiMode
    pendingPrompt: boolean = false
    prompt: Sprite
    selectCallback: PartySelectCallback | PartyModifierTransferSelectCallback | null
    selectFilter: PokemonSelectFilter | PokemonModifierTransferSelectFilter
    showMovePp: boolean
    textCallbackTimer: TimerEvent | null
    textTimer: TimerEvent | null
    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
    wordWrapWidth: number = 1780
    NoEffectMessage: string = ...

    • Add the name box shown by showDialogue to the given message container.

      Parameters

      • container: Container

        The container holding the message text

      • x: number = 0

        The x position of the name box

      • y: number = -16

        The y position of the name box

      Returns void

      If this method is not called, the name box will not be displayed.

    • 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
      • Optionalname: string
      • Optionaldelay: number | null
      • Optionalcallback: (() => void) | null
      • OptionalcallbackDelay: number | null
      • Optionalprompt: boolean | null
      • OptionalpromptDelay: number | null

      Returns void

    • Show a name above the text.

      Parameters

      • name: string

        The name to show

      • OptionaliconFrame: string

        The frame of the icon to display next to the name

      Returns void

      the icon must be from the items atlas

    • Parameters

      • text: string
      • Optionaldelay: number | null
      • Optionalcallback: (() => void) | null
      • OptionalcallbackDelay: number | null
      • Optionalprompt: boolean | null
      • OptionalpromptDelay: number | null

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods
    addCancelAndScrollOptionsaddCommonOptionsallowBatonModifierSwitchallowCancelclearclearOptionsclearPartySlotsclearPartySwitchclearPartySwitchSelectionclearTextclearTransferdestroydoDiscarddoReleaseeraseOptionsCursorFilterChallengeLegalgetCursorgetFilterResultgetFormChangeItemsModifiersgetItemModifiersgetOptionsCursorWithScrollgetReleaseMessagegetTransferrableItemsFromPokemongetUihideNameTexthideTextinitNameBoxinitPromptSpriteinitTutorialOverlayisBatonPassMoveisItemManageModeisSwappableisTextAnimationInProgressmoveOptionCursorpopulatePartySlotsprocessActionButtonForOptionsprocessDiscardMenuInputprocessInputprocessModifierTransferModeInputprocessModifierTransferModeLeftRightInputprocessModifierTransferModeUpDownInputprocessOptionMenuInputprocessPartyActionInputprocessPartyCancelInputprocessPartyDirectionalInputprocessPokedexOptionprocessReleaseOptionprocessRememberMoveModeInputprocessRememberMoveModeUpDownInputprocessRenameOptionprocessSummaryOptionprocessTransferOptionprocessTutorialInputprocessUnpauseEvolutionOptionprocessUnspliceOptionsetCursorsetMouseCursorStylesetOptionsCursorsetupshowshowDialogueshowNameTextshowOptionsshowPartyTextshowPromptshowTextstartPartySwitchstartTransferswapPartyMembersupdateOptionsupdateOptionsHardcoreupdateOptionsWindowupdateOptionsWithModifierTransferModeupdateOptionsWithMoveModifierModeupdateOptionsWithRememberMoveModifierModeupdatePartyMessageBoxFilterAllFilterAllMovesFilterFaintedFilterItemMaxStacksFilterNonFainted