ORK Framework  2.22.0
API Documentation
ORKFramework.BaseSettings Class Reference
Inheritance diagram for ORKFramework.BaseSettings:
ORKFramework.CoreSettings ORKFramework.IBaseData ORKFramework.AbilityDevelopmentsSettings ORKFramework.ActionCombosSettings ORKFramework.AnimationsSettings ORKFramework.AnimationTypesSettings ORKFramework.BackupSettings ORKFramework.BaseLanguageSettings ORKFramework.BattleAIsSettings ORKFramework.BattleEndSettings ORKFramework.BattleGridFormationsSettings ORKFramework.BattleMenusSettings ORKFramework.BattleRangeTemplatesSettings ORKFramework.BattleSettings ORKFramework.BattleSpotsSettings ORKFramework.BattleSystemSettings ORKFramework.BattleTextsSettings ORKFramework.CameraPositionsSettings ORKFramework.ColorsSettings ORKFramework.CombatantGroupsSettings ORKFramework.CombatantSelectionsSettings ORKFramework.ConsoleSettings ORKFramework.ControlMapsSettings ORKFramework.DamageTypesSettings ORKFramework.EditorSettings ORKFramework.FactionSympathySettings ORKFramework.FormulasSettings ORKFramework.FormulaTypesSettings ORKFramework.GameControlsSettings ORKFramework.GameSettings ORKFramework.GlobalEventsSettings ORKFramework.GUIBoxesSettings ORKFramework.GUILayersSettings ORKFramework.HUDsSettings ORKFramework.InputKeysSettings ORKFramework.InventorySettings ORKFramework.LanguagesSettings ORKFramework.LogTextsSettings ORKFramework.LootSettings ORKFramework.MainMenuSettings ORKFramework.MenuScreensSettings ORKFramework.MenuSettings ORKFramework.MoveAIsSettings ORKFramework.MusicClipsSettings ORKFramework.PluginsSettings ORKFramework.PortraitTypesSettings ORKFramework.QuantitySelectionsSettings ORKFramework.QuestSettings ORKFramework.RequirementsSettings ORKFramework.SaveGameMenuSettings ORKFramework.SceneConnectionSettings ORKFramework.ShopLayoutsSettings ORKFramework.ShortcutSettings ORKFramework.SoundTypesSettings ORKFramework.StatusBonusesSettings ORKFramework.StatusDevelopmentsSettings ORKFramework.StatusRequirementTemplatesSettings ORKFramework.TextDisplaySettings ORKFramework.VariableConditionTemplatesSettings

Public Member Functions

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

override void ORKFramework.BaseSettings.DataAdded ( ORKDataType  type,
int  index 
)
virtual

Automatic data updated function when adding new data.

Parameters
typeThe data type that has been added.
indexThe data index of the attribute (only used for attack/defence attributes).

Implements ORKFramework.CoreSettings.

Reimplemented in ORKFramework.FactionSympathySettings.

override void ORKFramework.BaseSettings.DataLoaded ( )
virtual

Called after loading the project data of all settings. Handles final data checks.

Reimplemented from ORKFramework.CoreSettings.

override void ORKFramework.BaseSettings.DataMoved ( ORKDataType  type,
bool  down,
int  index,
int  index2 
)
virtual

Automatic data update function when moving data.

Parameters
typeThe data type that has been moved.
downIf true, the data has been moved down, otherwise up.
indexThe data index that has been moved..
index2The attribute index that has been moved (only used for attack/defence attributes).

Implements ORKFramework.CoreSettings.

Reimplemented in ORKFramework.FactionSympathySettings.

override void ORKFramework.BaseSettings.DataRemoved ( ORKDataType  type,
int  index,
int  index2 
)
virtual

Automatic data update function when removing data.

Parameters
typeThe data type that has been removed.
indexTha data index that has been removed.
index2The attribute index that has been removed (only used for attack/defence attributes).

Implements ORKFramework.CoreSettings.

Reimplemented in ORKFramework.FactionSympathySettings.