ORK Framework  2.27.1
API Documentation
ORKFramework.TurnBasedBattle Class Reference
Inheritance diagram for ORKFramework.TurnBasedBattle:
ORKFramework.BaseBattle ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
void FireHUDUpdate ()
 
override bool IsDynamicCombat ()
 
override bool CanChoose (Combatant combatant)
 
override bool CanDecreaseActionTime (Combatant combatant)
 
override void Tick ()
 
override float GetDefendActionCost (Combatant user)
 
override float GetEscapeActionCost (Combatant user)
 
override float GetNoneActionCost (Combatant user)
 
override float GetChangeMemberActionCost (Combatant user)
 
override float GetGridMoveActionCost (Combatant user)
 
override void StartBattle (bool changed)
 
float GetTurnCalculation (Combatant combatant)
 
override void RemoveFromOrder (Combatant combatant)
 
override void OrderChange (Combatant combatant, float change)
 
void TurnValuesUpdated ()
 
override void BattleMenuCanceled (Combatant user)
 
override bool UseControlMap ()
 
override void CombatantChanged (Combatant oldCombatant, Combatant newCombatant)
 
override void ActionAdded (BaseAction action)
 
override void PerformingAction (BaseAction action)
 
override void ActionFinished (BaseAction action)
 
string GetTurnOrderInfo (Combatant combatant, bool usePreview)
 
List< CombatantGetTurnOrder (int maximumLength, bool usePreview)
 
- Public Member Functions inherited from ORKFramework.BaseBattle
virtual void SetDecisionTime (Combatant combatant)
 
virtual bool CombatantClicked (Combatant combatant)
 
virtual bool DoCombatantTick ()
 
virtual void ActionUnshifted (BaseAction action)
 
void PerformAction (BaseAction action)
 
virtual void EndBattle ()
 
void SetGroupAuto (Combatant combatant)
 
bool IsGroupAuto (Combatant combatant)
 
- Public Member Functions inherited from ORKFramework.BaseData
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...
 

Public Attributes

TurnBasedMode mode = TurnBasedMode.Classic
 
bool dynamicCombat = false
 
float minTimeBetween = 0
 
int turnFormulaID = 0
 
float initialValueTurn = 0
 
bool invertTurnOrder = false
 
bool groupLeadersFirst = false
 
bool autoCallBattleMenu = true
 
int battleMenuKey = 0
 
bool battleMenuCancelCloses = false
 
bool battleMenuKeyCloses = false
 
bool battleMenuKeyEndsTurn = false
 
bool canCounter = true
 
bool defeatPlayerDead = false
 
bool deathImmediately = false
 
bool endImmediately = false
 
bool defendFirst = false
 
bool selectingControlMap = false
 
bool canAutoAttack = true
 
bool blockAutoAttackMenu = false
 
ActionsPerTurnSettings actionsPerTurn = new ActionsPerTurnSettings()
 
ActionTimeSettings actionTime = new ActionTimeSettings()
 
EnemyCounting turnOrderCounter = EnemyCounting.None
 
string [] turnOrderSelectingInfo = ArrayHelper.CreateArray(ORK.Languages.Count, "")
 
string [] turnOrderNoneInfo = ArrayHelper.CreateArray(ORK.Languages.Count, "")
 
- Public Attributes inherited from ORKFramework.BaseBattle
BattleControlBlock playerControl = BattleControlBlock.None
 
AllowTurnControl playerControlAllowTurn = AllowTurnControl.None
 
bool playerBattleMenu = false
 
bool transferPlayerControl = false
 
BattleControlBlock cameraControl = BattleControlBlock.None
 
AllowTurnControl cameraControlAllowTurn = AllowTurnControl.None
 
bool cameraBattleMenu = false
 
AIDecisionTime aiDecisionTime = new AIDecisionTime()
 
bool allowMoveAI = false
 
bool blockInBattleMoveAI = false
 
bool allowInTurnMoveAI = false
 
bool useMoveAIRange = true
 
Range moveAIRange = new Range(50)
 
AssetSource< ORKBattleStartEventstartEvent = new AssetSource<ORKBattleStartEvent>()
 
AssetSource< ORKBattleEndEventvictoryEvent = new AssetSource<ORKBattleEndEvent>()
 
AssetSource< ORKBattleEndEventescapeEvent = new AssetSource<ORKBattleEndEvent>()
 
AssetSource< ORKBattleEndEventdefeatEvent = new AssetSource<ORKBattleEndEvent>()
 
AssetSource< ORKBattleEndEventleaveArenaEvent = new AssetSource<ORKBattleEndEvent>()
 
bool useLeaveArena = false
 
Range leaveArenaRange = new Range(20)
 
bool gainsUseInventoryAddType = true
 
bool gainsCollectImmediately = false
 
CollectBattleGainsSettings collectGains
 
bool gainsDropItems = false
 
bool gainsDropAI = false
 
bool gainsDropRecipes = false
 
bool gainsDropMoney = false
 
AutoGridMoveType playerAutoGridMove = AutoGridMoveType.None
 
bool gridTurnEndOrientation = false
 
BattleBonuses bonuses = new BattleBonuses()
 

Protected Member Functions

bool TurnOrderFinished ()
 
void GetNextAction ()
 
IEnumerator GetNextAction2 ()
 
override void PerformNextAction3 ()
 
IEnumerator ActionFinished2 (BaseAction action)
 
- Protected Member Functions inherited from ORKFramework.BaseBattle
void PerformNextAction ()
 
IEnumerator PerformNextAction2 ()
 

Protected Attributes

Combatant selectingCombatant
 
- Protected Attributes inherited from ORKFramework.BaseBattle
List< CombatantgroupAuto
 

Properties

Notify UpdateHUD
 
override bool CanCounter [get]
 
override bool DeathImmediately [get]
 
override bool EndImmediately [get]
 
override bool DefeatOnPlayerDeath [get]
 
override bool DefendFirst [get]
 
override Combatant SelectingCombatant [get, set]
 
override bool MenuBlockAutoAttack [get]
 
override bool CanAutoAttack [get]
 
- Properties inherited from ORKFramework.BaseBattle
virtual bool CanCounter [get]
 
virtual bool DeathImmediately [get]
 
virtual bool EndImmediately [get]
 
virtual bool IsMenuBackAllowed [get]
 
virtual bool MenuBlockAutoAttack [get]
 
virtual bool CanAutoAttack [get]
 
virtual bool DefeatOnPlayerDeath [get]
 
virtual bool DefendFirst [get]
 
virtual bool IsCastTimeTick [get]
 
virtual Combatant SelectingCombatant [get, set]
 

Member Function Documentation

◆ SetData()

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

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

Parameters
dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseBattle.