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

Public Member Functions

 CursorSettings (ORKProjectAsset project)
 
override void SetRealIDs ()
 Sets the RealID values (indexes). 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...
 
bool ShowCursor (CursorType type)
 
void RemoveCursor (CursorType type)
 
bool ShowTargetValid (TargetSettings targetSettings)
 
bool ShowTargetInvalid (TargetSettings targetSettings)
 
bool ShowTargetNone (TargetSettings targetSettings)
 
bool ShowTargetOverBox (Combatant user, IShortcut shortcut)
 
void RemoveTargetSelection ()
 
bool ShowInAction (BaseAction action)
 
void RemoveInAction (BaseAction action)
 
bool ShowAttackRange (Combatant combatant)
 
void RemoveAttackRange (Combatant combatant)
 
bool ShowAttackRangeCursorOver (Combatant combatant, Combatant target)
 
void RemoveAttackRangeCursorOver (Combatant combatant)
 
void ShowGridPlacementSelection ()
 
void ShowGridNoPlacementSelection ()
 
void RemoveGridPlacementSelections ()
 
void ShowGridMoveSelection ()
 
void ShowGridNoMoveSelection ()
 
void RemoveGridMoveSelections ()
 
void ShowGridExamineSelection ()
 
void ShowGridExamineSelectionBlocked ()
 
void RemoveGridExamineSelections ()
 
bool ShowCustomCursor (CursorChange cursor)
 
void RemoveCustomCursor (CursorChange cursor)
 
- 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...
 

Public Attributes

CursorChange defaultCursor = new CursorChange()
 
bool targetValidOriginBox = false
 
bool targetValidOriginShortcut = false
 
CursorChange targetSelfValid = new CursorChange()
 
CursorChange targetAllyValid = new CursorChange()
 
CursorChange targetEnemyValid = new CursorChange()
 
CursorChange targetAllValid = new CursorChange()
 
CursorChange targetSelfInvalid = new CursorChange()
 
CursorChange targetAllyInvalid = new CursorChange()
 
CursorChange targetEnemyInvalid = new CursorChange()
 
CursorChange targetAllInvalid = new CursorChange()
 
CursorChange targetSelfNone = new CursorChange()
 
CursorChange targetAllyNone = new CursorChange()
 
CursorChange targetEnemyNone = new CursorChange()
 
CursorChange targetAllNone = new CursorChange()
 
bool inActionIgnoreDeath = false
 
CursorChange inActionPlayer = new CursorChange()
 
CursorChange inActionAlly = new CursorChange()
 
CursorChange inActionEnemy = new CursorChange()
 
bool showAttackRangeCursor = false
 
bool attackRangeCursorOver = false
 
CursorChange inAttackRange = new CursorChange()
 
CursorChange outOfAttackRange = new CursorChange()
 
CursorChange gridPlacementSelection = new CursorChange()
 
CursorChange gridNoPlacementSelection = new CursorChange()
 
CursorChange gridOrientationSelection = new CursorChange()
 
CursorChange gridMoveSelection = new CursorChange()
 
CursorChange gridNoMoveSelection = new CursorChange()
 
CursorChange gridExamineSelection = new CursorChange()
 
CursorChange gridExamineSelectionBlocked = new CursorChange()
 

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

Adds new data.

Implements ORKFramework.CoreSettings.

◆ Copy()

override int ORKFramework.CursorSettings.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.CursorSettings.GetName ( int  index)
virtual

Gets the name of a data.

Returns
The name.
Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ GetNames()

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

Removes the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ SetRealIDs()

override void ORKFramework.CursorSettings.SetRealIDs ( )
virtual

Sets the RealID values (indexes).

Implements ORKFramework.CoreSettings.