Class ItemConditionalModifier

constructor

• new ItemConditionalModifier(): ItemConditionalModifier

  Returns ItemConditionalModifier

_id

Optionalcritical

OptionaldamageType

formula

parent

OptionalsubTarget

target

type

Static Readonly Internalmetadata

id

• get id(): string

  Returns string

partID

• get partID(): string

  Part 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

_getDiff

• _getDiff(data: object): boolean
  Internal

  Gets deeply tested diff

  Used by () indirectly to determine if update is actually necessary.

  Parameters

  • data: object

  Returns boolean

  • False if no real modification happened

delete

• delete(): Promise<ItemAction>

  Delete this individual modifier.

  Returns Promise<ItemAction>

  • Updated action

prepareData

• prepareData(): void

  Returns void

update

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

  Update modifier

  Parameters

  • updateData: object
  • Optionaloptions: object = {}

  Returns Promise<ItemAction>

  • Updated action

Staticcreate

• create(
      data: object,
      context?: { parent: ItemConditional },
  ): Promise<ItemConditionalModifier[]>

  Create conditional modifier

  Parameters

  • data: object

    Creation data

  • context: { parent: ItemConditional } = {}

    Context data

    • parent: ItemConditional

      Parent conditional

  Returns Promise<ItemConditionalModifier[]>

  • Created modifiers

StaticdefineSchema

• defineSchema(): {
      _id: IDField;
      critical: StringField<
          { initial: undefined; required: false },
          AssignmentType<{ initial: undefined; required: false }>,
          InitializedType<{ initial: undefined; required: false }>,
          InitializedType<{ initial: undefined; required: false }>,
      >;
      damageType: SetField<
          StringField<
              { blank: false; nullable: false },
              AssignmentType<{ blank: false; nullable: false }>,
              InitializedType<{ blank: false; nullable: false }>,
              InitializedType<{ blank: false; nullable: false }>,
          >,
          { initial: undefined; required: false },
          AssignmentType<{ blank: false; nullable: false }>,
          InitializedType<{ blank: false; nullable: false }>,
          AssignmentType<
              AssignmentType<{ blank: false; nullable: false }>,
              { initial: undefined; required: false },
          >,
          InitializedType<
              InitializedType<{ blank: false; nullable: false }>,
              { initial: undefined; required: false },
          >,
          InitializedType<{ blank: false; nullable: false }>,
          PersistedType<
              InitializedType<{ blank: false; nullable: false }>,
              { initial: undefined; required: false },
          >,
      >;
      formula: FormulaField;
      subTarget: StringField<
          DefaultOptions,
          AssignmentType<DefaultOptions>,
          InitializedType<DefaultOptions>,
          InitializedType<DefaultOptions>,
      >;
      target: StringField<
          DefaultOptions,
          AssignmentType<DefaultOptions>,
          InitializedType<DefaultOptions>,
          InitializedType<DefaultOptions>,
      >;
      type: StringField<
          { initial: undefined; required: false },
          AssignmentType<{ initial: undefined; required: false }>,
          InitializedType<{ initial: undefined; required: false }>,
          InitializedType<{ initial: undefined; required: false }>,
      >;
  }

  Returns {
      _id: IDField;
      critical: StringField<
          { initial: undefined; required: false },
          AssignmentType<{ initial: undefined; required: false }>,
          InitializedType<{ initial: undefined; required: false }>,
          InitializedType<{ initial: undefined; required: false }>,
      >;
      damageType: SetField<
          StringField<
              { blank: false; nullable: false },
              AssignmentType<{ blank: false; nullable: false }>,
              InitializedType<{ blank: false; nullable: false }>,
              InitializedType<{ blank: false; nullable: false }>,
          >,
          { initial: undefined; required: false },
          AssignmentType<{ blank: false; nullable: false }>,
          InitializedType<{ blank: false; nullable: false }>,
          AssignmentType<
              AssignmentType<{ blank: false; nullable: false }>,
              { initial: undefined; required: false },
          >,
          InitializedType<
              InitializedType<{ blank: false; nullable: false }>,
              { initial: undefined; required: false },
          >,
          InitializedType<{ blank: false; nullable: false }>,
          PersistedType<
              InitializedType<{ blank: false; nullable: false }>,
              { initial: undefined; required: false },
          >,
      >;
      formula: FormulaField;
      subTarget: StringField<
          DefaultOptions,
          AssignmentType<DefaultOptions>,
          InitializedType<DefaultOptions>,
          InitializedType<DefaultOptions>,
      >;
      target: StringField<
          DefaultOptions,
          AssignmentType<DefaultOptions>,
          InitializedType<DefaultOptions>,
          InitializedType<DefaultOptions>,
      >;
      type: StringField<
          { initial: undefined; required: false },
          AssignmentType<{ initial: undefined; required: false }>,
          InitializedType<{ initial: undefined; required: false }>,
          InitializedType<{ initial: undefined; required: false }>,
      >;
  }

StaticmigrateData

• migrateData(source: any): any

  Parameters

  • source: any

  Returns any

StaticpruneData

• pruneData(source: object): void
  Internal

  Parameters

  • source: object

  Returns void