Pathfinder 1e for Foundry VTT
    Preparing search index...

    Class HelpBrowserPF

    An application for displaying system documentation.

    Hierarchy

    • HandlebarsApplication<this> & ApplicationV2<
          RenderContext,
          Configuration,
          RenderOptions,
          this,
      >
      • HelpBrowserPF
    Index

    Constructors

    constructor

    Properties

    _currentPage DEFAULT_OPTIONS PARTS

    Accessors

    currentUrl defaultExtensions

    Methods

    _onClose _onRender _prepareContext _render getCurrentHistoryObject openUrl _backInHistory _forwardInHistory _onNavigate

    Constructors

    • Applications are constructed by providing an object of configuration options.

      Parameters

      • Optionaloptions: {}

        Options used to configure the Application instance (default: {})

      Returns HelpBrowserPF

    Properties

    Static_currentPage

    _currentPage: any
    DEFAULT_OPTIONS: {
        actions: {
            back: () => void;
            forward: () => void;
            nav: (event: PointerEvent, elem: HTMLElement) => void;
        };
        classes: string[];
        id: string;
        position: { height: number; width: number };
        window: {
            icon: string;
            minimizable: boolean;
            resizable: boolean;
            title: string;
        };
    } = ...
    PARTS: { form: { template: string } } = ...

    Accessors

    • get currentUrl(): string

      The URL of the page currently displayed

      Returns string

    • get defaultExtensions(): ShowdownExtension[]

      Extensions for the Markdown converter used by the help browser.

      Returns ShowdownExtension[]

    Methods

    _onClose

    • _onClose(options: any): void

      Parameters

      • options: any

      Returns void

    Protected_onRender

    • _onRender(context: ApplicationRenderContext, options: RenderOptions): void
      Protected

      Attach event listeners to the rendered application form.

      Parameters

      • context: ApplicationRenderContext

        Prepared context data

      • options: RenderOptions

        Provided render options

      Returns void

    Protected_prepareContext

    • _prepareContext(): Promise<
          {
              breadcrumbs: string[];
              hasHistoryBack: boolean;
              hasHistoryForward: boolean;
              pageContent: string;
              url: string;
          },
      >
      Protected

      Returns Promise<
          {
              breadcrumbs: string[];
              hasHistoryBack: boolean;
              hasHistoryForward: boolean;
              pageContent: string;
              url: string;
          },
      >

    _render

    • _render(force: any, options: any): Promise<void>

      Parameters

      • force: any
      • options: any

      Returns Promise<void>

    • Returns a HistoryEntry containing a snapshot of the currently rendered state.

      Returns HistoryEntry

      The current state

    • Opens a specific page in the help browser.

      Parameters

      • url: string

        The help URL to open

      Returns void

    Static_backInHistory

    • _backInHistory(): void

      Go back one page in history.

      Returns void

    Static_forwardInHistory

    • _forwardInHistory(): void

      Go forward one page in history.

      Returns void

    Static_onNavigate

    • _onNavigate(event: PointerEvent, elem: HTMLElement): void

      On navigation action

      Parameters

      • event: PointerEvent
      • elem: HTMLElement

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods