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

    Class Condition

    A single condition entry in the Condition registry.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _id flags? hud journal mechanics name namespace showInAction showInBuffsTab showInDefense texture track

    Accessors

    id

    Methods

    _initialize localize prepareData toStatusEffect defineSchema

    Constructors

    • Parameters

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

      Returns Condition

    Properties

    _id

    _id: string
    flags?: object
    hud: { exclude: Set<string>; include: Set<string>; show: boolean }

    Type Declaration

    • exclude: Set<string>

      Exclude from actors.

      Has no effect if include set is defined

    • include: Set<string>

      Show for actor types

    • show: boolean
    journal: string
    mechanics: { changes: object[]; contexts: Set<string>; flags: Set<string> }
    name: string
    namespace: string
    showInAction: boolean
    showInBuffsTab: boolean
    showInDefense: boolean
    texture: string
    track: null | (keyof readonly ["dying", "fear", "lethargy", "movement"])

    Accessors

    • get id(): string

      The unique key of the value.

      Returns string

    Methods

    _initialize

    • _initialize(): void
      Internal

      Returns void

    • Protected

      Localize fields

      Returns void

    • Protected

      Prepares the data of the registry entry.

      Returns void

    • Convert condition to format expected by CONFIG.statusEffects.

      Returns object

      • Base object

    • Returns {
          _id: StringField<
              { blank: false; readonly: true; required: true },
              AssignmentType<{ blank: false; readonly: true; required: true }>,
              string,
              string,
          >;
          aliases: SetField<
              StringField<
                  { blank: false; nullable: false },
                  AssignmentType<{ blank: false; nullable: false }>,
                  InitializedType<{ blank: false; nullable: false }>,
                  InitializedType<{ blank: false; nullable: false }>,
              >,
              DefaultOptions,
              AssignmentType<{ blank: false; nullable: false }>,
              InitializedType<{ blank: false; nullable: false }>,
              AssignmentType<
                  AssignmentType<{ blank: false; nullable: false }>,
                  DefaultOptions,
              >,
              Set<InitializedType<{ blank: false; nullable: false }>>,
              InitializedType<{ blank: false; nullable: false }>,
              InitializedType<{ blank: false; nullable: false }>[],
          >;
          flags: ObjectField<
              { initial: {}; required: false },
              AssignmentType<{ initial: {}; required: false }>,
              InitializedType<{ initial: {}; required: false }>,
              InitializedType<{ initial: {}; required: false }>,
          >;
          hud: EmbeddedDataField<
              typeof StatusHudModel,
              DefaultOptions,
              AssignmentType<typeof StatusHudModel, DefaultOptions>,
              StatusHudModel,
              {
                  exclude: PersistedType<
                      InitializedType<{ choices: () => string[] }>,
                      { initial: never[]; label: string; required: false },
                  >;
                  include: PersistedType<
                      InitializedType<{ choices: () => string[] }>,
                      { initial: never[]; label: string; required: false },
                  >;
                  show: InitializedType<
                      SimpleMerge<
                          {
                              initial: true;
                              label: "Show in token status HUD";
                              required: false;
                          },
                          DefaultOptions,
                      >,
                  >;
              },
          >;
          journal: StringField<
              { blank: false; nullable: true; required: false },
              AssignmentType<{ blank: false; nullable: true; required: false }>,
              InitializedType<{ blank: false; nullable: true; required: false }>,
              InitializedType<{ blank: false; nullable: true; required: false }>,
          >;
          mechanics: SchemaField<
              {
                  changes: ArrayField<
                      SchemaField<
                          DataSchema,
                          DefaultOptions,
                          AssignmentType<DataSchema, SimpleMerge<DefaultOptions, DefaultOptions>>,
                          {},
                          {},
                      >,
                      DefaultOptions,
                      AssignmentType<DataSchema, SimpleMerge<DefaultOptions, DefaultOptions>>,
                      {},
                      AssignmentType<
                          AssignmentType<
                              DataSchema,
                              SimpleMerge<DefaultOptions, DefaultOptions>,
                          >,
                          DefaultOptions,
                      >,
                      {}[],
                      {},
                      {}[],
                  >;
                  contexts: SetField<
                      StringField<
                          { blank: false },
                          AssignmentType<{ blank: false }>,
                          InitializedType<{ blank: false }>,
                          InitializedType<{ blank: false }>,
                      >,
                      DefaultOptions,
                      AssignmentType<{ blank: false }>,
                      InitializedType<{ blank: false }>,
                      AssignmentType<AssignmentType<{ blank: false }>, DefaultOptions>,
                      Set<InitializedType<{ blank: false }>>,
                      InitializedType<{ blank: false }>,
                      InitializedType<{ blank: false }>[],
                  >;
                  flags: SetField<
                      StringField<
                          { blank: false },
                          AssignmentType<{ blank: false }>,
                          InitializedType<{ blank: false }>,
                          InitializedType<{ blank: false }>,
                      >,
                      DefaultOptions,
                      AssignmentType<{ blank: false }>,
                      InitializedType<{ blank: false }>,
                      AssignmentType<AssignmentType<{ blank: false }>, DefaultOptions>,
                      Set<InitializedType<{ blank: false }>>,
                      InitializedType<{ blank: false }>,
                      InitializedType<{ blank: false }>[],
                  >;
              },
              DefaultOptions,
              AssignmentType<
                  {
                      changes: ArrayField<
                          SchemaField<
                              DataSchema,
                              DefaultOptions,
                              AssignmentType<
                                  DataSchema,
                                  SimpleMerge<DefaultOptions, DefaultOptions>,
                              >,
                              {},
                              {},
                          >,
                          DefaultOptions,
                          AssignmentType<DataSchema, SimpleMerge<DefaultOptions, DefaultOptions>>,
                          {},
                          AssignmentType<
                              AssignmentType<
                                  DataSchema,
                                  SimpleMerge<DefaultOptions, DefaultOptions>,
                              >,
                              DefaultOptions,
                          >,
                          {}[],
                          {},
                          {}[],
                      >;
                      contexts: SetField<
                          StringField<
                              { blank: false },
                              AssignmentType<{ blank: false }>,
                              InitializedType<{ blank: false }>,
                              InitializedType<{ blank: false }>,
                          >,
                          DefaultOptions,
                          AssignmentType<{ blank: false }>,
                          InitializedType<{ blank: false }>,
                          AssignmentType<AssignmentType<{ blank: false }>, DefaultOptions>,
                          Set<InitializedType<{ blank: false }>>,
                          InitializedType<{ blank: false }>,
                          InitializedType<{ blank: false }>[],
                      >;
                      flags: SetField<
                          StringField<
                              { blank: false },
                              AssignmentType<{ blank: false }>,
                              InitializedType<{ blank: false }>,
                              InitializedType<{ blank: false }>,
                          >,
                          DefaultOptions,
                          AssignmentType<{ blank: false }>,
                          InitializedType<{ blank: false }>,
                          AssignmentType<AssignmentType<{ blank: false }>, DefaultOptions>,
                          Set<InitializedType<{ blank: false }>>,
                          InitializedType<{ blank: false }>,
                          InitializedType<{ blank: false }>[],
                      >;
                  },
                  SimpleMerge<DefaultOptions, DefaultOptions>,
              >,
              {
                  changes: {}[];
                  contexts: Set<InitializedType<{ blank: false }>>;
                  flags: Set<InitializedType<{ blank: false }>>;
              },
              {
                  changes: {}[];
                  contexts: InitializedType<{ blank: false }>[];
                  flags: InitializedType<{ blank: false }>[];
              },
          >;
          name: StringField<
              { initial: ""; localize: true; required: false },
              AssignmentType<{ initial: ""; localize: true; required: false }>,
              InitializedType<{ initial: ""; localize: true; required: false }>,
              InitializedType<{ initial: ""; localize: true; required: false }>,
          >;
          namespace: StringField<
              { blank: false; required: true },
              AssignmentType<{ blank: false; required: true }>,
              string,
              string,
          >;
          showInAction: BooleanField<
              { initial: true; required: false },
              AssignmentType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
              InitializedType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
              InitializedType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
          >;
          showInBuffsTab: BooleanField<
              { initial: true; required: false },
              AssignmentType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
              InitializedType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
              InitializedType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
          >;
          showInDefense: BooleanField<
              { initial: true; required: false },
              AssignmentType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
              InitializedType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
              InitializedType<
                  SimpleMerge<{ initial: true; required: false }, DefaultOptions>,
              >,
          >;
          statuses: SetField<
              StringField<
                  DefaultOptions,
                  AssignmentType<DefaultOptions>,
                  InitializedType<DefaultOptions>,
                  InitializedType<DefaultOptions>,
              >,
              DefaultOptions,
              AssignmentType<DefaultOptions>,
              InitializedType<DefaultOptions>,
              AssignmentType<AssignmentType<DefaultOptions>, DefaultOptions>,
              Set<InitializedType<DefaultOptions>>,
              InitializedType<DefaultOptions>,
              InitializedType<DefaultOptions>[],
          >;
          texture: StringField<
              { required: true },
              AssignmentType<{ required: true }>,
              string,
              string,
          >;
          track: StringField<
              {
                  blank: false;
                  choices: () => readonly ["dying", "fear", "lethargy", "movement"];
                  initial: null;
                  nullable: true;
                  required: false;
              },
              AssignmentType<
                  {
                      blank: false;
                      choices: () => readonly ["dying", "fear", "lethargy", "movement"];
                      initial: null;
                      nullable: true;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      choices: () => readonly ["dying", "fear", "lethargy", "movement"];
                      initial: null;
                      nullable: true;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      choices: () => readonly ["dying", "fear", "lethargy", "movement"];
                      initial: null;
                      nullable: true;
                      required: false;
                  },
              >,
          >;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods