LocParserRule_Custom Interface Reference

Inheritance diagram for LocParserRule_Custom:

Public Member Functions
override bool	Evaluate (string fileName, string varName, array< BaseContainer > objects)
	Check if the string can be localized according to this rule.
override string	GetID (string fileName, string varName, array< BaseContainer > objects, array< int > indexes)
	Get intended ID of the string.
void	LocParserRule_Custom ()
Public Member Functions inherited from LocParserRule
string	GetID (string fileName, string varName, array< BaseContainer > objects, array< int > indexes)
	Get intended ID of the string.
bool	Evaluate (string fileName, string varName, array< BaseContainer > objects)
	Check if the string can be localized according to this rule.
BaseContainer	Localize (string fileName, string varName, array< BaseContainer > objects, string id, string text)
	Check if the string can be localized according to this rule.
void	InitRule (notnull LocParserManager config)

Protected Member Functions
void	RemoveExpression (out string text)

Protected Attributes
string	m_sIdFormat
string	m_sRemove
string	m_sVarName
string	m_sParentName
int	m_iParentDepth
int	m_iParentType
ref LocParserRule_Custom_BaseParam	m_IdParam1
ref LocParserRule_Custom_BaseParam	m_IdParam2
ref LocParserRule_Custom_BaseParam	m_IdParam3
ref array< string >	m_aVarName = {}
ref array< string >	m_aRemove = {}
Protected Attributes inherited from LocParserRule
ref CustomStringTableItem	m_ItemTemplate
LocParserManager	m_Config

Constructor & Destructor Documentation

LocParserRule_Custom()

void LocParserRule_Custom.LocParserRule_Custom

(

)

Member Function Documentation

Evaluate()

override bool LocParserRule_Custom.Evaluate	(	string	fileName,
		string	varName,
		array< BaseContainer >	objects
	)

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

Implements LocParserRule.

GetID()

override string LocParserRule_Custom.GetID	(	string	fileName,
		string	varName,
		array< BaseContainer >	objects,
		array< int >	indexes
	)

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

Implements LocParserRule.

RemoveExpression()

void LocParserRule_Custom.RemoveExpression ( out string  text )

protected

Member Data Documentation

m_aRemove

ref array<string> LocParserRule_Custom.m_aRemove = {}

protected

m_aVarName

ref array<string> LocParserRule_Custom.m_aVarName = {}

protected

m_IdParam1

ref LocParserRule_Custom_BaseParam LocParserRule_Custom.m_IdParam1

protected

m_IdParam2

ref LocParserRule_Custom_BaseParam LocParserRule_Custom.m_IdParam2

protected

m_IdParam3

ref LocParserRule_Custom_BaseParam LocParserRule_Custom.m_IdParam3

protected

m_iParentDepth

int LocParserRule_Custom.m_iParentDepth

protected

m_iParentType

int LocParserRule_Custom.m_iParentType

protected

m_sIdFormat

string LocParserRule_Custom.m_sIdFormat

protected

m_sParentName

string LocParserRule_Custom.m_sParentName

protected

m_sRemove

string LocParserRule_Custom.m_sRemove

protected

m_sVarName

string LocParserRule_Custom.m_sVarName

protected

---

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

• WorkbenchGame/LocalizationEditor/LocParserRule_Custom.c