ORK Framework  2.25.2
API Documentation
ORKFramework.BaseLanguageSettings Class Referenceabstract
Inheritance diagram for ORKFramework.BaseLanguageSettings:
ORKFramework.BaseSettings ORKFramework.CoreSettings ORKFramework.IBaseData ORKFramework.AbilitiesSettings ORKFramework.AbilityTreesSettings ORKFramework.AbilityTypesSettings ORKFramework.AIBehavioursSettings ORKFramework.AIRulesetsSettings ORKFramework.AITypesSettings ORKFramework.AreasSettings ORKFramework.AreaTypesSettings ORKFramework.ArmorsSettings ORKFramework.AttackAttributesSettings ORKFramework.BattleGridCellTypesSettings ORKFramework.ClassesSettings ORKFramework.CombatantsSettings ORKFramework.CombatantTypesSettings ORKFramework.ConsoleTypesSettings ORKFramework.CraftingRecipesSettings ORKFramework.CraftingTypesSettings ORKFramework.CurrenciesSettings ORKFramework.DefenceAttributesSettings ORKFramework.DifficultiesSettings ORKFramework.EquipmentPartsSettings ORKFramework.FactionBenefitsSettings ORKFramework.FactionsSettings ORKFramework.ItemsSettings ORKFramework.ItemTypesSettings ORKFramework.LogsSettings ORKFramework.LogTypesSettings ORKFramework.QuestsSettings ORKFramework.QuestTasksSettings ORKFramework.QuestTypesSettings ORKFramework.ResearchTreesSettings ORKFramework.ResearchTypesSettings ORKFramework.SceneObjectsSettings ORKFramework.SceneObjectTypesSettings ORKFramework.ShopsSettings ORKFramework.StatusEffectsSettings ORKFramework.StatusEffectTypesSettings ORKFramework.StatusTypesSettings ORKFramework.StatusValuesSettings ORKFramework.TeleportsSettings ORKFramework.WeaponsSettings

Public Member Functions

abstract string GetDescription (int index)
 Gets the description. More...
 
abstract Texture GetIcon (int index)
 Gets the icon of a data. More...
 
GUIContent GetContent (int index)
 Gets the GUIContent of a data. More...
 
- Public Member Functions inherited from ORKFramework.BaseSettings
override void DataAdded (ORKDataType type, int index)
 Automatic data updated function when adding new data. More...
 
override void DataRemoved (ORKDataType type, int index, int index2)
 Automatic data update function when removing data. More...
 
override void DataMoved (ORKDataType type, bool down, int index, int index2)
 Automatic data update function when moving data. More...
 
override void DataLoaded ()
 Called after loading the project data of all settings. Handles final data checks. More...
 
- Public Member Functions inherited from ORKFramework.CoreSettings
virtual void LoadProject (ORKProjectAsset project)
 Loads the settings found in the ORK Project asset. More...
 
virtual void GetSaveData (ref Dictionary< string, ORKDataFile > list, bool encrypt)
 Gets the save data. More...
 
virtual void GetLoadData (ref Dictionary< string, ORKDataFile > list, ORKProjectAsset project)
 Gets the load data from the ORK Project asset. More...
 
virtual void GetGameVariables (ref List< string > list)
 Gets the game variables found in this settings. More...
 
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 
void SetRealIDs (BaseIndexData[] d)
 Sets the RealID values (indexes) of the data. More...
 
abstract void SetRealIDs ()
 Sets the RealID values (indexes). More...
 
abstract string GetName (int index)
 Gets the name of a data. More...
 
abstract string [] GetNames (bool addIndex)
 Gets a list of names of all data. More...
 
abstract int Add ()
 Adds new data. More...
 
abstract int Copy (int index)
 Creates a copy of the data with the specified index. More...
 
abstract void Remove (int index)
 Removes the data with the specified index. More...
 
abstract void Move (int index, bool down)
 Moves the data with the specified index. More...
 

Additional Inherited Members

- Properties inherited from ORKFramework.CoreSettings
abstract string FILENAME [get]
 Gets the filename used for saving the settings. More...
 
abstract int Count [get]
 

Member Function Documentation

◆ GetContent()

GUIContent ORKFramework.BaseLanguageSettings.GetContent ( int  index)

Gets the GUIContent of a data.

Returns
The GUIContent.
Parameters
indexThe data index.

◆ GetDescription()

abstract string ORKFramework.BaseLanguageSettings.GetDescription ( int  index)
pure virtual

◆ GetIcon()

abstract Texture ORKFramework.BaseLanguageSettings.GetIcon ( int  index)
pure virtual