Smart Localization  2.3
SmartLocalization.Editor.LocalizationWorkspace Class Reference

Contains and creates all the directory and file information about the workspace More...

Static Public Member Functions

static bool Create ()
 Creates a new workspace. Returns false if a workspace already exists More...
 
static bool GenerateCultureInfoCollection (SmartCultureInfoCollection previousCollection)
 Generates the SmartCultureInfoCollection xml with all the available language infos and keeps any difference in old data as well. More...
 
static bool GenerateCultureInfoCollection ()
 Generates the SmartCultureInfoCollection xml with all the available language infos More...
 
static bool Exists ()
 Checks if there is an existing workspace More...
 
static string WorkspaceFolderPath ()
 Returns the path to the workspace folder More...
 
static string AutoGeneratedFolderPath ()
 Returns the path to the AutoGenerated folder More...
 
static string DataFolderPath ()
 Returns the path to the Data folder More...
 
static string LanguageDataFolderPath ()
 Returns the path to the LanguageData folder More...
 
static string CultureInfoDataFolderPath ()
 Returns the path to the CultureInfoData folder More...
 
static string CultureInfoCollectionFilePath ()
 Returns the path to the CultureInfoCollection More...
 
static string RootLanguageFilePath ()
 Returns the path to the root language file More...
 
static string LanguageFilePath (string languageCode)
 Returns the file path to a specified language file More...
 
static string ResourcesFolderFilePath ()
 Returns the path to the Resources folder used at runtime More...
 
static string AvailableCulturesFilePath ()
 Returns the path to the AvailableCultures xml file More...
 
static string LanguageRuntimeFolderPath (string languageCode)
 Returns the base directory path for a specified language, where you can find the localized assets(textures, audio, etc) More...
 
static string LanguageAudioFolderPath (string languageCode)
 Returns the audio directory path for a specified language, where you can find the localized audio assets More...
 
static string LanguageTexturesFolderPath (string languageCode)
 Returns the textures directory path for a specified language, where you can find the localized texture assets More...
 
static string LanguageTextAssetsFolderPath (string languageCode)
 
static string LanguageFontsFolderPath (string languageCode)
 
static string LanguagePrefabsFolderPath (string languageCode)
 Returns the prefabs directory path for a specified language, where you can find the localized prefab assets More...
 
static string ResourcesFolderFilePathRelative ()
 Gets the relative path to the resource folder used at runtime. More...
 
static string LanguageRuntimeFolderPathRelative (string languageCode)
 Gets the relative path to the folder used at runtime for a specific language. More...
 
static string LanguageAudioFolderPathRelative (string languageCode)
 Gets the relative path to the audio folder used at runtime for a specific language. More...
 
static string LanguageTexturesFolderPathRelative (string languageCode)
 Gets the relative path to the textures folder used at runtime for a specific language. More...
 
static string LanguageTextAssetsFolderPathRelative (string languageCode)
 Gets the relative path to the text assets folder used at runtime for a specific language. More...
 
static string LanguageFontsFolderPathRelative (string languageCode)
 Gets the relative path to the fonts folder used at runtime for a specific language. More...
 
static string LanguagePrefabsFolderPathRelative (string languageCode)
 Gets the relative path to the prefabs folder used at runtime for a specific language. More...
 

Static Public Attributes

static string resXFileEnding = ".resx"
 The .resx file ending as a string More...
 
static string txtFileEnding = ".txt"
 The .txt file ending as a string More...
 
static string metaFileEnding = ".meta"
 The .meta file ending as a string More...
 
static string prefabFileEnding = ".prefab"
 The .prefab file ending as a string More...
 
static string rootLanguageName = "Language"
 The name of the root language file More...
 

Detailed Description

Contains and creates all the directory and file information about the workspace

Member Function Documentation

static string SmartLocalization.Editor.LocalizationWorkspace.AutoGeneratedFolderPath ( )
static

Returns the path to the AutoGenerated folder

static string SmartLocalization.Editor.LocalizationWorkspace.AvailableCulturesFilePath ( )
static

Returns the path to the AvailableCultures xml file

static bool SmartLocalization.Editor.LocalizationWorkspace.Create ( )
static

Creates a new workspace. Returns false if a workspace already exists

Returns
If the creation was a success.
static string SmartLocalization.Editor.LocalizationWorkspace.CultureInfoCollectionFilePath ( )
static

Returns the path to the CultureInfoCollection

static string SmartLocalization.Editor.LocalizationWorkspace.CultureInfoDataFolderPath ( )
static

Returns the path to the CultureInfoData folder

static string SmartLocalization.Editor.LocalizationWorkspace.DataFolderPath ( )
static

Returns the path to the Data folder

static bool SmartLocalization.Editor.LocalizationWorkspace.Exists ( )
static

Checks if there is an existing workspace

Returns
If the workspace exists
static bool SmartLocalization.Editor.LocalizationWorkspace.GenerateCultureInfoCollection ( SmartCultureInfoCollection  previousCollection)
static

Generates the SmartCultureInfoCollection xml with all the available language infos and keeps any difference in old data as well.

Returns
If the operation was successful
static bool SmartLocalization.Editor.LocalizationWorkspace.GenerateCultureInfoCollection ( )
static

Generates the SmartCultureInfoCollection xml with all the available language infos

Returns
static string SmartLocalization.Editor.LocalizationWorkspace.LanguageAudioFolderPath ( string  languageCode)
static

Returns the audio directory path for a specified language, where you can find the localized audio assets

Parameters
languageCodeThe language code of the culture
Returns
The audio directory path for the language
static string SmartLocalization.Editor.LocalizationWorkspace.LanguageAudioFolderPathRelative ( string  languageCode)
static

Gets the relative path to the audio folder used at runtime for a specific language.

static string SmartLocalization.Editor.LocalizationWorkspace.LanguageDataFolderPath ( )
static

Returns the path to the LanguageData folder

static string SmartLocalization.Editor.LocalizationWorkspace.LanguageFilePath ( string  languageCode)
static

Returns the file path to a specified language file

Parameters
languageCodeThe language code of the file to retrieve
Returns
The full path to the language
static string SmartLocalization.Editor.LocalizationWorkspace.LanguageFontsFolderPathRelative ( string  languageCode)
static

Gets the relative path to the fonts folder used at runtime for a specific language.

static string SmartLocalization.Editor.LocalizationWorkspace.LanguagePrefabsFolderPath ( string  languageCode)
static

Returns the prefabs directory path for a specified language, where you can find the localized prefab assets

Parameters
languageCodeThe language code of the culture
Returns
The prefabs directory path for the language
static string SmartLocalization.Editor.LocalizationWorkspace.LanguagePrefabsFolderPathRelative ( string  languageCode)
static

Gets the relative path to the prefabs folder used at runtime for a specific language.

static string SmartLocalization.Editor.LocalizationWorkspace.LanguageRuntimeFolderPath ( string  languageCode)
static

Returns the base directory path for a specified language, where you can find the localized assets(textures, audio, etc)

Parameters
languageCodeThe language code of the culture
Returns
The directory path for the language
static string SmartLocalization.Editor.LocalizationWorkspace.LanguageRuntimeFolderPathRelative ( string  languageCode)
static

Gets the relative path to the folder used at runtime for a specific language.

static string SmartLocalization.Editor.LocalizationWorkspace.LanguageTextAssetsFolderPathRelative ( string  languageCode)
static

Gets the relative path to the text assets folder used at runtime for a specific language.

static string SmartLocalization.Editor.LocalizationWorkspace.LanguageTexturesFolderPath ( string  languageCode)
static

Returns the textures directory path for a specified language, where you can find the localized texture assets

Parameters
languageCodeThe language code of the culture
Returns
The textures directory path for the language
static string SmartLocalization.Editor.LocalizationWorkspace.LanguageTexturesFolderPathRelative ( string  languageCode)
static

Gets the relative path to the textures folder used at runtime for a specific language.

static string SmartLocalization.Editor.LocalizationWorkspace.ResourcesFolderFilePath ( )
static

Returns the path to the Resources folder used at runtime

static string SmartLocalization.Editor.LocalizationWorkspace.ResourcesFolderFilePathRelative ( )
static

Gets the relative path to the resource folder used at runtime.

static string SmartLocalization.Editor.LocalizationWorkspace.RootLanguageFilePath ( )
static

Returns the path to the root language file

static string SmartLocalization.Editor.LocalizationWorkspace.WorkspaceFolderPath ( )
static

Returns the path to the workspace folder

Member Data Documentation

string SmartLocalization.Editor.LocalizationWorkspace.metaFileEnding = ".meta"
static

The .meta file ending as a string

string SmartLocalization.Editor.LocalizationWorkspace.prefabFileEnding = ".prefab"
static

The .prefab file ending as a string

string SmartLocalization.Editor.LocalizationWorkspace.resXFileEnding = ".resx"
static

The .resx file ending as a string

string SmartLocalization.Editor.LocalizationWorkspace.rootLanguageName = "Language"
static

The name of the root language file

string SmartLocalization.Editor.LocalizationWorkspace.txtFileEnding = ".txt"
static

The .txt file ending as a string


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