Inheritance diagram for SCR_ClassRenamingPlugin:

Public Member Functions
override void	Run ()

array< string >	GetAllEditableScriptFilesAbsolutePaths (notnull array< string > scriptDirectories)

array< ref SCR_ClassRenamingParam >	GetFromToParams ()

map< string, string >	GetFromToMap (notnull map< string, string > classFiles)

int	RenameInFiles (notnull array< string > absolutePaths, array< ref SCR_ClassRenamingParam > fromToParams, map< string, string > fromToMap, string progressBarText="Processing %1 files")
	Whether the classes exist or not in script, rename them.

string	GetNewClassNameIfMatch (string className, notnull array< ref SCR_ClassRenamingParam > fromToParams)

int	ButtonRunAll ()

int	ButtonRun ()

int	ButtonCancel ()

Protected Member Functions
bool	CheckAndSetParameters ()

array< string >	GetAllEditableFilesAbsolutePaths (notnull array< string > directories, string extension)

map< string, string >	GetClassesFromFiles (notnull array< string > absoluteScriptFilePaths)
	Get classes from the provided script files.

array< string >	GetClassesFromFile (string absoluteFilePath)

int	RenameInLines (out notnull array< string > lines, array< ref SCR_ClassRenamingParam > fromToParams, map< string, string > fromToMap)

Protected Attributes
bool	m_bOnlyRenameExistingEditableClasses

bool	m_bClassMustStartWithACapitalLetter

bool	m_bProcessScriptFiles

bool	m_bProcessConfigFiles

bool	m_bProcessPrefabFiles

bool	m_bProcessLayerFiles

bool	m_bDemoMode

ref array< ref SCR_ClassRenamingParam >	m_aParameters

ref array< string >	m_aScriptDirectories

ref array< string >	m_aConfigDirectories

ref array< string >	m_aPrefabDirectories

ref array< string >	m_aLayerDirectories

int	m_iMode = -1

ref map< string, string >	m_mClassesLocation

Static Protected Attributes
static const int	THIS_FILE = 0

static const int	ALL_FILES = 1

static const int	MODE_PMATCH = 0
	perfect match "SEARCH"

static const int	MODE_PREFIX = 1
	prefix match "SEARCHothervalue"

static const int	MODE_SUFFIX = 2
	suffix match "othervalueSEARCH"

static const int	MODE_MIDDLE = 3
	middle match "otherSEARCHvalue" - MUST have a start AND an end

static const string	CLASS_CHARS = SCR_StringHelper.LETTERS + SCR_StringHelper.DIGITS + SCR_StringHelper.UNDERSCORE

static const ref array< string >	KEYWORDS

Member Function Documentation

◆ ButtonCancel()

int SCR_ClassRenamingPlugin.ButtonCancel ( )

Returns

◆ ButtonRun()

int SCR_ClassRenamingPlugin.ButtonRun ( )

Returns

◆ ButtonRunAll()

int SCR_ClassRenamingPlugin.ButtonRunAll ( )

Returns

◆ CheckAndSetParameters()

bool SCR_ClassRenamingPlugin.CheckAndSetParameters ( )

protected

Returns: true if parameters are acceptable, false otherwise

◆ GetAllEditableFilesAbsolutePaths()

array< string > SCR_ClassRenamingPlugin.GetAllEditableFilesAbsolutePaths	(	notnull array< string >	directories,
		string	extension )

protected

Parameters

[in]	directories
[in]	extension	without dot, e.g 'conf'

Returns: all EDITABLE config files' absolute paths

◆ GetAllEditableScriptFilesAbsolutePaths()

array< string > SCR_ClassRenamingPlugin.GetAllEditableScriptFilesAbsolutePaths ( notnull array< string > scriptDirectories )

Parameters

[in] scriptDirectories

Returns: all EDITABLE script files' absolute paths

◆ GetClassesFromFile()

array< string > SCR_ClassRenamingPlugin.GetClassesFromFile ( string absoluteFilePath )

protected

Parameters

[in] absoluteFilePath the absolute path of the file to scan for classes

Returns: an array of found classes or null on error

◆ GetClassesFromFiles()

map< string, string > SCR_ClassRenamingPlugin.GetClassesFromFiles ( notnull array< string > absoluteScriptFilePaths )

protected

Get classes from the provided script files.

Parameters

[in] absoluteScriptFilePaths

Returns: a className -> absoluteFilePath map - never returns null

◆ GetFromToMap()

map< string, string > SCR_ClassRenamingPlugin.GetFromToMap ( notnull map< string, string > classFiles )

Parameters

[in] classFiles className->absoluteFilePath map - only class name is used

Returns: the conversion map, fromClassName->toClassName - never returns null

◆ GetFromToParams()

array< ref SCR_ClassRenamingParam > SCR_ClassRenamingPlugin.GetFromToParams ( )

Parameters

[in] classFiles className->absoluteFilePath map - only class name is used

Returns: the conversion map, fromClassName -> toClassName - never returns null

◆ GetNewClassNameIfMatch()

string SCR_ClassRenamingPlugin.GetNewClassNameIfMatch	(	string	className,
		notnull array< ref SCR_ClassRenamingParam >	fromToParams )

Parameters

[in]	className
[in]	fromToParams

Returns: empty string if no matching param was found

◆ RenameInFiles()

int SCR_ClassRenamingPlugin.RenameInFiles	(	notnull array< string >	absolutePaths,
		array< ref SCR_ClassRenamingParam >	fromToParams,
		map< string, string >	fromToMap,
		string	progressBarText = "Processing %1 files" )

Whether the classes exist or not in script, rename them.

Parameters

[in]	absolutePaths
[in]	fromToParams
[in]	fromToMap
[in]	progressBarText

Returns: number of replacements

◆ RenameInLines()

int SCR_ClassRenamingPlugin.RenameInLines	(	out notnull array< string >	lines,
		array< ref SCR_ClassRenamingParam >	fromToParams,
		map< string, string >	fromToMap )

protected

Parameters

[in]	fromToParams
[in]	lines

Returns

◆ Run()

override void SCR_ClassRenamingPlugin.Run ( )

Member Data Documentation

◆ ALL_FILES

const int SCR_ClassRenamingPlugin.ALL_FILES = 1

staticprotected

◆ CLASS_CHARS

const string SCR_ClassRenamingPlugin.CLASS_CHARS = SCR_StringHelper.LETTERS + SCR_StringHelper.DIGITS + SCR_StringHelper.UNDERSCORE

staticprotected

◆ KEYWORDS

const ref array<string> SCR_ClassRenamingPlugin.KEYWORDS

staticprotected

Initial value:

= {
        "auto", "autoptr", "class", "const", "continue",
        "delete", "else", "event", "extends", "external",
        "for", "foreach", "if", "inout", "modded",
        "native", "new", "notnull", "null", "out",
        "override", "owned", "private", "protected", "proto",
        "ref", "reference", "return", "sealed", "static",
        "super", "switch", "this", "thread", "typedef",
        "vanilla", "volatile", "while",
    }

◆ m_aConfigDirectories

ref array<string> SCR_ClassRenamingPlugin.m_aConfigDirectories

protected

◆ m_aLayerDirectories

ref array<string> SCR_ClassRenamingPlugin.m_aLayerDirectories

protected

◆ m_aParameters

ref array<ref SCR_ClassRenamingParam> SCR_ClassRenamingPlugin.m_aParameters

protected

◆ m_aPrefabDirectories

ref array<string> SCR_ClassRenamingPlugin.m_aPrefabDirectories

protected

◆ m_aScriptDirectories

ref array<string> SCR_ClassRenamingPlugin.m_aScriptDirectories

protected

◆ m_bClassMustStartWithACapitalLetter

bool SCR_ClassRenamingPlugin.m_bClassMustStartWithACapitalLetter

protected

◆ m_bDemoMode

bool SCR_ClassRenamingPlugin.m_bDemoMode

protected

◆ m_bOnlyRenameExistingEditableClasses

bool SCR_ClassRenamingPlugin.m_bOnlyRenameExistingEditableClasses

protected

◆ m_bProcessConfigFiles

bool SCR_ClassRenamingPlugin.m_bProcessConfigFiles

protected

◆ m_bProcessLayerFiles

bool SCR_ClassRenamingPlugin.m_bProcessLayerFiles

protected

◆ m_bProcessPrefabFiles

bool SCR_ClassRenamingPlugin.m_bProcessPrefabFiles

protected

◆ m_bProcessScriptFiles

bool SCR_ClassRenamingPlugin.m_bProcessScriptFiles

protected

◆ m_iMode

int SCR_ClassRenamingPlugin.m_iMode = -1

protected

◆ m_mClassesLocation

ref map<string, string> SCR_ClassRenamingPlugin.m_mClassesLocation

protected

◆ MODE_MIDDLE

const int SCR_ClassRenamingPlugin.MODE_MIDDLE = 3

staticprotected

middle match "otherSEARCHvalue" - MUST have a start AND an end

◆ MODE_PMATCH

const int SCR_ClassRenamingPlugin.MODE_PMATCH = 0

staticprotected

perfect match "SEARCH"

◆ MODE_PREFIX

const int SCR_ClassRenamingPlugin.MODE_PREFIX = 1

staticprotected

prefix match "SEARCHothervalue"

◆ MODE_SUFFIX

const int SCR_ClassRenamingPlugin.MODE_SUFFIX = 2

staticprotected

suffix match "othervalueSEARCH"

◆ THIS_FILE

const int SCR_ClassRenamingPlugin.THIS_FILE = 0

staticprotected

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

WorkbenchGame/ScriptEditor/SCR_ClassRenamingPlugin.c

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Function Documentation

◆ ButtonCancel()

◆ ButtonRun()

◆ ButtonRunAll()

◆ CheckAndSetParameters()

◆ GetAllEditableFilesAbsolutePaths()

◆ GetAllEditableScriptFilesAbsolutePaths()

◆ GetClassesFromFile()

◆ GetClassesFromFiles()

◆ GetFromToMap()

◆ GetFromToParams()

◆ GetNewClassNameIfMatch()

◆ RenameInFiles()

◆ RenameInLines()

◆ Run()

Member Data Documentation

◆ ALL_FILES

◆ CLASS_CHARS

◆ KEYWORDS

◆ m_aConfigDirectories

◆ m_aLayerDirectories

◆ m_aParameters

◆ m_aPrefabDirectories

◆ m_aScriptDirectories

◆ m_bClassMustStartWithACapitalLetter

◆ m_bDemoMode

◆ m_bOnlyRenameExistingEditableClasses

◆ m_bProcessConfigFiles

◆ m_bProcessLayerFiles

◆ m_bProcessPrefabFiles

◆ m_bProcessScriptFiles

◆ m_iMode

◆ m_mClassesLocation

◆ MODE_MIDDLE

◆ MODE_PMATCH

◆ MODE_PREFIX

◆ MODE_SUFFIX

◆ THIS_FILE