SCR_BIKIStringBuilder Class Reference

Protected Member Functions
void	AddLine (string line)
void	AddKeyValueLine (string key, string value=string.Empty)
void	AddTitle (int titleLevel, string text)
void	BeginTable (string classes="wikitable", string style=string.Empty)
void	AddTableHeadersLine (notnull array< string > titles)
void	AddTableHeadersLine (string title1, string title2=string.Empty, string title3=string.Empty, string title4=string.Empty, string title5=string.Empty)
void	AddTableHeader (string title, string classes=string.Empty, string style=string.Empty)
void	AddTableDataCellsLine (notnull array< string > data)
void	AddTableDataCellsLine (string data1, string data2=string.Empty, string data3=string.Empty, string data4=string.Empty, string data5=string.Empty)
void	AddTableDataCell (string datum, string classes=string.Empty, string style=string.Empty)
void	AddHeaderAndDataCellsLine (string title, notnull array< string > data)
void	EndTable ()
void	AddCategory (string catLv1=string.Empty, string catLv2=string.Empty, string catLv3=string.Empty, string catLv4=string.Empty, string catLv5=string.Empty)
string	GetContent ()
string	GetEscapedContent ()
void	Clear ()
	Empty the String Builder's content.
void	SCR_BIKIStringBuilder (string content=string.Empty)

Static Protected Member Functions
static string	Escape (string input)
static string	FormatMass (float massInKg)
static string	FormatSpeedMPS (float metrePerSecond)
static string	FormatSpeedKMH (float metrePerSecond)
static string	GetResourceManagerLink (ResourceName resourceName)
static string	GetScriptEditorLink (string scriptFilePath)
static string	GetWorldEditorLink (ResourceName resourceName)

Protected Attributes
string	m_sContent

Detailed Description

Definition at line 1 of file SCR_BIKIStringBuilder.c.

Constructor & Destructor Documentation

SCR_BIKIStringBuilder()

void SCR_BIKIStringBuilder::SCR_BIKIStringBuilder ( string content = string.Empty )

inlineprotected

Definition at line 392 of file SCR_BIKIStringBuilder.c.

Member Function Documentation

AddCategory()

void SCR_BIKIStringBuilder::AddCategory ( string catLv1 = string.Empty, string catLv2 = string.Empty, string catLv3 = string.Empty, string catLv4 = string.Empty, string catLv5 = string.Empty )

inlineprotected

Add {{GameCategory|armaR}} wiki category directly after the current content (empty lines not managed)

Parameters

[in]	catLv1
[in]	catLv2
[in]	catLv3
[in]	catLv4
[in]	catLv5

Definition at line 233 of file SCR_BIKIStringBuilder.c.

AddHeaderAndDataCellsLine()

void SCR_BIKIStringBuilder::AddHeaderAndDataCellsLine ( string title, notnull array< string > data )

inlineprotected

Add a title header followed by provided data (horizontal, line)

See also

BeginTable()

EndTable()

Parameters

[in]	title
[in]	data

Definition at line 206 of file SCR_BIKIStringBuilder.c.

AddKeyValueLine()

void SCR_BIKIStringBuilder::AddKeyValueLine ( string key, string value = string.Empty )

inlineprotected

Add a text line in format "|key= value" (or "|key=" if value is empty)

Parameters

[in]	key	if empty, adds nothing
[in]	value

Definition at line 17 of file SCR_BIKIStringBuilder.c.

AddLine()

void SCR_BIKIStringBuilder::AddLine ( string line )

inlineprotected

Add text line that gets ended by a line return

Parameters

[in]

line

Definition at line 8 of file SCR_BIKIStringBuilder.c.

AddTableDataCell()

void SCR_BIKIStringBuilder::AddTableDataCell ( string datum, string classes = string.Empty, string style = string.Empty )

inlineprotected

This method allows an empty data cell

Parameters

[in]	datum
[in]	classes	cell's CSS classes
[in]	style	cell's CSS

Definition at line 179 of file SCR_BIKIStringBuilder.c.

AddTableDataCellsLine() [1/2]

void SCR_BIKIStringBuilder::AddTableDataCellsLine ( notnull array< string > data )

inlineprotected

Add a table line of cells This method allows empty data cells

See also

BeginTable()

EndTable()

Parameters

[in]

data

Definition at line 142 of file SCR_BIKIStringBuilder.c.

AddTableDataCellsLine() [2/2]

void SCR_BIKIStringBuilder::AddTableDataCellsLine ( string data1, string data2 = string.Empty, string data3 = string.Empty, string data4 = string.Empty, string data5 = string.Empty )

inlineprotected

Add a table line of cells This method forbids empty data cells and stops on the first encountered one

See also

BeginTable()

EndTable()

Parameters

[in]	data1
[in]	data2
[in]	data3
[in]	data4
[in]	data5

Definition at line 161 of file SCR_BIKIStringBuilder.c.

AddTableHeader()

void SCR_BIKIStringBuilder::AddTableHeader ( string title, string classes = string.Empty, string style = string.Empty )

inlineprotected

This method allows an empty header

Parameters

[in]	title
[in]	classes
[in]	style

Definition at line 118 of file SCR_BIKIStringBuilder.c.

AddTableHeadersLine() [1/2]

void SCR_BIKIStringBuilder::AddTableHeadersLine ( notnull array< string > titles )

inlineprotected

This method allows empty headers

Parameters

[in]

titles

list of titles to display on one line

Definition at line 85 of file SCR_BIKIStringBuilder.c.

AddTableHeadersLine() [2/2]

void SCR_BIKIStringBuilder::AddTableHeadersLine ( string title1, string title2 = string.Empty, string title3 = string.Empty, string title4 = string.Empty, string title5 = string.Empty )

inlineprotected

Add a table line of header cells This method forbids empty headers and stops on the first encountered one

See also

BeginTable()

EndTable()

Definition at line 101 of file SCR_BIKIStringBuilder.c.

AddTitle()

void SCR_BIKIStringBuilder::AddTitle ( int titleLevel, string text )

inlineprotected

Add a wiki title (e.g == title lv 2 ==)

Parameters

[in]	titleLevel	in range 1..6
[in]	text	can be empty (e.g == ==)

Definition at line 34 of file SCR_BIKIStringBuilder.c.

BeginTable()

void SCR_BIKIStringBuilder::BeginTable ( string classes = "wikitable", string style = string.Empty )

inlineprotected

Begin a wiki table

See also

EndTable()

Parameters

[in]

style

Definition at line 70 of file SCR_BIKIStringBuilder.c.

Clear()

void SCR_BIKIStringBuilder::Clear ( )

inlineprotected

Empty the String Builder's content.

Definition at line 265 of file SCR_BIKIStringBuilder.c.

EndTable()

void SCR_BIKIStringBuilder::EndTable ( )

inlineprotected

Add the end of a previously opened table

See also

BeginTable()

Definition at line 220 of file SCR_BIKIStringBuilder.c.

Escape()

string SCR_BIKIStringBuilder::Escape ( string input )

inlinestaticprotected

Parameters

[in]

input

Returns

Definition at line 278 of file SCR_BIKIStringBuilder.c.

FormatMass()

string SCR_BIKIStringBuilder::FormatMass ( float massInKg )

inlinestaticprotected

Parameters

[in]

massInKg

Returns

Definition at line 291 of file SCR_BIKIStringBuilder.c.

FormatSpeedKMH()

string SCR_BIKIStringBuilder::FormatSpeedKMH ( float metrePerSecond )

inlinestaticprotected

Parameters

[in]

metrePerSecond

Returns

Definition at line 327 of file SCR_BIKIStringBuilder.c.

FormatSpeedMPS()

string SCR_BIKIStringBuilder::FormatSpeedMPS ( float metrePerSecond )

inlinestaticprotected

Parameters

[in]

metrePerSecond

Returns

Definition at line 309 of file SCR_BIKIStringBuilder.c.

GetContent()

string SCR_BIKIStringBuilder::GetContent ( )

inlineprotected

Returns

the content so far

Definition at line 251 of file SCR_BIKIStringBuilder.c.

GetEscapedContent()

string SCR_BIKIStringBuilder::GetEscapedContent ( )

inlineprotected

Returns

the escaped content

Definition at line 258 of file SCR_BIKIStringBuilder.c.

GetResourceManagerLink()

string SCR_BIKIStringBuilder::GetResourceManagerLink ( ResourceName resourceName )

inlinestaticprotected

Parameters

[in]

resourceName

Returns

Definition at line 357 of file SCR_BIKIStringBuilder.c.

GetScriptEditorLink()

string SCR_BIKIStringBuilder::GetScriptEditorLink ( string scriptFilePath )

inlinestaticprotected

Parameters

[in]

scriptFilePath

RELATIVE file path, only accepts .c files - returns empty string on any other type

Returns

Definition at line 368 of file SCR_BIKIStringBuilder.c.

GetWorldEditorLink()

string SCR_BIKIStringBuilder::GetWorldEditorLink ( ResourceName resourceName )

inlinestaticprotected

Parameters

[in]

resourceName

only accepts .ent (world) and .et (Prefab) - returns empty string if anything else

Returns

Definition at line 379 of file SCR_BIKIStringBuilder.c.

Member Data Documentation

m_sContent

string SCR_BIKIStringBuilder::m_sContent

protected

Definition at line 3 of file SCR_BIKIStringBuilder.c.

---

The documentation for this class was generated from the following file:

• scripts/WorkbenchGame/ResourceManager/BIKI/SCR_BIKIStringBuilder.c