![]() |
ORK Framework
2.27.1
API Documentation
|
Public Member Functions | |
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 | DataLoaded () |
Called after loading the project data of all settings. Handles final data checks. 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... | |
abstract void | DataAdded (ORKDataType type, int index) |
Automatic data updated function when adding new data. More... | |
abstract void | DataRemoved (ORKDataType type, int index, int index2) |
Automatic data update function when removing data. More... | |
abstract void | DataMoved (ORKDataType type, bool down, int index, int index2) |
Automatic data update function when moving data. More... | |
Properties | |
abstract string | FILENAME [get] |
Gets the filename used for saving the settings. More... | |
abstract int | Count [get] |
|
pure virtual |
Adds new data.
Implemented in ORKFramework.ConsoleSettings, ORKFramework.BattleTextsSettings, ORKFramework.BattleSettings, ORKFramework.SaveGameMenuSettings, ORKFramework.MenuSettings, ORKFramework.GameSettings, ORKFramework.InventorySettings, ORKFramework.GameControlsSettings, ORKFramework.EditorSettings, ORKFramework.BattleTargetSettings, ORKFramework.BattleCameraSettings, ORKFramework.CursorSettings, ORKFramework.AnimationTypesSettings, ORKFramework.BattleEndSettings, ORKFramework.MainMenuSettings, ORKFramework.ShortcutSettings, ORKFramework.BattleSpotsSettings, ORKFramework.QuestSettings, ORKFramework.TextDisplaySettings, ORKFramework.LogTextsSettings, ORKFramework.FormulasSettings, ORKFramework.GUIBoxesSettings, ORKFramework.SoundTypesSettings, ORKFramework.BackupSettings, ORKFramework.GlobalEventsSettings, ORKFramework.PortraitTypesSettings, ORKFramework.BattleRangeTemplatesSettings, ORKFramework.InputKeysSettings, ORKFramework.SceneConnectionSettings, ORKFramework.DamageTypesSettings, ORKFramework.BattleSystemSettings, ORKFramework.StatusRequirementTemplatesSettings, ORKFramework.VariableConditionTemplatesSettings, ORKFramework.PluginsSettings, ORKFramework.AnimationsSettings, ORKFramework.GUILayoutsSettings, ORKFramework.HUDsSettings, ORKFramework.StatusBonusesSettings, ORKFramework.ActionCombosSettings, ORKFramework.BattleAIsSettings, ORKFramework.LootSettings, ORKFramework.MoveAIsSettings, ORKFramework.CombatantSelectionsSettings, ORKFramework.MenuScreensSettings, ORKFramework.QuantitySelectionsSettings, ORKFramework.ShopLayoutsSettings, ORKFramework.ControlMapsSettings, ORKFramework.BattleGridFormationsSettings, ORKFramework.BattleMenusSettings, ORKFramework.CombatantGroupsSettings, ORKFramework.ColorsSettings, ORKFramework.FormulaTypesSettings, ORKFramework.RequirementsSettings, ORKFramework.GUILayersSettings, ORKFramework.AbilityDevelopmentsSettings, ORKFramework.StatusDevelopmentsSettings, ORKFramework.CameraPositionsSettings, ORKFramework.MusicClipsSettings, ORKFramework.TextCodeSettings, ORKFramework.FactionSympathySettings, and ORKFramework.BaseLanguageSettings< T >.
|
pure virtual |
Creates a copy of the data with the specified index.
index | The data index. |
Implemented in ORKFramework.ConsoleSettings, ORKFramework.BattleTextsSettings, ORKFramework.BattleSettings, ORKFramework.SaveGameMenuSettings, ORKFramework.MenuSettings, ORKFramework.GameSettings, ORKFramework.InventorySettings, ORKFramework.GameControlsSettings, ORKFramework.EditorSettings, ORKFramework.BattleTargetSettings, ORKFramework.BattleCameraSettings, ORKFramework.CursorSettings, ORKFramework.AnimationTypesSettings, ORKFramework.BattleEndSettings, ORKFramework.MainMenuSettings, ORKFramework.ShortcutSettings, ORKFramework.BattleSpotsSettings, ORKFramework.QuestSettings, ORKFramework.TextDisplaySettings, ORKFramework.LogTextsSettings, ORKFramework.FormulasSettings, ORKFramework.GUIBoxesSettings, ORKFramework.SoundTypesSettings, ORKFramework.BackupSettings, ORKFramework.GlobalEventsSettings, ORKFramework.PortraitTypesSettings, ORKFramework.BattleRangeTemplatesSettings, ORKFramework.InputKeysSettings, ORKFramework.DamageTypesSettings, ORKFramework.StatusRequirementTemplatesSettings, ORKFramework.VariableConditionTemplatesSettings, ORKFramework.SceneConnectionSettings, ORKFramework.BattleSystemSettings, ORKFramework.PluginsSettings, ORKFramework.AnimationsSettings, ORKFramework.GUILayoutsSettings, ORKFramework.HUDsSettings, ORKFramework.StatusBonusesSettings, ORKFramework.ActionCombosSettings, ORKFramework.BattleAIsSettings, ORKFramework.LootSettings, ORKFramework.MoveAIsSettings, ORKFramework.CombatantSelectionsSettings, ORKFramework.MenuScreensSettings, ORKFramework.QuantitySelectionsSettings, ORKFramework.ShopLayoutsSettings, ORKFramework.ControlMapsSettings, ORKFramework.BattleGridFormationsSettings, ORKFramework.BattleMenusSettings, ORKFramework.CombatantGroupsSettings, ORKFramework.ColorsSettings, ORKFramework.FormulaTypesSettings, ORKFramework.RequirementsSettings, ORKFramework.GUILayersSettings, ORKFramework.AbilityDevelopmentsSettings, ORKFramework.StatusDevelopmentsSettings, ORKFramework.CameraPositionsSettings, ORKFramework.MusicClipsSettings, ORKFramework.TextCodeSettings, ORKFramework.BaseLanguageSettings< T >, and ORKFramework.FactionSympathySettings.
|
pure virtual |
Automatic data updated function when adding new data.
type | The data type that has been added. |
index | The data index of the attribute (only used for attack/defence attributes). |
Implemented in ORKFramework.FactionSympathySettings, and ORKFramework.BaseSettings.
|
virtual |
Called after loading the project data of all settings. Handles final data checks.
Reimplemented in ORKFramework.BaseSettings.
|
pure virtual |
Automatic data update function when moving data.
type | The data type that has been moved. |
down | If true, the data has been moved down, otherwise up. |
index | The data index that has been moved.. |
index2 | The attribute index that has been moved (only used for attack/defence attributes). |
Implemented in ORKFramework.FactionSympathySettings, and ORKFramework.BaseSettings.
|
pure virtual |
Automatic data update function when removing data.
type | The data type that has been removed. |
index | Tha data index that has been removed. |
index2 | The attribute index that has been removed (only used for attack/defence attributes). |
Implemented in ORKFramework.FactionSympathySettings, and ORKFramework.BaseSettings.
|
virtual |
Called for all fields using the autoSetup
option of the ORKFramework.ORKEditorLayoutAttribute.
fieldName | The name of the field the function is called for. |
Implements ORKFramework.IBaseData.
Reimplemented in ORKFramework.GameSettings.
|
virtual |
Gets a ORKFramework.DataObject representing the class.
Implements ORKFramework.IBaseData.
|
virtual |
Gets the game variables found in this settings.
list | The game variable list the data will be added to. |
|
virtual |
|
pure virtual |
Gets the name of a data.
index | The data index. |
Implemented in ORKFramework.ConsoleSettings, ORKFramework.BattleTextsSettings, ORKFramework.BattleSettings, ORKFramework.SaveGameMenuSettings, ORKFramework.MenuSettings, ORKFramework.GameSettings, ORKFramework.InventorySettings, ORKFramework.GameControlsSettings, ORKFramework.EditorSettings, ORKFramework.BattleTargetSettings, ORKFramework.BattleCameraSettings, ORKFramework.CursorSettings, ORKFramework.BattleEndSettings, ORKFramework.AnimationTypesSettings, ORKFramework.BaseLanguageSettings< T >, ORKFramework.MainMenuSettings, ORKFramework.ShortcutSettings, ORKFramework.BattleSpotsSettings, ORKFramework.FactionSympathySettings, ORKFramework.QuestSettings, ORKFramework.TextDisplaySettings, ORKFramework.BackupSettings, ORKFramework.SceneConnectionSettings, ORKFramework.BattleSystemSettings, ORKFramework.SoundTypesSettings, ORKFramework.GlobalEventsSettings, ORKFramework.PortraitTypesSettings, ORKFramework.BattleRangeTemplatesSettings, ORKFramework.InputKeysSettings, ORKFramework.TextCodeSettings, ORKFramework.DamageTypesSettings, ORKFramework.StatusRequirementTemplatesSettings, ORKFramework.VariableConditionTemplatesSettings, ORKFramework.PluginsSettings, ORKFramework.AnimationsSettings, ORKFramework.GUILayoutsSettings, ORKFramework.HUDsSettings, ORKFramework.StatusBonusesSettings, ORKFramework.ActionCombosSettings, ORKFramework.BattleAIsSettings, ORKFramework.LootSettings, ORKFramework.MoveAIsSettings, ORKFramework.FormulasSettings, ORKFramework.CombatantSelectionsSettings, ORKFramework.MenuScreensSettings, ORKFramework.QuantitySelectionsSettings, ORKFramework.ShopLayoutsSettings, ORKFramework.LogTextsSettings, ORKFramework.ControlMapsSettings, ORKFramework.BattleGridFormationsSettings, ORKFramework.BattleMenusSettings, ORKFramework.CombatantGroupsSettings, ORKFramework.ColorsSettings, ORKFramework.FormulaTypesSettings, ORKFramework.RequirementsSettings, ORKFramework.GUIBoxesSettings, ORKFramework.GUILayersSettings, ORKFramework.AbilityDevelopmentsSettings, ORKFramework.StatusDevelopmentsSettings, ORKFramework.CameraPositionsSettings, and ORKFramework.MusicClipsSettings.
|
pure virtual |
Gets a list of names of all data.
addIndex | If true, the index of the data will be added to the names. |
Implemented in ORKFramework.ConsoleSettings, ORKFramework.BattleTextsSettings, ORKFramework.BattleSettings, ORKFramework.SaveGameMenuSettings, ORKFramework.MenuSettings, ORKFramework.GameSettings, ORKFramework.InventorySettings, ORKFramework.GameControlsSettings, ORKFramework.EditorSettings, ORKFramework.BattleTargetSettings, ORKFramework.BattleCameraSettings, ORKFramework.CursorSettings, ORKFramework.BattleEndSettings, ORKFramework.AnimationTypesSettings, ORKFramework.BaseLanguageSettings< T >, ORKFramework.MainMenuSettings, ORKFramework.ShortcutSettings, ORKFramework.BattleSpotsSettings, ORKFramework.FactionSympathySettings, ORKFramework.QuestSettings, ORKFramework.TextDisplaySettings, ORKFramework.BackupSettings, ORKFramework.SceneConnectionSettings, ORKFramework.BattleSystemSettings, ORKFramework.SoundTypesSettings, ORKFramework.GlobalEventsSettings, ORKFramework.PortraitTypesSettings, ORKFramework.BattleRangeTemplatesSettings, ORKFramework.InputKeysSettings, ORKFramework.DamageTypesSettings, ORKFramework.StatusRequirementTemplatesSettings, ORKFramework.VariableConditionTemplatesSettings, ORKFramework.PluginsSettings, ORKFramework.AnimationsSettings, ORKFramework.GUILayoutsSettings, ORKFramework.HUDsSettings, ORKFramework.StatusBonusesSettings, ORKFramework.ActionCombosSettings, ORKFramework.BattleAIsSettings, ORKFramework.LootSettings, ORKFramework.MoveAIsSettings, ORKFramework.FormulasSettings, ORKFramework.CombatantSelectionsSettings, ORKFramework.MenuScreensSettings, ORKFramework.QuantitySelectionsSettings, ORKFramework.ShopLayoutsSettings, ORKFramework.LogTextsSettings, ORKFramework.ControlMapsSettings, ORKFramework.BattleGridFormationsSettings, ORKFramework.BattleMenusSettings, ORKFramework.CombatantGroupsSettings, ORKFramework.ColorsSettings, ORKFramework.FormulaTypesSettings, ORKFramework.RequirementsSettings, ORKFramework.GUIBoxesSettings, ORKFramework.GUILayersSettings, ORKFramework.AbilityDevelopmentsSettings, ORKFramework.StatusDevelopmentsSettings, ORKFramework.CameraPositionsSettings, ORKFramework.MusicClipsSettings, and ORKFramework.TextCodeSettings.
|
virtual |
Gets the save data.
list | The list of save data the data will be added to. |
encrypt | If true, the data will be encrypted. |
|
virtual |
Loads the settings found in the ORK Project asset.
project | The ORK Project asset. |
Reimplemented in ORKFramework.BaseLanguageSettings< T >.
|
pure virtual |
Moves the data with the specified index.
index | The data index. |
down | If true, the data will be moved down. |
Implemented in ORKFramework.ConsoleSettings, ORKFramework.BattleTextsSettings, ORKFramework.BattleSettings, ORKFramework.SaveGameMenuSettings, ORKFramework.MenuSettings, ORKFramework.GameSettings, ORKFramework.InventorySettings, ORKFramework.GameControlsSettings, ORKFramework.EditorSettings, ORKFramework.BattleTargetSettings, ORKFramework.BattleCameraSettings, ORKFramework.CursorSettings, ORKFramework.AnimationTypesSettings, ORKFramework.BattleEndSettings, ORKFramework.MainMenuSettings, ORKFramework.ShortcutSettings, ORKFramework.BattleSpotsSettings, ORKFramework.GUIBoxesSettings, ORKFramework.LogTextsSettings, ORKFramework.FormulasSettings, ORKFramework.SoundTypesSettings, ORKFramework.QuestSettings, ORKFramework.GlobalEventsSettings, ORKFramework.PortraitTypesSettings, ORKFramework.CombatantGroupsSettings, ORKFramework.BattleRangeTemplatesSettings, ORKFramework.InputKeysSettings, ORKFramework.DamageTypesSettings, ORKFramework.StatusRequirementTemplatesSettings, ORKFramework.VariableConditionTemplatesSettings, ORKFramework.PluginsSettings, ORKFramework.AnimationsSettings, ORKFramework.BaseLanguageSettings< T >, ORKFramework.GUILayoutsSettings, ORKFramework.HUDsSettings, ORKFramework.StatusBonusesSettings, ORKFramework.ActionCombosSettings, ORKFramework.BattleAIsSettings, ORKFramework.LootSettings, ORKFramework.MoveAIsSettings, ORKFramework.CombatantSelectionsSettings, ORKFramework.MenuScreensSettings, ORKFramework.QuantitySelectionsSettings, ORKFramework.ShopLayoutsSettings, ORKFramework.MusicClipsSettings, ORKFramework.ControlMapsSettings, ORKFramework.BattleGridFormationsSettings, ORKFramework.BattleMenusSettings, ORKFramework.ColorsSettings, ORKFramework.FormulaTypesSettings, ORKFramework.RequirementsSettings, ORKFramework.GUILayersSettings, ORKFramework.AbilityDevelopmentsSettings, ORKFramework.StatusDevelopmentsSettings, ORKFramework.CameraPositionsSettings, ORKFramework.TextDisplaySettings, ORKFramework.BackupSettings, ORKFramework.SceneConnectionSettings, ORKFramework.BattleSystemSettings, ORKFramework.TextCodeSettings, and ORKFramework.FactionSympathySettings.
|
pure virtual |
Removes the data with the specified index.
index | The data index. |
Implemented in ORKFramework.ConsoleSettings, ORKFramework.BattleTextsSettings, ORKFramework.BattleSettings, ORKFramework.SaveGameMenuSettings, ORKFramework.MenuSettings, ORKFramework.GameSettings, ORKFramework.InventorySettings, ORKFramework.GameControlsSettings, ORKFramework.EditorSettings, ORKFramework.BattleTargetSettings, ORKFramework.BattleCameraSettings, ORKFramework.CursorSettings, ORKFramework.AnimationTypesSettings, ORKFramework.BattleEndSettings, ORKFramework.MainMenuSettings, ORKFramework.ShortcutSettings, ORKFramework.BattleSpotsSettings, ORKFramework.QuestSettings, ORKFramework.LogTextsSettings, ORKFramework.FormulasSettings, ORKFramework.GUIBoxesSettings, ORKFramework.SoundTypesSettings, ORKFramework.GlobalEventsSettings, ORKFramework.PortraitTypesSettings, ORKFramework.TextDisplaySettings, ORKFramework.BattleRangeTemplatesSettings, ORKFramework.InputKeysSettings, ORKFramework.DamageTypesSettings, ORKFramework.StatusRequirementTemplatesSettings, ORKFramework.VariableConditionTemplatesSettings, ORKFramework.PluginsSettings, ORKFramework.AnimationsSettings, ORKFramework.GUILayoutsSettings, ORKFramework.HUDsSettings, ORKFramework.StatusBonusesSettings, ORKFramework.ActionCombosSettings, ORKFramework.BattleAIsSettings, ORKFramework.LootSettings, ORKFramework.MoveAIsSettings, ORKFramework.CombatantSelectionsSettings, ORKFramework.MenuScreensSettings, ORKFramework.QuantitySelectionsSettings, ORKFramework.ShopLayoutsSettings, ORKFramework.MusicClipsSettings, ORKFramework.ControlMapsSettings, ORKFramework.BattleGridFormationsSettings, ORKFramework.BattleMenusSettings, ORKFramework.CombatantGroupsSettings, ORKFramework.ColorsSettings, ORKFramework.FormulaTypesSettings, ORKFramework.RequirementsSettings, ORKFramework.GUILayersSettings, ORKFramework.AbilityDevelopmentsSettings, ORKFramework.StatusDevelopmentsSettings, ORKFramework.CameraPositionsSettings, ORKFramework.BackupSettings, ORKFramework.SceneConnectionSettings, ORKFramework.BattleSystemSettings, ORKFramework.BaseLanguageSettings< T >, ORKFramework.TextCodeSettings, and ORKFramework.FactionSympathySettings.
|
virtual |
Sets the variables of the class using a ORKFramework.DataObject.
data | ORKFramework.DataObject containing the data. |
Implements ORKFramework.IBaseData.
Reimplemented in ORKFramework.ConsoleSettings, ORKFramework.BattleSettings, ORKFramework.BattleTextsSettings, ORKFramework.MenuSettings, ORKFramework.GameSettings, ORKFramework.InventorySettings, ORKFramework.BattleCameraSettings, ORKFramework.GameControlsSettings, ORKFramework.BattleTargetSettings, ORKFramework.AnimationTypesSettings, ORKFramework.MainMenuSettings, ORKFramework.BattleEndSettings, ORKFramework.QuestSettings, and ORKFramework.BattleSystemSettings.
void ORKFramework.CoreSettings.SetRealIDs | ( | BaseIndexData [] | d | ) |
Sets the RealID values (indexes) of the data.
d | The data. |
|
pure virtual |
Sets the RealID values (indexes).
Implemented in ORKFramework.ConsoleSettings, ORKFramework.BattleTextsSettings, ORKFramework.BattleSettings, ORKFramework.SaveGameMenuSettings, ORKFramework.MenuSettings, ORKFramework.EditorSettings, ORKFramework.BattleTargetSettings, ORKFramework.GameSettings, ORKFramework.CursorSettings, ORKFramework.InventorySettings, ORKFramework.BattleCameraSettings, ORKFramework.GameControlsSettings, ORKFramework.AnimationTypesSettings, ORKFramework.MainMenuSettings, ORKFramework.ShortcutSettings, ORKFramework.BattleSpotsSettings, ORKFramework.BattleEndSettings, ORKFramework.TextDisplaySettings, ORKFramework.QuestSettings, ORKFramework.SceneConnectionSettings, ORKFramework.FactionSympathySettings, ORKFramework.BaseLanguageSettings< T >, ORKFramework.SoundTypesSettings, ORKFramework.BattleSystemSettings, ORKFramework.GlobalEventsSettings, ORKFramework.PortraitTypesSettings, ORKFramework.BattleRangeTemplatesSettings, ORKFramework.InputKeysSettings, ORKFramework.TextCodeSettings, ORKFramework.DamageTypesSettings, ORKFramework.StatusRequirementTemplatesSettings, ORKFramework.VariableConditionTemplatesSettings, ORKFramework.BackupSettings, ORKFramework.PluginsSettings, ORKFramework.AnimationsSettings, ORKFramework.GUILayoutsSettings, ORKFramework.HUDsSettings, ORKFramework.StatusBonusesSettings, ORKFramework.ActionCombosSettings, ORKFramework.BattleAIsSettings, ORKFramework.LootSettings, ORKFramework.MoveAIsSettings, ORKFramework.FormulasSettings, ORKFramework.CombatantSelectionsSettings, ORKFramework.MenuScreensSettings, ORKFramework.QuantitySelectionsSettings, ORKFramework.ShopLayoutsSettings, ORKFramework.LogTextsSettings, ORKFramework.ControlMapsSettings, ORKFramework.BattleGridFormationsSettings, ORKFramework.BattleMenusSettings, ORKFramework.CombatantGroupsSettings, ORKFramework.ColorsSettings, ORKFramework.FormulaTypesSettings, ORKFramework.RequirementsSettings, ORKFramework.GUIBoxesSettings, ORKFramework.GUILayersSettings, ORKFramework.AbilityDevelopmentsSettings, ORKFramework.StatusDevelopmentsSettings, ORKFramework.CameraPositionsSettings, and ORKFramework.MusicClipsSettings.
|
get |
Gets the filename used for saving the settings.
The filename.