Class ItemConditionalModifier

_id

Optionalcritical

OptionaldamageType

formula

OptionalsubTarget

target

type

isEmpty

• get isEmpty(): boolean

  Whether the conditional modifier is empty by checking if the fields default values haven't changed.

  Returns boolean

partID

• get partID(): string

  Part ID string

  Returns string

prepareData

• prepareData(): void

  Returns void

parent

Static Readonly Internalmetadata

id

• get id(): string

  Returns string

uuid

• get uuid(): string

  Retrieve UUID

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

  Returns string

delete

• delete(): Promise<Action>

  Delete this individual modifier.

  Returns Promise<Action>

  • Updated action

update

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

  Update modifier

  Parameters

  • updateData: object
  • Optionaloptions: object = {}

  Returns Promise<Action>

  • Updated action

Staticcreate

• create(
      data:
          | 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";
              },
          >
          | 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";
              },
          >[],
      context?: { parent: ItemConditional },
  ): Promise<ItemConditionalModifier[]>

  Create conditional modifier

  Parameters

  • data:
        | 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";
            },
        >
        | 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";
            },
        >[]

    Creation data

  • context: { parent: ItemConditional } = {}

    Context data

    • parent: ItemConditional

      Parent conditional

  Returns Promise<ItemConditionalModifier[]>

  • Created modifiers

StaticpruneData

• pruneData(source: object): void
  Internal

  Parameters

  • source: object

  Returns void