Class CurrencyTransfer

constructor

dest

source

promise

• get promise(): Promise<any>

  Returns Promise<any>

Staticorder

• get order(): ("gp" | "cp" | "pp" | "sp")[]

  Order of coin types, descending in value

  Returns ("gp" | "cp" | "pp" | "sp")[]

Static_onDirectoryDrop

• _onDirectoryDrop(
      event: DragEvent,
      dropData: object,
      target: Actor<"base" | ModuleSubType> | Item<"base" | ModuleSubType>,
  ): Promise<void>
  Internal Alpha

  Parameters

  • event: DragEvent

    Drag event

  • dropData: object

    Drop data

  • target: Actor<"base" | ModuleSubType> | Item<"base" | ModuleSubType>

    Target document

  Returns Promise<void>

Static_onFail

• _onFail(i18nKey: string): undefined

  Error message handler

  Parameters

  • i18nKey: string

  Returns undefined

Staticconvert

• convert(limit: object, totalAmount: number | object): boolean | object

  Convert totalAmount to object

  Parameters

  • limit: object

    currency object containing max number of coins. Falsey values will assume infinity

  • totalAmount: number | object

    currency as gold pieces. If provided as a currency object, will convert to gold

  Returns boolean | object

  false if failed, currency object containing new amounts on conversion success

Statictransfer

• transfer(
      sourceDoc: Document,
      destDoc: Document,
      amount: number | object,
      sourceAlt?: boolean,
      destAlt?: boolean,
      allowConversion?: number,
  ): Promise<boolean | object>

  Transfer an amount of currency to a valid document

  Parameters

  • sourceDoc: Document

    ActorPF or ItemPF with currency

  • destDoc: Document

    ActorPF or ItemPF with currency

  • amount: number | object

    currency object containing transferred amount. Undefined keys will be assumed to be zero. Providing just a number will assume just gold

  • sourceAlt: boolean = false

    Use alt currency on source

  • destAlt: boolean = false

    Use alt currency on destination

  • OptionalallowConversion: number = false

    Attempts to make change with sourceDoc's currency limit

  Returns Promise<boolean | object>

  false if failed, object containing amount transferred on success

Staticwait

• wait(source: any, dest: any, options: any): Promise<void>

  Initialize transfer and wait for it to finish

  Parameters

  • source: any
  • dest: any
  • options: any

  Returns Promise<void>