ORK Framework  2.26.1
API Documentation
ORKFramework.FactionSympathySettings Class Reference
Inheritance diagram for ORKFramework.FactionSympathySettings:
ORKFramework.BaseSettings ORKFramework.CoreSettings ORKFramework.IBaseData

Public Member Functions

 FactionSympathySettings (ORKProjectAsset project)
 
override void SetRealIDs ()
 Sets the RealID values (indexes). More...
 
override int Add ()
 Adds new data. More...
 
override int Copy (int index)
 Creates a copy of the data with the specified index. More...
 
override void Remove (int index)
 Removes the data with the specified index. More...
 
override void Move (int index, bool down)
 Moves the data with the specified index. More...
 
void CheckMatrix ()
 
override string GetName (int index)
 Gets the name of a data. More...
 
override string [] GetNames (bool addIndex)
 Gets a list of names of all data. More...
 
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...
 
- Public Member Functions inherited from ORKFramework.BaseSettings
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...
 

Public Attributes

float min = -1000
 
float max = 1000
 
FactionSympathy [] data
 

Properties

override string FILENAME [get]
 
override int Count [get]
 
- 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

◆ Add()

override int ORKFramework.FactionSympathySettings.Add ( )
virtual

Adds new data.

Implements ORKFramework.CoreSettings.

◆ Copy()

override int ORKFramework.FactionSympathySettings.Copy ( int  index)
virtual

Creates a copy of the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ DataAdded()

override void ORKFramework.FactionSympathySettings.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).

Reimplemented from ORKFramework.BaseSettings.

◆ DataMoved()

override void ORKFramework.FactionSympathySettings.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).

Reimplemented from ORKFramework.BaseSettings.

◆ DataRemoved()

override void ORKFramework.FactionSympathySettings.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).

Reimplemented from ORKFramework.BaseSettings.

◆ GetName()

override string ORKFramework.FactionSympathySettings.GetName ( int  index)
virtual

Gets the name of a data.

Returns
The name.
Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ GetNames()

override string [] ORKFramework.FactionSympathySettings.GetNames ( bool  addIndex)
virtual

Gets a list of names of all data.

Returns
The list of names.
Parameters
addIndexIf true, the index of the data will be added to the names.

Implements ORKFramework.CoreSettings.

◆ Move()

override void ORKFramework.FactionSympathySettings.Move ( int  index,
bool  down 
)
virtual

Moves the data with the specified index.

Parameters
indexThe data index.
downIf true, the data will be moved down.

Implements ORKFramework.CoreSettings.

◆ Remove()

override void ORKFramework.FactionSympathySettings.Remove ( int  index)
virtual

Removes the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ SetRealIDs()

override void ORKFramework.FactionSympathySettings.SetRealIDs ( )
virtual

Sets the RealID values (indexes).

Implements ORKFramework.CoreSettings.

Member Data Documentation

◆ data

FactionSympathy [] ORKFramework.FactionSympathySettings.data
Initial value:
= new FactionSympathy[] {
new FactionSympathy(new float[] {0, -1000, 1000}),
new FactionSympathy(new float[] {-1000, 0, -1000}),
new FactionSympathy(new float[] {1000, -1000, 0})
}