MoneyFormatter

Inherits: Class

Methods

SetColor

function MoneyFormatter:SetColor(colorPrefix)
  -> self

Sets a color prefix to use for the text components.

Parameters:

Name	Type	Description
colorPrefix	string	The color prefix string or nil to remove coloring

Returns:

Type	Description
self

SetCopperHandling

function MoneyFormatter:SetCopperHandling(handling)
  -> self

Changes how copper is handled.

Parameters:

Name	Type	Description
handling	EnumValue	How to handle copper

Returns:

Type	Description
self

SetFormat

function MoneyFormatter:SetFormat(format)
  -> self

Sets the format.

Parameters:

Name	Type	Description
format	EnumValue	The format to use

Returns:

Type	Description
self

SetTrimEnabled

function MoneyFormatter:SetTrimEnabled(enabled)
  -> self

Sets whether or not trailing 0 values should be trimmed.

Parameters:

Name	Type	Description
enabled	boolean	Whether or not trimming should be enabled

Returns:

Type	Description
self

ToString

function MoneyFormatter:ToString(value)
  -> string

Converts a money value to a string.

Parameters:

Name	Type	Description
value	number	The value in copper

Returns:

Type	Description
string

Functions

FromString

function MoneyFormatter.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 text and not icon tokens.

Parameters:

Name	Type	Description
value	string	The money value to be converted

Returns:

Type	Description
number?

GetCopperText

function MoneyFormatter.GetCopperText()
  -> string

Returns the colored copper indicator text.

Returns:

Type	Description
string

GetGoldText

function MoneyFormatter.GetGoldText()
  -> string

Returns the colored gold indicator text.

Returns:

Type	Description
string

GetLargeNumberSeparator

function MoneyFormatter.GetLargeNumberSeparator()
  -> string

Gets the large number separator.

Returns:

Type	Description
string

GetSilverText

function MoneyFormatter.GetSilverText()
  -> string

Returns the colored silver indicator text.

Returns:

Type	Description
string

New

function MoneyFormatter.New()
  -> MoneyFormatter

Creates a new money formatter.

Returns:

Type	Description
MoneyFormatter

SetLargeNumberSeparator

function MoneyFormatter.SetLargeNumberSeparator(value)

Sets the large number separator.

Parameters:

Name	Type	Description
value	string	The string value