Money

Inherits: LibTSMModule

Functions

FromString

function UI.Money.FromString(value)
  -> number?

Converts a string money value to a number value (in copper). The value passed to this function can contain colored text, but must use g/s/c for the denominations and not icons.

Parameters:

Name	Type	Description
value	string	The money value to be converted as a string

Returns:

Type	Description
number?

ToStringExact

function UI.Money.ToStringExact(value, color)
  -> string

Converts a money value to a string with maximum precision.

Parameters:

Name	Type	Description
value	number	The value in copper
color	string	An optional color value

Returns:

Type	Description
string

ToStringForAH

function UI.Money.ToStringForAH(value, color, disabled)
  -> string

Converts a money value to a string with settings suitable for the auction house.

Parameters:

Name	Type	Description
value	number	The value in copper
color	string	An optional color value
disabled	boolean	Optionally use the disabled tokens

Returns:

Type	Description
string

ToStringForTooltip

function UI.Money.ToStringForTooltip(value, color, useIcon, disabled)
  -> string

Converts a money value to a string with maximum precision.

Parameters:

Name	Type	Description
value	number	The value in copper
color	string	The color value
useIcon	boolean	Use icons instead of text
disabled	boolean	Use the disabled format

Returns:

Type	Description
string

ToStringForUI

function UI.Money.ToStringForUI(value, color)
  -> string

Converts a money value to a string with settings suitable for the UI.

Parameters:

Name	Type	Description
value	number	The value in copper
color	string	An optional color value

Returns:

Type	Description
string

ToStringForUIShort

function UI.Money.ToStringForUIShort(value)
  -> string

Converts a money value to as short of a string as possible for display in the UI.

Parameters:

Name	Type	Description
value	number	The value in copper

Returns:

Type	Description
string