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

    Class AEBuffModel

    Buff tracking Active Effect.

    Active Effect type: buff

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    end? initiative? level?

    Accessors

    isTracker item

    Methods

    _preCreate _preDelete _preUpdate defineSchema

    Constructors

    • Parameters

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

      Returns AEBuffModel

    Properties

    end?: "initiative" | "turnStart" | "turnEnd"

    End timing

    initiative?: number

    Initiative count

    level?: number

    Level

    Unused

    Accessors

    • get isTracker(): boolean

      Is this item tracking AE

      Returns boolean

      • There should be only one AE with this true per item.
    • get item(): null | Item<"base" | ModuleSubType>

      Retrieve parent item

      Returns null | Item<"base" | ModuleSubType>

    Methods

    _preCreate

    • _preCreate(data: any, context: any, user: any): Promise<void>

      Parameters

      • data: any
      • context: any
      • user: any

      Returns Promise<void>

    _preDelete

    • _preDelete(context: any, user: any): Promise<undefined | false>

      Parameters

      • context: any
      • user: any

      Returns Promise<undefined | false>

    _preUpdate

    • _preUpdate(changed: any, context: any, user: any): Promise<void>

      Parameters

      • changed: any
      • context: any
      • user: any

      Returns Promise<void>

    • 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 {
          end: StringField<
              {
                  blank: false;
                  choices: () => {
                      initiative: "Initiative";
                      turnEnd: "Turn End";
                      turnStart: "Turn Start";
                  };
                  label: "End Timing";
                  required: false;
              },
              AssignmentType<
                  {
                      blank: false;
                      choices: () => {
                          initiative: "Initiative";
                          turnEnd: "Turn End";
                          turnStart: "Turn Start";
                      };
                      label: "End Timing";
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      choices: () => {
                          initiative: "Initiative";
                          turnEnd: "Turn End";
                          turnStart: "Turn Start";
                      };
                      label: "End Timing";
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      blank: false;
                      choices: () => {
                          initiative: "Initiative";
                          turnEnd: "Turn End";
                          turnStart: "Turn Start";
                      };
                      label: "End Timing";
                      required: false;
                  },
              >,
          >;
          initiative: NumberField<
              {
                  initial: undefined;
                  label: "Initiative";
                  nullable: false;
                  required: false;
              },
              AssignmentType<
                  {
                      initial: undefined;
                      label: "Initiative";
                      nullable: false;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      initial: undefined;
                      label: "Initiative";
                      nullable: false;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      initial: undefined;
                      label: "Initiative";
                      nullable: false;
                      required: false;
                  },
              >,
          >;
          level: NumberField<
              {
                  initial: undefined;
                  integer: true;
                  label: "Level";
                  nullable: false;
                  required: false;
              },
              AssignmentType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Level";
                      nullable: false;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Level";
                      nullable: false;
                      required: false;
                  },
              >,
              InitializedType<
                  {
                      initial: undefined;
                      integer: true;
                      label: "Level";
                      nullable: false;
                      required: false;
                  },
              >,
          >;
      }

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods