Class ItemChange

constructor

• new ItemChange(data, parent): ItemChange

• Parameters

  • data: any

  • parent: any

  Returns ItemChange

data

parent

updateTime

_id

• get _id(): any

• Returns any

continuous

• get continuous(): any

• Returns any

flavor

• get flavor(): any

• Returns any

formula

• get formula(): any

• Returns any

id

• get id(): any

• Returns any

isAC

• get isAC(): boolean

• Returns boolean

isDeferred

• get isDeferred(): boolean

• Returns boolean

modifier

• get modifier(): any

• Returns any

operator

• get operator(): any

• Returns any

priority

• get priority(): any

• Returns any

source

• get source(): any

• Returns any

subTarget

• get subTarget(): "fort" | "ref" | "will" | "skills" | "attack" | "damage" | "acpA" | "acpS" | "mDexA" | "mDexS" | "reach" | "str" | "dex" | "con" | "int" | "wis" | "cha" | "strMod" | "dexMod" | "conMod" | "intMod" | "wisMod" | "chaMod" | "unskills" | "carryStr" | "carryMult" | "strSkills" | "dexSkills" | "conSkills" | "intSkills" | "wisSkills" | "chaSkills" | "allChecks" | "strChecks" | "dexChecks" | "conChecks" | "intChecks" | "wisChecks" | "chaChecks" | "landSpeed" | "climbSpeed" | "swimSpeed" | "burrowSpeed" | "flySpeed" | "allSpeeds" | "ac" | "aac" | "sac" | "nac" | "tac" | "ffac" | "bab" | "~attackCore" | "mattack" | "nattack" | "rattack" | "tattack" | "wdamage" | "mwdamage" | "rwdamage" | "twdamage" | "rdamage" | "mdamage" | "ndamage" | "sdamage" | "critConfirm" | "allSavingThrows" | "cmb" | "cmd" | "ffcmd" | "init" | "mhp" | "wounds" | "vigor" | "spellResist" | "bonusFeats" | "bonusSkillRanks" | "concentration" | "cl"

• Returns "fort" | "ref" | "will" | "skills" | "attack" | "damage" | "acpA" | "acpS" | "mDexA" | "mDexS" | "reach" | "str" | "dex" | "con" | "int" | "wis" | "cha" | "strMod" | "dexMod" | "conMod" | "intMod" | "wisMod" | "chaMod" | "unskills" | "carryStr" | "carryMult" | "strSkills" | "dexSkills" | "conSkills" | "intSkills" | "wisSkills" | "chaSkills" | "allChecks" | "strChecks" | "dexChecks" | "conChecks" | "intChecks" | "wisChecks" | "chaChecks" | "landSpeed" | "climbSpeed" | "swimSpeed" | "burrowSpeed" | "flySpeed" | "allSpeeds" | "ac" | "aac" | "sac" | "nac" | "tac" | "ffac" | "bab" | "~attackCore" | "mattack" | "nattack" | "rattack" | "tattack" | "wdamage" | "mwdamage" | "rwdamage" | "twdamage" | "rdamage" | "mdamage" | "ndamage" | "sdamage" | "critConfirm" | "allSavingThrows" | "cmb" | "cmd" | "ffcmd" | "init" | "mhp" | "wounds" | "vigor" | "spellResist" | "bonusFeats" | "bonusSkillRanks" | "concentration" | "cl"

value

• get value(): any

• Returns any

Static defaultData

• get defaultData(): {
      _id: string;
      flavor: undefined;
      formula: string;
      modifier: string;
      operator: string;
      priority: number;
      subTarget: string;
      value: number;
  }

• Returns {
      _id: string;
      flavor: undefined;
      formula: string;
      modifier: string;
      operator: string;
      priority: number;
      subTarget: string;
      value: number;
  }

  • _id: string

  • flavor: undefined

  • formula: string

  • modifier: string

  • operator: string

  • priority: number

  • subTarget: string

  • value: number

_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;
    } = {}

    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

applySourceInfo

• applySourceInfo(actor): 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}

  Returns void

createFunction

• createFunction(funcDef, funcArgs?): any

• Parameters

  • funcDef: any

  • funcArgs: any[] = []

  Returns 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

preUpdate

• preUpdate(data): any

• Parameters

  • data: any

  Returns any

prepareData

• prepareData(): void

• Returns void

update

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

• Parameters

  • data: any

  • options: {} = {}

  Returns Promise<any>

Static create

• create(data, context?): Promise<any[]>

• 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 Promise<any[]>

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