Class ItemChange

constructor

• new ItemChange(data, options?): ItemChange

• Parameters

  • data: any

  • options: {} = {}

  Returns ItemChange

updateTime

value

id

• get id(): string

• Returns string

isAC

• get isAC(): boolean

• Returns boolean

isDeferred

• get isDeferred(): boolean

• Returns boolean

isDistance

• get isDistance(): boolean

• Returns boolean

source

• get source(): null

• Returns null

_initialize

• _initialize(options?): void

• Parameters

  • options: {} = {}

  Returns void

_preUpdate

• _preUpdate(data): any

• Parameters

  • data: any

  Returns any

_safeApplyChange

• _safeApplyChange(actor, targets?, options?): void
• Internal

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

  Parameters

  • actor: ActorPF

    The actor to apply the change's data to.

  • Optional targets: string[] = null

    Property paths to target on the actor's data.

  • Optional options: {
        applySourceInfo: undefined | boolean;
    } = {}

    Optional options to change the behavior of this function.

    • applySourceInfo: undefined | boolean

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

  Returns void

  See

  ItemChange#applyChange

applyChange

• applyChange(actor, targets?, options?): void

• Applies this change to an actor.

  Parameters

  • actor: ActorPF

    The actor to apply the change's data to.

  • Optional targets: string[] = null

    Property paths to target on the actor's data.

  • Optional options: {
        applySourceInfo: undefined | boolean;
        rollData: undefined | object;
    } = {}

    Optional options to change the behavior of this function.

    • applySourceInfo: undefined | boolean

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

    • rollData: undefined | object

      Roll data

  Returns void

applySourceInfo

• applySourceInfo(actor): void

• Applies this change's info to an actor's sourceInfo. Info is only added if either the type | 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

createFunction

• createFunction(funcDef, funcArgs?): any

• Parameters

  • funcDef: any

  • funcArgs: any[] = []

  Returns any

delete

• delete(): Promise<any>

• Returns Promise<any>

getSourceInfoTargets

• getSourceInfoTargets(actor): string[]

• Parameters

  • actor: any

  Returns string[]

getTargets

• getTargets(actor): 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(...options): any

• Parameters

  • Rest ...options: any[]

  Returns any

update

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

• Parameters

  • data: object

    Update data

  • options: object = {}

    Additional options

  • context: object = {}

    Update context

  Returns Promise<null | Item>

  • 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, options): any

• Parameters

  • data: any

  • options: any

  Returns any

Static create

• create(data, context?): ItemChange[]

• Creates a change.

  Parameters

  • data: object[]

    Data to initialize the change(s) with.

  • context: {
        parent: undefined | ItemPF;
    } = {}

    An object containing context information.

    • parent: undefined | ItemPF

      The parent entity to create the change within.

  Returns ItemChange[]

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

Static defineSchema

• defineSchema(): {
      _id: any;
      continuous: any;
      flavor: any;
      formula: any;
      operator: any;
      priority: any;
      target: any;
      type: any;
      value: any;
  }

• Returns {
      _id: any;
      continuous: any;
      flavor: any;
      formula: any;
      operator: any;
      priority: any;
      target: any;
      type: any;
      value: any;
  }

  • _id: any

  • continuous: any

  • flavor: any

  • formula: any

  • operator: any

  • priority: any

  • target: any

  • type: any

  • value: any

Static migrateData

• migrateData(data): void

• Parameters

  • data: any

  Returns void