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

    Accessors

    currentUrl defaultExtensions

    Methods

    getCurrentHistoryObject openUrl

    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: undefined | HistoryEntry

    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

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods