Class ItemConditional

_id

default

modifiers

Optionalname

parent

Static Readonly Internalmetadata

id

• get id(): string

  Returns string

uuid

• get uuid(): string

  Retrieve UUID

  Relies on pf1.component.Action.getEmbeddedDocument | Action#getEmbeddedDocument() to function with fromUuid() and similar functions.

  Returns string

_prepareModifiers

• _prepareModifiers(): void
  Internal

  Returns void

delete

• delete(): Promise<any>

  Delete conditional

  Returns Promise<any>

prepareData

• prepareData(): void
  Internal

  Returns void

update

• update(updateData: object, options?: object): Promise<any>

  Update conditional

  Parameters

  • updateData: object
  • options: object = {}

  Returns Promise<any>

Staticcreate

• create(
      data:
          | Partial<
              {
                  _id: string;
                  default: boolean;
                  modifiers: Partial<
                      {
                          _id: string;
                          critical: string;
                          damageType: string[];
                          formula: Formula;
                          subTarget: string;
                          target: string;
                          type: | "untyped"
                          | "untypedPerm"
                          | "dodge"
                          | "racial"
                          | "circumstance"
                          | "base"
                          | "deflection"
                          | "resist"
                          | "haste"
                          | "trait"
                          | "enh"
                          | "size"
                          | "inherent"
                          | "morale"
                          | "luck"
                          | "sacred"
                          | "insight"
                          | "profane"
                          | "competence"
                          | "alchemical";
                      },
                  >[];
                  name: string;
              },
          >
          | Partial<
              {
                  _id: string;
                  default: boolean;
                  modifiers: Partial<
                      {
                          _id: string;
                          critical: string;
                          damageType: string[];
                          formula: Formula;
                          subTarget: string;
                          target: string;
                          type: | "untyped"
                          | "untypedPerm"
                          | "dodge"
                          | "racial"
                          | "circumstance"
                          | "base"
                          | "deflection"
                          | "resist"
                          | "haste"
                          | "trait"
                          | "enh"
                          | "size"
                          | "inherent"
                          | "morale"
                          | "luck"
                          | "sacred"
                          | "insight"
                          | "profane"
                          | "competence"
                          | "alchemical";
                      },
                  >[];
                  name: string;
              },
          >[],
      context?: { parent: Action },
  ): Proimise<ItemConditional[]>

  Create new conditional

  Parameters

  • data:
        | Partial<
            {
                _id: string;
                default: boolean;
                modifiers: Partial<
                    {
                        _id: string;
                        critical: string;
                        damageType: string[];
                        formula: Formula;
                        subTarget: string;
                        target: string;
                        type: | "untyped"
                        | "untypedPerm"
                        | "dodge"
                        | "racial"
                        | "circumstance"
                        | "base"
                        | "deflection"
                        | "resist"
                        | "haste"
                        | "trait"
                        | "enh"
                        | "size"
                        | "inherent"
                        | "morale"
                        | "luck"
                        | "sacred"
                        | "insight"
                        | "profane"
                        | "competence"
                        | "alchemical";
                    },
                >[];
                name: string;
            },
        >
        | Partial<
            {
                _id: string;
                default: boolean;
                modifiers: Partial<
                    {
                        _id: string;
                        critical: string;
                        damageType: string[];
                        formula: Formula;
                        subTarget: string;
                        target: string;
                        type: | "untyped"
                        | "untypedPerm"
                        | "dodge"
                        | "racial"
                        | "circumstance"
                        | "base"
                        | "deflection"
                        | "resist"
                        | "haste"
                        | "trait"
                        | "enh"
                        | "size"
                        | "inherent"
                        | "morale"
                        | "luck"
                        | "sacred"
                        | "insight"
                        | "profane"
                        | "competence"
                        | "alchemical";
                    },
                >[];
                name: string;
            },
        >[]

    Data to create conditional(s) from.

  • context: { parent: Action } = {}

    Context data

    • parent: Action

      Parent action to add the conditional to.

  Returns Proimise<ItemConditional[]>

  • Created conditionals

  Throws

  • If no valid parent is defined.

StaticpruneData

• pruneData(data: object): void
  Internal

  Parameters

  • data: object

  Returns void