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

    Class StatusHudModel

    Condition's status HUD behaviour configuration.

    Hierarchy

    • DataModel
      • StatusHudModel
    Index

    Constructors

    constructor

    Accessors

    actorTypes

    Methods

    defineSchema

    Constructors

    • Parameters

      • ...args: ConstructorArgs<any, null, any>

      Returns StatusHudModel

    Accessors

    • get actorTypes(): undefined | string[]

      Allowed actor types.

      Returns undefined | string[]

      • Undefined if no limitations are present.

    Methods

    • Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.

      Returns {
          exclude: SetField<
              StringField<
                  { choices: () => string[] },
                  AssignmentType<{ choices: () => string[] }>,
                  InitializedType<{ choices: () => string[] }>,
                  InitializedType<{ choices: () => string[] }>,
              >,
              { initial: never[]; label: string; required: false },
              AssignmentType<{ choices: () => string[] }>,
              InitializedType<{ choices: () => string[] }>,
              AssignmentType<
                  AssignmentType<{ choices: () => string[] }>,
                  { initial: never[]; label: string; required: false },
              >,
              InitializedType<
                  InitializedType<{ choices: () => string[] }>,
                  { initial: never[]; label: string; required: false },
              >,
              InitializedType<{ choices: () => string[] }>,
              PersistedType<
                  InitializedType<{ choices: () => string[] }>,
                  { initial: never[]; label: string; required: false },
              >,
          >;
          include: SetField<
              StringField<
                  { choices: () => string[] },
                  AssignmentType<{ choices: () => string[] }>,
                  InitializedType<{ choices: () => string[] }>,
                  InitializedType<{ choices: () => string[] }>,
              >,
              { initial: never[]; label: string; required: false },
              AssignmentType<{ choices: () => string[] }>,
              InitializedType<{ choices: () => string[] }>,
              AssignmentType<
                  AssignmentType<{ choices: () => string[] }>,
                  { initial: never[]; label: string; required: false },
              >,
              InitializedType<
                  InitializedType<{ choices: () => string[] }>,
                  { initial: never[]; label: string; required: false },
              >,
              InitializedType<{ choices: () => string[] }>,
              PersistedType<
                  InitializedType<{ choices: () => string[] }>,
                  { initial: never[]; label: string; required: false },
              >,
          >;
          show: BooleanField<
              { initial: true; label: "Show in token status HUD"; required: false },
              AssignmentType<
                  SimpleMerge<
                      { initial: true; label: "Show in token status HUD"; required: false },
                      DefaultOptions,
                  >,
              >,
              InitializedType<
                  SimpleMerge<
                      { initial: true; label: "Show in token status HUD"; required: false },
                      DefaultOptions,
                  >,
              >,
              InitializedType<
                  SimpleMerge<
                      { initial: true; label: "Show in token status HUD"; required: false },
                      DefaultOptions,
                  >,
              >,
          >;
      }

      The returned value MUST be kept up to sync with the Schema type parameter.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods