Class CurrencyTransfer

constructor

• new CurrencyTransfer(
      source?: { actor: null; alt: boolean; amount: {}; container: null },
      dest?: { actor: null; alt: boolean; amount: {}; container: null },
      options?: {},
  ): CurrencyTransfer

  Parameters

  • source: { actor: null; alt: boolean; amount: {}; container: null } = ...
  • dest: { actor: null; alt: boolean; amount: {}; container: null } = ...
  • options: {} = {}

  Returns CurrencyTransfer

dest

source

title

• get title(): string

  An Application window should define its own title definition logic which may be dynamic depending on its data

  Returns string

StaticdefaultOptions

• get defaultOptions(): InsertKeys<
      {},
      {
          classes: readonly ["pf1", "currency-transfer"];
          height: 235;
          template: "systems/pf1/templates/apps/currency-transfer.hbs";
          width: 380;
      },
  >

  Assign the default options which are supported by the entity edit sheet.

  Returns InsertKeys<
      {},
      {
          classes: readonly ["pf1", "currency-transfer"];
          height: 235;
          template: "systems/pf1/templates/apps/currency-transfer.hbs";
          width: 380;
      },
  >

  The default options for this FormApplication class

  See

  Application.defaultOptions

  Default Value

  foundry.utils.mergeObject(super.defaultOptions, {
    classes: ["form"],
    closeOnSubmit: true,
    editable: true,
    sheetConfig: false,
    submitOnChange: false,
    submitOnClose: false
  });
  Copy

Staticorder

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

  Order of coin types, descending in value

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

_calcTotal

• _calcTotal(ev: any): void

  Parameters

  • ev: any

  Returns void

_curRange

• _curRange(ev: any): void

  Parameters

  • ev: any

  Returns void

_updateObject

• _updateObject(event: any, formData: any): void

  This method is called upon form submission after form data is validated

  Parameters

  • event: any

    The initial triggering submission event
  • formData: any

    The object of validated form data with which to update the object

  Returns void

  A Promise which resolves once the update operation has completed

activateListeners

• activateListeners(html: any): void

  Parameters

  • html: any

  Returns void

getData

• getData(
      _options?: {},
  ): {
      dest:
          | undefined
          | { actor: null; alt: boolean; amount: {}; container: null };
      options: Options;
      source:
          | undefined
          | { actor: null; alt: boolean; amount: {}; container: null };
      title: string;
      total: any;
  }

  Parameters

  • _options: {} = {}

  Returns {
      dest:
          | undefined
          | { actor: null; alt: boolean; amount: {}; container: null };
      options: Options;
      source:
          | undefined
          | { actor: null; alt: boolean; amount: {}; container: null };
      title: string;
      total: any;
  }

Static_directoryDrop

• _directoryDrop(
      docDestId: any,
      event: any,
  ): Promise<undefined | CurrencyTransfer>

  Parameters

  • docDestId: any
  • event: any

  Returns Promise<undefined | CurrencyTransfer>

Static_failed

• _failed(i18nKey: any): undefined

  Parameters

  • i18nKey: any

  Returns undefined

Staticconvert

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

  Convert totalAmount to a currency object containing

  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