LocParserManager Class Reference

Protected Member Functions
BaseContainer	UpdateItem (out string id, string text)
void	UpdateFromTemplate (notnull LocalizationEditor stringEditor, notnull BaseContainer item)
void	ProcessContainer (BaseContainer container, out int foundCount, array< BaseContainer > objects, array< int > indexes, string path, out int index=0)
void	Run (BaseContainer source, bool logOnly, ResourceName stringTableOverride, string prefixOverride)

Static Protected Member Functions
static void	Run (ResourceName configPath, bool logOnly, ResourceName stringTableOverride, string prefixOverride)

Protected Attributes
ResourceName	m_StringTablePath
string	m_sPrefix
string	m_sPlaceholderPrefix
ref array< ref LocParserRule >	m_aRules
ResourceName	m_sFile
string	m_sFileName
string	m_sFileExt
string	m_sFileLink
string	m_sContainerName
string	m_sContainerPath
bool	m_bLogOnly
ref map< string, string >	m_mIDs = new map<string, string>()
ref array< BaseContainer >	m_aRuleSources = {}
int	m_iCurrentRule

Static Protected Attributes
static const string	LOCALIZED_PREFIX = "#"

Detailed Description

Definition at line 2 of file LocParserManager.c.

Member Function Documentation

ProcessContainer()

void LocParserManager::ProcessContainer ( BaseContainer container, out int foundCount, array< BaseContainer > objects, array< int > indexes, string path, out int index = 0 )

inlineprotected

Parameters

[in]	container
[out]	foundCount
[in]	objects
[in]	indexes
[in]	path
[out]	index

Definition at line 202 of file LocParserManager.c.

Run() [1/2]

void LocParserManager::Run ( BaseContainer source, bool logOnly, ResourceName stringTableOverride, string prefixOverride )

inlineprotected

Parameters

[in]	source
[in]	logOnly
[in]	stringTableOverride
[in]	prefixOverride

Definition at line 324 of file LocParserManager.c.

Run() [2/2]

void LocParserManager::Run ( ResourceName configPath, bool logOnly, ResourceName stringTableOverride, string prefixOverride )

inlinestaticprotected

Run the localisation process.

Parameters

[in]	configPath	Path to LocParser manager config
[in]	logOnly	True to only log unlocolized strings, without modifying any files
[in]	stringTableOverride
[in]	prefixOverride

Definition at line 458 of file LocParserManager.c.

UpdateFromTemplate()

void LocParserManager::UpdateFromTemplate ( notnull LocalizationEditor stringEditor, notnull BaseContainer item )

inlineprotected

Parameters

[in]	stringEditor
[in]	item

Definition at line 103 of file LocParserManager.c.

UpdateItem()

BaseContainer LocParserManager::UpdateItem ( out string id, string text )

inlineprotected

Create/Update the item by provided id

Parameters

[out]	id
[in]	text

Returns

the created/updated base container or null on error

Definition at line 30 of file LocParserManager.c.

Member Data Documentation

LOCALIZED_PREFIX

const string LocParserManager::LOCALIZED_PREFIX = "#"

staticprotected

Definition at line 23 of file LocParserManager.c.

m_aRules

ref array<ref LocParserRule> LocParserManager::m_aRules

protected

Definition at line 14 of file LocParserManager.c.

m_aRuleSources

ref array<BaseContainer> LocParserManager::m_aRuleSources = {}

protected

Definition at line 20 of file LocParserManager.c.

m_bLogOnly

bool LocParserManager::m_bLogOnly

protected

Definition at line 18 of file LocParserManager.c.

m_iCurrentRule

int LocParserManager::m_iCurrentRule

protected

Definition at line 21 of file LocParserManager.c.

m_mIDs

ref map<string, string> LocParserManager::m_mIDs = new map<string, string>()

protected

Definition at line 19 of file LocParserManager.c.

m_sContainerName

string LocParserManager::m_sContainerName

protected

Definition at line 17 of file LocParserManager.c.

m_sContainerPath

string LocParserManager::m_sContainerPath

protected

Definition at line 17 of file LocParserManager.c.

m_sFile

ResourceName LocParserManager::m_sFile

protected

Definition at line 16 of file LocParserManager.c.

m_sFileExt

string LocParserManager::m_sFileExt

protected

Definition at line 17 of file LocParserManager.c.

m_sFileLink

string LocParserManager::m_sFileLink

protected

Definition at line 17 of file LocParserManager.c.

m_sFileName

string LocParserManager::m_sFileName

protected

Definition at line 17 of file LocParserManager.c.

m_sPlaceholderPrefix

string LocParserManager::m_sPlaceholderPrefix

protected

Definition at line 11 of file LocParserManager.c.

m_sPrefix

string LocParserManager::m_sPrefix

protected

Definition at line 8 of file LocParserManager.c.

m_StringTablePath

ResourceName LocParserManager::m_StringTablePath

protected

Definition at line 5 of file LocParserManager.c.

---

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

• scripts/WorkbenchGame/LocalizationEditor/LocParserManager.c