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

    Function findInCompendia

    • Searches through compendia quickly using the system generated index caches. Exact matches excluding punctuation and case are prioritized before searching word order permutations.

      Parameters

      • searchTerm: string

        The name of the Document being searched for

      • Optionaloptions: {
            disabled?: boolean;
            docType?: string;
            packs?: string[];
            type?:
                | "Actor"
                | "Item"
                | "JournalEntry"
                | "Macro"
                | "Playlist"
                | "RollTable"
                | "Scene";
        } = {}

        Provides a filter to limit search to specific packs or Document types

        • Optionaldisabled?: boolean

          Include packs disabled for compendium browser.

        • OptionaldocType?: string

          Document type, such as "loot" or "npc"

        • Optionalpacks?: string[]

          An array of packs to search in

        • Optionaltype?: "Actor" | "Item" | "JournalEntry" | "Macro" | "Playlist" | "RollTable" | "Scene"

          A Document type to limit which packs are searched in

      Returns false | { index: object; pack: CompendiumCollection }

      The index and pack containing it or undefined if no match is found