ORK Framework  2.25.2
API Documentation
ORKFramework.GameControlsSettings Class Reference
Inheritance diagram for ORKFramework.GameControlsSettings:
ORKFramework.BaseSettings ORKFramework.CoreSettings ORKFramework.IBaseData

Public Member Functions

 GameControlsSettings (ORKProjectAsset project)
 
override void SetRealIDs ()
 Sets the RealID values (indexes). More...
 
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
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 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 AddPlayerComponents (GameObject gameObject)
 
void RemovePlayerComponents (GameObject gameObject)
 
- 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 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 cursorTimeout = 0.25f
 
float cursorHoldTimeout = 0.25f
 
float clickTimeout = 0.2f
 
MenuControls menuControls = new MenuControls()
 
int pauseKey = 0
 
bool pauseTime = false
 
bool freezePause = false
 
int memberPlusKey = 0
 
int memberMinusKey = 0
 
bool switchOnlyBattle = false
 
bool switchNotDead = false
 
bool switchPlayer = false
 
bool switchField = true
 
bool switchTurnBased = false
 
bool switchActiveTime = false
 
bool switchRealTime = true
 
bool switchPhase = false
 
bool switchMenuUser = false
 
bool switchMenuActiveTime = false
 
bool switchMenuRealTime = true
 
int abilityPlusKey = 0
 
int abilityMinusKey = 0
 
bool loopAbilityLevels = false
 
InteractionSettings interaction = new InteractionSettings()
 
string [] playerComponent = new string[0]
 
PlayerControlSettings playerControl = new PlayerControlSettings()
 
CameraControlSettings cameraControl = new CameraControlSettings()
 
CustomControlSettings customControl = new CustomControlSettings()
 

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.GameControlsSettings.Add ( )
virtual

Adds new data.

Implements ORKFramework.CoreSettings.

◆ Copy()

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

Creates a copy of the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ GetName()

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

Gets the name of a data.

Returns
The name.
Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ GetNames()

override string [] ORKFramework.GameControlsSettings.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.GameControlsSettings.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.GameControlsSettings.Remove ( int  index)
virtual

Removes the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ SetData()

override void ORKFramework.GameControlsSettings.SetData ( DataObject  data)
virtual

Sets the variables of the class using a ORKFramework.DataObject.

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.CoreSettings.

◆ SetRealIDs()

override void ORKFramework.GameControlsSettings.SetRealIDs ( )
virtual

Sets the RealID values (indexes).

Implements ORKFramework.CoreSettings.