LocParserRule Class Reference

Inheritance diagram for LocParserRule:

Protected Member Functions
string	GetID (string fileName, string varName, array< BaseContainer > objects, array< int > indexes)
bool	Evaluate (string fileName, string varName, array< BaseContainer > objects)
BaseContainer	Localize (string fileName, string varName, array< BaseContainer > objects, string id, string text)
void	InitRule (notnull LocParserManager config)

Protected Attributes
ref CustomStringTableItem	m_ItemTemplate
LocParserManager	m_Config

Detailed Description

Localisation rule controlled by LocParserManager. When parsing files, each found string is evaluated towards all available rules.

Definition at line 4 of file LocParserRule.c.

Member Function Documentation

Evaluate()

bool LocParserRule::Evaluate ( string fileName, string varName, array< BaseContainer > objects )

inlineprotected

Check if the string can be localized according to this rule. To be overloaded by inherited classes.

Parameters

[in]	fileName	Name of the file (without path or extension) in which the string is
[in]	varName	Name of the variable which holds the string
[in]	objects	Hierarchy of script classes leading to the string, starting from the bottom-most one

Returns

True if the string can be localized

Definition at line 31 of file LocParserRule.c.

GetID()

string LocParserRule::GetID ( string fileName, string varName, array< BaseContainer > objects, array< int > indexes )

inlineprotected

Get intended ID of the string. To be overloaded by inherited classes.

Parameters

[in]	fileName	Name of the file (without path or extension) in which the string is
[in]	varName	Name of the variable which holds the string
[in]	objects	Hierarchy of script classes leading to the string, starting from the bottom-most one
[out]	index	Item index (when in array)

Returns

Localization ID

Definition at line 19 of file LocParserRule.c.

InitRule()

void LocParserRule::InitRule ( notnull LocParserManager config )

inlineprotected

Parameters

[in]

config

Definition at line 53 of file LocParserRule.c.

Localize()

BaseContainer LocParserRule::Localize ( string fileName, string varName, array< BaseContainer > objects, string id, string text )

inlineprotected

Check if the string can be localized according to this rule. To be overloaded by inherited classes.

Parameters

[in]	fileName	Name of the file (without path or extension) in which the string is
[in]	varName	Name of the variable which holds the string
[in]	objects	Hierarchy of script classes leading to the string, starting from the bottom-most one
[in]	id	Intended localization ID
[in]	text	Content of the string

Returns

Newly added container (can be null if no new container was added, e.g., when only logging or when it already existed in the database)

Definition at line 45 of file LocParserRule.c.

Member Data Documentation

m_Config

LocParserManager LocParserRule::m_Config

protected

Definition at line 9 of file LocParserRule.c.

m_ItemTemplate

ref CustomStringTableItem LocParserRule::m_ItemTemplate

protected

Definition at line 7 of file LocParserRule.c.

---

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

• scripts/WorkbenchGame/LocalizationEditor/LocParserRule.c