Class ItemChange

constructor

• new ItemChange(data: any, options?: {}): ItemChange

  Parameters

  • data: any
  • options: {} = {}

  Returns ItemChange

_id

Optionalcontinuous

Optionalflavor

formula

Optionaloperator

Optionalparent

Optionalpriority

target

type

updateTime

Optionalvalue

Static Readonly Internalmetadata

cssClass

• get cssClass(): string

  CSS Template Class

  Returns string

document

• get document(): | undefined
  | Actor<"base" | ModuleSubType>
  | Item<"base" | ModuleSubType>

  Parent document

  Returns undefined | Actor<"base" | ModuleSubType> | Item<"base" | ModuleSubType>

id

• get id(): string

  Change ID

  Returns string

isAC

• get isAC(): boolean

  Does this target any kind of AC?

  Returns boolean

isDeferred

• get isDeferred(): boolean

  Is deferred?

  Deferred changes are evaluated only when rolled.

  Returns boolean

isDistance

• get isDistance(): boolean

  Does this change distance of something?

  Affects mostly presentation.

  Returns boolean

isSimple

• get isSimple(): boolean

  Is simple?

  Simple changes are evaluated before roll data becomes available.

  Returns boolean

name

• get name(): string

  Either parent name or flavour text.

  Returns string

source

• get source(): null

  Returns null

uuid

• get uuid(): string

  Retrieve UUID

  Relies on Item#getEmbeddedDocument() override to function with fromUuid() and similar functions.

  Returns string

_initialize

• _initialize(options?: {}): void

  Parameters

  • options: {} = {}

  Returns void

_preUpdate

• _preUpdate(data: object): void
  Internal

  Parameters

  • data: object

    Data to update with

  Returns void

_safeApplyChange

• _safeApplyChange(
      actor: ActorPF,
      targets?: string[],
      options?: { applySourceInfo?: boolean },
  ): void
  Internal

  Safely apply this change to an actor, catching any errors.

  Parameters

  • actor: ActorPF

    The actor to apply the change's data to.

  • Optionaltargets: string[] = null

    Property paths to target on the actor's data.

  • Optionaloptions: { applySourceInfo?: boolean } = {}

    Optional options to change the behavior of this function.

    • OptionalapplySourceInfo?: boolean

      Whether to add the changes to the actor's source information.

  Returns void

  See

  ItemChange#applyChange

applyChange

• applyChange(
      actor: ActorPF,
      targets?: string[],
      options?: { applySourceInfo?: boolean; rollData?: object },
  ): void

  Applies this change to an actor.

  Parameters

  • actor: ActorPF

    The actor to apply the change's data to.

  • Optionaltargets: string[] = null

    Property paths to target on the actor's data.

  • Optionaloptions: { applySourceInfo?: boolean; rollData?: object } = {}

    Optional options to change the behavior of this function.

    • OptionalapplySourceInfo?: boolean

      Whether to add the changes to the actor's source information.

    • OptionalrollData?: object

      Roll data

  Returns void

applySourceInfo

• applySourceInfo(actor: ActorPF): void

  Applies this change's info to an actor's sourceInfo. Info is only added if either the modifier type allows stacking or the value is higher than the previous value. If the modifier type is not stacking and this change's info is added, existing and now ineffective info entries are removed.

  Parameters

  • actor: ActorPF

    The actor to apply the change's data to.

  Returns void

delete

• delete(): Promise<
      undefined
      | Actor<"base" | ModuleSubType>
      | Item<"base" | ModuleSubType>,
  >

  Returns Promise<
      undefined
      | Actor<"base" | ModuleSubType>
      | Item<"base" | ModuleSubType>,
  >

getSourceInfoTargets

• getSourceInfoTargets(actor: any): string[]

  Parameters

  • actor: any

  Returns string[]

getTargets

• getTargets(actor: ActorPF): string[]

  Parameters

  • actor: ActorPF

    Actor instance

  Returns string[]

  • Valid targets for this change on specified actor

  See

  getChangeFlat

prepareData

• prepareData(): void
  Internal

  Prepare in-memory data.

  Returns void

toObject

• toObject(source: any, prune: any): any

  Parameters

  • source: any
  • prune: any

  Returns any

update

• update(
      data: object,
      options?: object,
      context?: object,
  ): Promise<null | Item<"base" | ModuleSubType>>

  Update this change.

  Parameters

  • data: object

    Update data

  • options: object = {}

    Additional options

  • context: object = {}

    Update context

  Returns Promise<null | Item<"base" | ModuleSubType>>

  • Updated parent, or null if no update was performed (e.g. nothing changed)

  Throws

  • If change has no parent to update or the change does not exist on parent.

updateSource

• updateSource(data: any, options: any): any

  Parameters

  • data: any
  • options: any

  Returns any

Staticcreate

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

  Creates a change.

  Parameters

  • data: object[]

    Data to initialize the change(s) with.

  • context: { parent?: ItemPF } = {}

    An object containing context information.

    • Optionalparent?: ItemPF

      The parent entity to create the change within.

  Returns Promise<ItemChange[]>

  The resulting changes, or an empty array if nothing was created.

StaticdefineSchema

• defineSchema(): {
      _id: StringField<
          { blank: false; initial: () => string; readonly: true; required: true },
          AssignmentType<
              {
                  blank: false;
                  initial: () => string;
                  readonly: true;
                  required: true;
              },
          >,
          string,
          string,
      >;
      continuous: BooleanField<
          { initial: undefined; required: false },
          AssignmentType<
              SimpleMerge<{ initial: undefined; required: false }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: false }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: false }, DefaultOptions>,
          >,
      >;
      flavor: StringField<
          { blank: true; initial: undefined; required: false },
          AssignmentType<{ blank: true; initial: undefined; required: false }>,
          InitializedType<{ blank: true; initial: undefined; required: false }>,
          InitializedType<{ blank: true; initial: undefined; required: false }>,
      >;
      formula: FormulaField;
      operator: StringField<
          { blank: false; choices: readonly ["add", "set"]; initial: "add" },
          AssignmentType<
              { blank: false; choices: readonly ["add", "set"]; initial: "add" },
          >,
          InitializedType<
              { blank: false; choices: readonly ["add", "set"]; initial: "add" },
          >,
          InitializedType<
              { blank: false; choices: readonly ["add", "set"]; initial: "add" },
          >,
      >;
      priority: NumberField<
          { required: false },
          AssignmentType<{ required: false }>,
          InitializedType<{ required: false }>,
          InitializedType<{ required: false }>,
      >;
      target: StringField<
          { blank: true; required: false },
          AssignmentType<{ blank: true; required: false }>,
          InitializedType<{ blank: true; required: false }>,
          InitializedType<{ blank: true; required: false }>,
      >;
      type: StringField<
          { blank: false; initial: "untyped"; required: false },
          AssignmentType<{ blank: false; initial: "untyped"; required: false }>,
          InitializedType<{ blank: false; initial: "untyped"; required: false }>,
          InitializedType<{ blank: false; initial: "untyped"; required: false }>,
      >;
      value: NumberField<
          { required: false },
          AssignmentType<{ required: false }>,
          InitializedType<{ required: false }>,
          InitializedType<{ required: false }>,
      >;
  }

  Returns {
      _id: StringField<
          { blank: false; initial: () => string; readonly: true; required: true },
          AssignmentType<
              {
                  blank: false;
                  initial: () => string;
                  readonly: true;
                  required: true;
              },
          >,
          string,
          string,
      >;
      continuous: BooleanField<
          { initial: undefined; required: false },
          AssignmentType<
              SimpleMerge<{ initial: undefined; required: false }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: false }, DefaultOptions>,
          >,
          InitializedType<
              SimpleMerge<{ initial: undefined; required: false }, DefaultOptions>,
          >,
      >;
      flavor: StringField<
          { blank: true; initial: undefined; required: false },
          AssignmentType<{ blank: true; initial: undefined; required: false }>,
          InitializedType<{ blank: true; initial: undefined; required: false }>,
          InitializedType<{ blank: true; initial: undefined; required: false }>,
      >;
      formula: FormulaField;
      operator: StringField<
          { blank: false; choices: readonly ["add", "set"]; initial: "add" },
          AssignmentType<
              { blank: false; choices: readonly ["add", "set"]; initial: "add" },
          >,
          InitializedType<
              { blank: false; choices: readonly ["add", "set"]; initial: "add" },
          >,
          InitializedType<
              { blank: false; choices: readonly ["add", "set"]; initial: "add" },
          >,
      >;
      priority: NumberField<
          { required: false },
          AssignmentType<{ required: false }>,
          InitializedType<{ required: false }>,
          InitializedType<{ required: false }>,
      >;
      target: StringField<
          { blank: true; required: false },
          AssignmentType<{ blank: true; required: false }>,
          InitializedType<{ blank: true; required: false }>,
          InitializedType<{ blank: true; required: false }>,
      >;
      type: StringField<
          { blank: false; initial: "untyped"; required: false },
          AssignmentType<{ blank: false; initial: "untyped"; required: false }>,
          InitializedType<{ blank: false; initial: "untyped"; required: false }>,
          InitializedType<{ blank: false; initial: "untyped"; required: false }>,
      >;
      value: NumberField<
          { required: false },
          AssignmentType<{ required: false }>,
          InitializedType<{ required: false }>,
          InitializedType<{ required: false }>,
      >;
  }

StaticmigrateData

• migrateData(source: any): any

  Parameters

  • source: any

  Returns any

StaticpruneData

• pruneData(data: any): void

  Parameters

  • data: any

  Returns void