PokéRogue
    Preparing search index...

    RunHistoryUiHandler handles the UI of the Run History Menu Run History itself is broken into an array of RunEntryContainer objects that can show the user basic details about their run and allow them to access more details about their run through cursor action. It navigates similarly to the UI of the save slot select menu. The only valid input buttons are Button.ACTION and Button.CANCEL.

    Hierarchy (View Summary)

    Index
    active: boolean = false
    awaitingActionInput: boolean
    cursor: number = 0
    cursorObj: NineSlice | null
    maxRows: 3
    message: Text
    nameBoxContainer?: Container

    The container for the name box

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

    onActionInput: AnyFn<any> | null
    pendingPrompt: boolean = false
    prompt: Sprite
    runContainerInitialY: number
    runsContainer: Container
    runSelectContainer: Container
    scrollCursor: number = 0
    textCallbackTimer: TimerEvent | null
    textTimer: TimerEvent | null
    tutorialActive: boolean = false
    tutorialOverlay: Rectangle
    wordWrapWidth: number = 1780
    • 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.

    • This retrieves the player's run history and facilitates the processes necessary for the output display. Runs are displayed from newest --> oldest in descending order. In the for loop, each run is processed to create an RunEntryContainer used to display and store the run's unique information

      Returns Promise<void>

    • Performs a certain action based on the button pressed by the user

      Parameters

      • button: Button

        The user can navigate through the runs with Button.UP/Button.DOWN. Button.ACTION allows the user to access more information about their runs. Button.CANCEL allows the user to go back.

      Returns boolean

    • 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