LocParserManager Interface Reference

Public Member Functions
BaseContainer	UpdateItem (out string id, string text)
	Create/Update the item by provided id.

Static Public Member Functions
static void	Run (ResourceName configPath, bool logOnly, ResourceName stringTableOverride, string prefixOverride)
	Run the localisation process.

Static Public Attributes
static const string	LOCALIZED_PREFIX = "#"

Protected Member Functions
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)

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

Member Function Documentation

ProcessContainer()

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

protected

Parameters

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

Run() [1/2]

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

protected

Parameters

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

Run() [2/2]

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

static

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

UpdateFromTemplate()

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

protected

Parameters

[in]	stringEditor
[in]	item

UpdateItem()

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

Create/Update the item by provided id.

Parameters

[out]	id
[in]	text

Returns

the created/updated base container or null on error

Member Data Documentation

LOCALIZED_PREFIX

const string LocParserManager.LOCALIZED_PREFIX = "#"

static

m_aRules

ref array<ref LocParserRule> LocParserManager.m_aRules

protected

m_aRuleSources

ref array<BaseContainer> LocParserManager.m_aRuleSources = {}

protected

m_bLogOnly

bool LocParserManager.m_bLogOnly

protected

m_iCurrentRule

int LocParserManager.m_iCurrentRule

protected

m_mIDs

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

protected

m_sContainerName

string LocParserManager.m_sContainerName

protected

m_sContainerPath

string LocParserManager.m_sContainerPath

protected

m_sFile

ResourceName LocParserManager.m_sFile

protected

m_sFileExt

string LocParserManager.m_sFileExt

protected

m_sFileLink

string LocParserManager.m_sFileLink

protected

m_sFileName

string LocParserManager.m_sFileName

protected

m_sPlaceholderPrefix

string LocParserManager.m_sPlaceholderPrefix

protected

m_sPrefix

string LocParserManager.m_sPrefix

protected

m_StringTablePath

ResourceName LocParserManager.m_StringTablePath

protected

---

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

• WorkbenchGame/LocalizationEditor/LocParserManager.c