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

    Class SubActionExperimental

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _id action activation? baseDC? flags? img? name namespace

    Accessors

    id selectId

    Methods

    _initialize evaluateDC localize prepareData defineSchema

    Constructors

    • Experimental

      Parameters

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

      Returns SubAction

    Properties

    Experimental_id

    _id: string
    action: string

    The action ID for the sub-action.

    activation?: {
        cost?: number;
        type:
            | "move"
            | "round"
            | "attack"
            | "special"
            | "free"
            | "aoo"
            | "nonaction"
            | "passive"
            | "standard"
            | "swift"
            | "immediate"
            | "minute"
            | "hour"
            | "full";
        unchained?: {
            cost?: number;
            type: | "action"
            | "attack"
            | "special"
            | "free"
            | "aoo"
            | "nonaction"
            | "passive"
            | "reaction"
            | "minute"
            | "hour";
        };
    }

    The activation cost and type.

    baseDC?: string

    The base DC if any.

    flags?: object
    img?: string

    The image to show for the ActionUse if any.

    name: string
    namespace: string

    Accessors

    • get id(): string
      Experimental

      The unique key of the value.

      Returns string

    • get selectId(): string
      Experimental

      Simple consistent selection ID

      This may lose accuracy if used in general.

      Returns string

    Methods

    _initialize

    • _initialize(): void
      Internal

      Returns void

    • Experimental

      Given the current action and the given data it resolves the base DC for this action.

      Parameters

      • data: Record<string, never> = {}

        The data for formula resolution.

      Returns undefined | Roll<EmptyObject>

      The resolved DC.

    • Protected Experimental

      Localize fields

      Returns void

    • Protected Experimental

      Prepares the data of the registry entry.

      Returns void

    • Experimental

      Returns {
          _id: StringField<
              { blank: false; readonly: true; required: true },
              AssignmentType<{ blank: false; readonly: true; required: true }>,
              string,
              string,
          >;
          activation: SchemaField<
              {
                  cost: NumberField<
                      { initial: undefined; required: false },
                      AssignmentType<{ initial: undefined; required: false }>,
                      InitializedType<{ initial: undefined; required: false }>,
                      InitializedType<{ initial: undefined; required: false }>,
                  >;
                  type: StringField<
                      {
                          choices: () => {
                              aoo: "Attack of Opportunity";
                              attack: "Attack";
                              free: "Free";
                              full: "Full-round";
                              hour: "Hour";
                              immediate: "Immediate";
                              minute: "Minute";
                              move: "Move";
                              nonaction: "Nonaction";
                              passive: "Passive";
                              round: "Round";
                              special: "Special";
                              standard: "Standard";
                              swift: "Swift";
                          };
                          initial: undefined;
                          required: false;
                      },
                      AssignmentType<
                          {
                              choices: () => {
                                  aoo: "Attack of Opportunity";
                                  attack: "Attack";
                                  free: "Free";
                                  full: "Full-round";
                                  hour: "Hour";
                                  immediate: "Immediate";
                                  minute: "Minute";
                                  move: "Move";
                                  nonaction: "Nonaction";
                                  passive: "Passive";
                                  round: "Round";
                                  special: "Special";
                                  standard: "Standard";
                                  swift: "Swift";
                              };
                              initial: undefined;
                              required: false;
                          },
                      >,
                      InitializedType<
                          {
                              choices: () => {
                                  aoo: "Attack of Opportunity";
                                  attack: "Attack";
                                  free: "Free";
                                  full: "Full-round";
                                  hour: "Hour";
                                  immediate: "Immediate";
                                  minute: "Minute";
                                  move: "Move";
                                  nonaction: "Nonaction";
                                  passive: "Passive";
                                  round: "Round";
                                  special: "Special";
                                  standard: "Standard";
                                  swift: "Swift";
                              };
                              initial: undefined;
                              required: false;
                          },
                      >,
                      InitializedType<
                          {
                              choices: () => {
                                  aoo: "Attack of Opportunity";
                                  attack: "Attack";
                                  free: "Free";
                                  full: "Full-round";
                                  hour: "Hour";
                                  immediate: "Immediate";
                                  minute: "Minute";
                                  move: "Move";
                                  nonaction: "Nonaction";
                                  passive: "Passive";
                                  round: "Round";
                                  special: "Special";
                                  standard: "Standard";
                                  swift: "Swift";
                              };
                              initial: undefined;
                              required: false;
                          },
                      >,
                  >;
                  unchained: SchemaField<
                      {
                          cost: NumberField<
                              { initial: undefined; required: false },
                              AssignmentType<{ initial: undefined; required: false }>,
                              InitializedType<{ initial: undefined; required: false }>,
                              InitializedType<{ initial: undefined; required: false }>,
                          >;
                          type: StringField<
                              {
                                  choices: () => {
                                      action: "Act";
                                      aoo: "Attack of Opportunity";
                                      attack: "Attack";
                                      free: "Free";
                                      hour: "Hour";
                                      minute: "Minute";
                                      nonaction: "Nonaction";
                                      passive: "Passive";
                                      reaction: "Reaction";
                                      special: "Special";
                                  };
                                  initial: undefined;
                                  required: false;
                              },
                              AssignmentType<
                                  {
                                      choices: () => {
                                          action: "Act";
                                          aoo: "Attack of Opportunity";
                                          attack: "Attack";
                                          free: "Free";
                                          hour: "Hour";
                                          minute: "Minute";
                                          nonaction: "Nonaction";
                                          passive: "Passive";
                                          reaction: "Reaction";
                                          special: "Special";
                                      };
                                      initial: undefined;
                                      required: false;
                                  },
                              >,
                              InitializedType<
                                  {
                                      choices: () => {
                                          action: "Act";
                                          aoo: "Attack of Opportunity";
                                          attack: "Attack";
                                          free: "Free";
                                          hour: "Hour";
                                          minute: "Minute";
                                          nonaction: "Nonaction";
                                          passive: "Passive";
                                          reaction: "Reaction";
                                          special: "Special";
                                      };
                                      initial: undefined;
                                      required: false;
                                  },
                              >,
                              InitializedType<
                                  {
                                      choices: () => {
                                          action: "Act";
                                          aoo: "Attack of Opportunity";
                                          attack: "Attack";
                                          free: "Free";
                                          hour: "Hour";
                                          minute: "Minute";
                                          nonaction: "Nonaction";
                                          passive: "Passive";
                                          reaction: "Reaction";
                                          special: "Special";
                                      };
                                      initial: undefined;
                                      required: false;
                                  },
                              >,
                          >;
                      },
                      DefaultOptions,
                      AssignmentType<
                          {
                              cost: NumberField<
                                  { initial: undefined; required: false },
                                  AssignmentType<{ initial: undefined; required: false }>,
                                  InitializedType<{ initial: undefined; required: false }>,
                                  InitializedType<{ initial: undefined; required: false }>,
                              >;
                              type: StringField<
                                  {
                                      choices: () => {
                                          action: "Act";
                                          aoo: "Attack of Opportunity";
                                          attack: "Attack";
                                          free: "Free";
                                          hour: "Hour";
                                          minute: "Minute";
                                          nonaction: "Nonaction";
                                          passive: "Passive";
                                          reaction: "Reaction";
                                          special: "Special";
                                      };
                                      initial: undefined;
                                      required: false;
                                  },
                                  AssignmentType<
                                      {
                                          choices: () => {
                                              action: ...;
                                              aoo: ...;
                                              attack: ...;
                                              free: ...;
                                              hour: ...;
                                              minute: ...;
                                              nonaction: ...;
                                              passive: ...;
                                              reaction: ...;
                                              special: ...;
                                          };
                                          initial: undefined;
                                          required: false;
                                      },
                                  >,
                                  InitializedType<
                                      {
                                          choices: () => {
                                              action: ...;
                                              aoo: ...;
                                              attack: ...;
                                              free: ...;
                                              hour: ...;
                                              minute: ...;
                                              nonaction: ...;
                                              passive: ...;
                                              reaction: ...;
                                              special: ...;
                                          };
                                          initial: undefined;
                                          required: false;
                                      },
                                  >,
                                  InitializedType<
                                      {
                                          choices: () => {
                                              action: ...;
                                              aoo: ...;
                                              attack: ...;
                                              free: ...;
                                              hour: ...;
                                              minute: ...;
                                              nonaction: ...;
                                              passive: ...;
                                              reaction: ...;
                                              special: ...;
                                          };
                                          initial: undefined;
                                          required: false;
                                      },
                                  >,
                              >;
                          },
                          SimpleMerge<DefaultOptions, DefaultOptions>,
                      >,
                      {
                          cost: InitializedType<{ initial: undefined; required: false }>;
                          type: InitializedType<
                              {
                                  choices: () => {
                                      action: "Act";
                                      aoo: "Attack of Opportunity";
                                      attack: "Attack";
                                      free: "Free";
                                      hour: "Hour";
                                      minute: "Minute";
                                      nonaction: "Nonaction";
                                      passive: "Passive";
                                      reaction: "Reaction";
                                      special: "Special";
                                  };
                                  initial: undefined;
                                  required: false;
                              },
                          >;
                      },
                      {
                          cost: InitializedType<{ initial: undefined; required: false }>;
                          type: InitializedType<
                              {
                                  choices: () => {
                                      action: "Act";
                                      aoo: "Attack of Opportunity";
                                      attack: "Attack";
                                      free: "Free";
                                      hour: "Hour";
                                      minute: "Minute";
                                      nonaction: "Nonaction";
                                      passive: "Passive";
                                      reaction: "Reaction";
                                      special: "Special";
                                  };
                                  initial: undefined;
                                  required: false;
                              },
                          >;
                      },
                  >;
              },
              DefaultOptions,
              AssignmentType<
                  {
                      cost: NumberField<
                          { initial: undefined; required: false },
                          AssignmentType<{ initial: undefined; required: false }>,
                          InitializedType<{ initial: undefined; required: false }>,
                          InitializedType<{ initial: undefined; required: false }>,
                      >;
                      type: StringField<
                          {
                              choices: () => {
                                  aoo: "Attack of Opportunity";
                                  attack: "Attack";
                                  free: "Free";
                                  full: "Full-round";
                                  hour: "Hour";
                                  immediate: "Immediate";
                                  minute: "Minute";
                                  move: "Move";
                                  nonaction: "Nonaction";
                                  passive: "Passive";
                                  round: "Round";
                                  special: "Special";
                                  standard: "Standard";
                                  swift: "Swift";
                              };
                              initial: undefined;
                              required: false;
                          },
                          AssignmentType<
                              {
                                  choices: () => {
                                      aoo: "Attack of Opportunity";
                                      attack: "Attack";
                                      free: "Free";
                                      full: "Full-round";
                                      hour: "Hour";
                                      immediate: "Immediate";
                                      minute: "Minute";
                                      move: "Move";
                                      nonaction: "Nonaction";
                                      passive: "Passive";
                                      round: "Round";
                                      special: "Special";
                                      standard: "Standard";
                                      swift: "Swift";
                                  };
                                  initial: undefined;
                                  required: false;
                              },
                          >,
                          InitializedType<
                              {
                                  choices: () => {
                                      aoo: "Attack of Opportunity";
                                      attack: "Attack";
                                      free: "Free";
                                      full: "Full-round";
                                      hour: "Hour";
                                      immediate: "Immediate";
                                      minute: "Minute";
                                      move: "Move";
                                      nonaction: "Nonaction";
                                      passive: "Passive";
                                      round: "Round";
                                      special: "Special";
                                      standard: "Standard";
                                      swift: "Swift";
                                  };
                                  initial: undefined;
                                  required: false;
                              },
                          >,
                          InitializedType<
                              {
                                  choices: () => {
                                      aoo: "Attack of Opportunity";
                                      attack: "Attack";
                                      free: "Free";
                                      full: "Full-round";
                                      hour: "Hour";
                                      immediate: "Immediate";
                                      minute: "Minute";
                                      move: "Move";
                                      nonaction: "Nonaction";
                                      passive: "Passive";
                                      round: "Round";
                                      special: "Special";
                                      standard: "Standard";
                                      swift: "Swift";
                                  };
                                  initial: undefined;
                                  required: false;
                              },
                          >,
                      >;
                      unchained: SchemaField<
                          {
                              cost: NumberField<
                                  { initial: undefined; required: false },
                                  AssignmentType<{ initial: undefined; required: false }>,
                                  InitializedType<{ initial: undefined; required: false }>,
                                  InitializedType<{ initial: undefined; required: false }>,
                              >;
                              type: StringField<
                                  {
                                      choices: () => {
                                          action: "Act";
                                          aoo: "Attack of Opportunity";
                                          attack: "Attack";
                                          free: "Free";
                                          hour: "Hour";
                                          minute: "Minute";
                                          nonaction: "Nonaction";
                                          passive: "Passive";
                                          reaction: "Reaction";
                                          special: "Special";
                                      };
                                      initial: undefined;
                                      required: false;
                                  },
                                  AssignmentType<
                                      {
                                          choices: () => {
                                              action: ...;
                                              aoo: ...;
                                              attack: ...;
                                              free: ...;
                                              hour: ...;
                                              minute: ...;
                                              nonaction: ...;
                                              passive: ...;
                                              reaction: ...;
                                              special: ...;
                                          };
                                          initial: undefined;
                                          required: false;
                                      },
                                  >,
                                  InitializedType<
                                      {
                                          choices: () => {
                                              action: ...;
                                              aoo: ...;
                                              attack: ...;
                                              free: ...;
                                              hour: ...;
                                              minute: ...;
                                              nonaction: ...;
                                              passive: ...;
                                              reaction: ...;
                                              special: ...;
                                          };
                                          initial: undefined;
                                          required: false;
                                      },
                                  >,
                                  InitializedType<
                                      {
                                          choices: () => {
                                              action: ...;
                                              aoo: ...;
                                              attack: ...;
                                              free: ...;
                                              hour: ...;
                                              minute: ...;
                                              nonaction: ...;
                                              passive: ...;
                                              reaction: ...;
                                              special: ...;
                                          };
                                          initial: undefined;
                                          required: false;
                                      },
                                  >,
                              >;
                          },
                          DefaultOptions,
                          AssignmentType<
                              {
                                  cost: NumberField<
                                      { initial: undefined; required: false },
                                      AssignmentType<{ initial: undefined; required: false }>,
                                      InitializedType<{ initial: undefined; required: false }>,
                                      InitializedType<{ initial: undefined; required: false }>,
                                  >;
                                  type: StringField<
                                      {
                                          choices: () => {
                                              action: ...;
                                              aoo: ...;
                                              attack: ...;
                                              free: ...;
                                              hour: ...;
                                              minute: ...;
                                              nonaction: ...;
                                              passive: ...;
                                              reaction: ...;
                                              special: ...;
                                          };
                                          initial: undefined;
                                          required: false;
                                      },
                                      AssignmentType<
                                          { choices: () => ...; initial: undefined; required: false },
                                      >,
                                      InitializedType<
                                          { choices: () => ...; initial: undefined; required: false },
                                      >,
                                      InitializedType<
                                          { choices: () => ...; initial: undefined; required: false },
                                      >,
                                  >;
                              },
                              SimpleMerge<DefaultOptions, DefaultOptions>,
                          >,
                          {
                              cost: InitializedType<{ initial: undefined; required: false }>;
                              type: InitializedType<
                                  {
                                      choices: () => {
                                          action: "Act";
                                          aoo: "Attack of Opportunity";
                                          attack: "Attack";
                                          free: "Free";
                                          hour: "Hour";
                                          minute: "Minute";
                                          nonaction: "Nonaction";
                                          passive: "Passive";
                                          reaction: "Reaction";
                                          special: "Special";
                                      };
                                      initial: undefined;
                                      required: false;
                                  },
                              >;
                          },
                          {
                              cost: InitializedType<{ initial: undefined; required: false }>;
                              type: InitializedType<
                                  {
                                      choices: () => {
                                          action: "Act";
                                          aoo: "Attack of Opportunity";
                                          attack: "Attack";
                                          free: "Free";
                                          hour: "Hour";
                                          minute: "Minute";
                                          nonaction: "Nonaction";
                                          passive: "Passive";
                                          reaction: "Reaction";
                                          special: "Special";
                                      };
                                      initial: undefined;
                                      required: false;
                                  },
                              >;
                          },
                      >;
                  },
                  SimpleMerge<DefaultOptions, DefaultOptions>,
              >,
              {
                  cost: InitializedType<{ initial: undefined; required: false }>;
                  type: InitializedType<
                      {
                          choices: () => {
                              aoo: "Attack of Opportunity";
                              attack: "Attack";
                              free: "Free";
                              full: "Full-round";
                              hour: "Hour";
                              immediate: "Immediate";
                              minute: "Minute";
                              move: "Move";
                              nonaction: "Nonaction";
                              passive: "Passive";
                              round: "Round";
                              special: "Special";
                              standard: "Standard";
                              swift: "Swift";
                          };
                          initial: undefined;
                          required: false;
                      },
                  >;
                  unchained: {
                      cost: InitializedType<{ initial: undefined; required: false }>;
                      type: InitializedType<
                          {
                              choices: () => {
                                  action: "Act";
                                  aoo: "Attack of Opportunity";
                                  attack: "Attack";
                                  free: "Free";
                                  hour: "Hour";
                                  minute: "Minute";
                                  nonaction: "Nonaction";
                                  passive: "Passive";
                                  reaction: "Reaction";
                                  special: "Special";
                              };
                              initial: undefined;
                              required: false;
                          },
                      >;
                  };
              },
              {
                  cost: InitializedType<{ initial: undefined; required: false }>;
                  type: InitializedType<
                      {
                          choices: () => {
                              aoo: "Attack of Opportunity";
                              attack: "Attack";
                              free: "Free";
                              full: "Full-round";
                              hour: "Hour";
                              immediate: "Immediate";
                              minute: "Minute";
                              move: "Move";
                              nonaction: "Nonaction";
                              passive: "Passive";
                              round: "Round";
                              special: "Special";
                              standard: "Standard";
                              swift: "Swift";
                          };
                          initial: undefined;
                          required: false;
                      },
                  >;
                  unchained: {
                      cost: InitializedType<{ initial: undefined; required: false }>;
                      type: InitializedType<
                          {
                              choices: () => {
                                  action: "Act";
                                  aoo: "Attack of Opportunity";
                                  attack: "Attack";
                                  free: "Free";
                                  hour: "Hour";
                                  minute: "Minute";
                                  nonaction: "Nonaction";
                                  passive: "Passive";
                                  reaction: "Reaction";
                                  special: "Special";
                              };
                              initial: undefined;
                              required: false;
                          },
                      >;
                  };
              },
          >;
          baseDC: StringField<
              DefaultOptions,
              AssignmentType<DefaultOptions>,
              InitializedType<DefaultOptions>,
              InitializedType<DefaultOptions>,
          >;
          flags: ObjectField<
              { initial: {}; required: false },
              AssignmentType<{ initial: {}; required: false }>,
              InitializedType<{ initial: {}; required: false }>,
              InitializedType<{ initial: {}; required: false }>,
          >;
          img: FilePathField<
              { blank: false; categories: "IMAGE"[]; initial: undefined },
              AssignmentType<
                  { blank: false; categories: "IMAGE"[]; initial: undefined },
              >,
              InitializedType<
                  { blank: false; categories: "IMAGE"[]; initial: undefined },
              >,
              InitializedType<
                  { blank: false; categories: "IMAGE"[]; initial: undefined },
              >,
          >;
          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,
          >;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods