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

Public Member Functions

 BattleSettings (ORKProjectAsset project)
 
override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
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...
 
- 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

EnemyCounting enemyCounter = EnemyCounting.None
 
bool playDamageAnim = false
 
bool playVictoryAnimation = true
 
FloatValue defendRate = new FloatValue(50)
 
FloatValue counterChance = new FloatValue()
 
FloatValue blockChance = new FloatValue()
 
FloatValue escapeChance = new FloatValue(50)
 
FloatValue experienceFactor = new FloatValue(1)
 
FloatValue randomBattleFactor = new FloatValue(100)
 
bool useBattleRange = true
 
Range battleRange = new Range(20.0f)
 
bool useAIRange = true
 
float aiRecheckTime = 4.0f
 
Range aiRange = new Range(100.0f)
 
bool useMoveAIRange = true
 
Range moveAIRange = new Range(100.0f)
 
AutoJoinBattle autoJoin = new AutoJoinBattle()
 
AutoStartBattleSettings autoStartBattles = new AutoStartBattleSettings(true)
 
UseRangeSettings useRange = new UseRangeSettings()
 
LevelUpBonus lvlUp = new LevelUpBonus()
 
LevelUpBonus cLvlUp = new LevelUpBonus()
 
BattleAdvantage playerAdvantage = new BattleAdvantage()
 
BattleAdvantage enemyAdvantage = new BattleAdvantage()
 
int menuID = 0
 
bool useTurnBasedMenu = false
 
int turnBasedMenuID = 0
 
bool useActiveTimeMenu = false
 
int activeTimeMenuID = 0
 
bool useRealTimeMenu = false
 
int realTimeMenuID = 0
 
bool usePhaseMenu = false
 
int phaseMenuID = 0
 
bool bmDrag = false
 
bool bmClick = false
 
int bmClickCount = 2
 
bool bmTooltip = false
 
FactionEventSetting turnStartEvents = new FactionEventSetting()
 
FactionEventSetting turnEndEvents = new FactionEventSetting()
 
int [] defaultActionCombo = new int[0]
 
CastTimeSettings abilityCastTime = new CastTimeSettings()
 
CastTimeSettings itemCastTime = new CastTimeSettings()
 
CastTimeSettings defendCastTime = new CastTimeSettings()
 
CastTimeSettings escapeCastTime = new CastTimeSettings()
 
CastTimeSettings noneCastTime = new CastTimeSettings()
 
CastTimeSettings gridMoveCastTime = new CastTimeSettings()
 
DefaultBattleAnimations battleAnimations = new DefaultBattleAnimations()
 
BattleStatisticSettings battleStatistics = new BattleStatisticSettings()
 

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

Adds new data.

Implements ORKFramework.CoreSettings.

◆ Copy()

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

Gets the name of a data.

Returns
The name.
Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ GetNames()

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

Removes the data with the specified index.

Parameters
indexThe data index.

Implements ORKFramework.CoreSettings.

◆ SetData()

override void ORKFramework.BattleSettings.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.BattleSettings.SetRealIDs ( )
virtual

Sets the RealID values (indexes).

Implements ORKFramework.CoreSettings.