Class CurrencyTransfer

constructor

• new CurrencyTransfer(source?, dest?, options?): CurrencyTransfer

• Parameters

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

    • actor: null

    • alt: boolean

    • amount: {}

    • container: null

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

    • 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<{}, OmitByValue<{
      classes: string[];
      height: number;
      template: string;
      width: number;
  }, never>>

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

  Returns InsertKeys<{}, OmitByValue<{
      classes: string[];
      height: number;
      template: string;
      width: number;
  }, never>>

  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(): (
      | "pp"
      | "gp"
      | "sp"
      | "cp")[]

• Order of coin types, descending in value

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

_calcTotal

• _calcTotal(ev): void

• Parameters

  • ev: any

  Returns void

_curRange

• _curRange(ev): void

• Parameters

  • ev: any

  Returns void

_updateObject

• _updateObject(event, formData): 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): void

• Parameters

  • html: any

  Returns void

close

• close(...args): Promise<void>

• Parameters

  • Rest...args: any[]

  Returns Promise<void>

getData

• getData(_options?): {
      dest: undefined | {
          actor: null;
          alt: boolean;
          amount: {};
          container: null;
      };
      options: FormApplicationOptions;
      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: FormApplicationOptions;
      source: undefined | {
          actor: null;
          alt: boolean;
          amount: {};
          container: null;
      };
      title: string;
      total: any;
  }

  • dest: undefined | {
        actor: null;
        alt: boolean;
        amount: {};
        container: null;
    }

  • options: FormApplicationOptions

  • source: undefined | {
        actor: null;
        alt: boolean;
        amount: {};
        container: null;
    }

  • title: string

  • total: any

Static_directoryDrop

• _directoryDrop(docDestId, event): Promise<unknown>

• Parameters

  • docDestId: any
  • event: any

  Returns Promise<unknown>

Static_failed

• _failed(i18nKey): undefined

• Parameters

  • i18nKey: any

  Returns undefined

Staticconvert

• convert(limit, totalAmount): 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, destDoc, amount, sourceAlt?, destAlt?, allowConversion?): 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 boolean | object

  false if failed, object containing amount transferred on success