Class ItemConditional

constructor

• new ItemConditional(data: any, options: any): ItemConditional

• Parameters

  • data: any
  • options: any

  Returns ItemConditional

_id

Optionaldefault

Optionalmodifiers

name

Static Readonly Internalmetadata

id

• get id(): string

• Returns string

uuid

• get uuid(): string

• Retrieve UUID

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

  Returns string

StaticdefaultData

• get defaultData(): any

• Returns any

_configure

• _configure(options: any): void

• Parameters

  • options: any

  Returns void

_prepareModifiers

• _prepareModifiers(): void
• Internal

  Returns void

delete

• delete(): Promise<any>

• Delete conditional

  Returns Promise<any>

getEmbeddedDocument

• getEmbeddedDocument(
      embeddedName: string,
      id: string,
      options?: object,
  ): undefined | ItemConditionalModifier

• For supporting modifiers in fromUuid()

  Synced with Foundry v12.331

  Parameters

  • embeddedName: string
  • id: string
  • options: object = {}

  Returns undefined | ItemConditionalModifier

prepareData

• prepareData(): void
• Internal

  Returns void

update

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

• Update conditional

  Parameters

  • updateData: object
  • options: object = {}

  Returns Promise<any>

Staticcreate

• create(
      data: object | object[],
      context?: { parent: ItemAction },
  ): Proimise<ItemConditional[]>

• Create new conditional

  Parameters

  • data: object | object[]

    Data to create conditional(s) from.
  • context: { parent: ItemAction } = {}

    Context data

    • parent: ItemAction

      Parent action to add the conditional to.

  Returns Proimise<ItemConditional[]>

  • Created conditionals

  Throws

  • If no valid parent is defined.

StaticdefineSchema

• defineSchema(): { _id: IDField; default: any; modifiers: any; name: any }

• Returns { _id: IDField; default: any; modifiers: any; name: any }

StaticpruneData

• pruneData(data: object): void
• Internal

  Parameters

  • data: object

  Returns void