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.

  • findInCompendia(
        searchTerm: string,
        options?: {
            disabled?: boolean;
            docType?: string;
            packs?: string[];
            type?:
                | "Actor"
                | "Scene"
                | "Item"
                | "JournalEntry"
                | "Macro"
                | "Playlist"
                | "RollTable";
        },
    ): false
    | { index: object; pack: CompendiumCollection<any> }

  • Parameters

    • searchTerm: string

      The name of the Document being searched for

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

      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" | "Scene" | "Item" | "JournalEntry" | "Macro" | "Playlist" | "RollTable"

        A Document type to limit which packs are searched in

    Returns false | { index: object; pack: CompendiumCollection<any> }

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

Settings

Member Visibility