StringBuilder

Inherits: Class

Methods

Commit

function StringBuilder:Commit()
  -> string

Commits the string builder and returns the generated string.

Returns:

Type	Description
string

GetParamCount

function StringBuilder:GetParamCount(name)
  -> number

Gets the number of occurrences of a parameter in the template.

Parameters:

Name	Type	Description
name	string	The parameter name

Returns:

Type	Description
number

SetParam

function StringBuilder:SetParam(name, value)
  -> self

Sets the value of a named parameter.

Parameters:

Name	Type	Description
name	string	The parameter name
value	any	The parameter value

Returns:

Type	Description
self

SetTemplate

function StringBuilder:SetTemplate(template)
  -> self

Sets the template.

Parameters:

Name	Type	Description
template	string	The template string to format

Returns:

Type	Description
self

Functions

Create

function StringBuilder.Create()
  -> StringBuilder

Creates a new string builder object.

Returns:

Type	Description
StringBuilder