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

• Returns string

Static defaultOptions

• get defaultOptions(): InsertKeys<{
      baseApplication: null | string;
      classes: string[];
      closeOnSubmit: boolean;
      dragDrop: Omit<DragDropConfiguration, "permissions" | "callbacks">[];
      editable: boolean;
      filters: Omit<SearchFilterConfiguration, "callback">[];
      height: number;
      id: string;
      left: null | number;
      minimizable: boolean;
      popOut: boolean;
      resizable: boolean;
      scale: null | number;
      scrollY: string[];
      sheetConfig: boolean;
      submitOnChange: boolean;
      submitOnClose: boolean;
      tabs: Omit<TabsConfiguration, "callback">[];
      template: string;
      title: string;
      top: null | number;
      width: number;
  }, OmitByValue<{
      classes: string[];
      height: number;
      template: string;
      width: number;
  }, never>>

• Returns InsertKeys<{
      baseApplication: null | string;
      classes: string[];
      closeOnSubmit: boolean;
      dragDrop: Omit<DragDropConfiguration, "permissions" | "callbacks">[];
      editable: boolean;
      filters: Omit<SearchFilterConfiguration, "callback">[];
      height: number;
      id: string;
      left: null | number;
      minimizable: boolean;
      popOut: boolean;
      resizable: boolean;
      scale: null | number;
      scrollY: string[];
      sheetConfig: boolean;
      submitOnChange: boolean;
      submitOnClose: boolean;
      tabs: Omit<TabsConfiguration, "callback">[];
      template: string;
      title: string;
      top: null | number;
      width: number;
  }, OmitByValue<{
      classes: string[];
      height: number;
      template: string;
      width: number;
  }, never>>

Static order

• 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

• Parameters

  • event: any

  • formData: any

  Returns void

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

Static convert

• 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

Static transfer

• 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

  • Optional allowConversion: number = false

    Attempts to make change with sourceDoc's currency limit

  Returns boolean | object

  false if failed, object containing amount transferred on success