ORK Framework  2.26.1
API Documentation
ORKFramework.BaseBattle Class Referenceabstract
Inheritance diagram for ORKFramework.BaseBattle:
ORKFramework.BaseData ORKFramework.IBaseData ORKFramework.ActiveTimeBattle ORKFramework.PhaseBattle ORKFramework.RealTimeBattle ORKFramework.TurnBasedBattle

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
virtual bool IsDynamicCombat ()
virtual bool CanChoose (Combatant combatant)
virtual bool CanDecreaseActionTime (Combatant combatant)
virtual void SetDecisionTime (Combatant combatant)
virtual float GetDefendActionCost (Combatant user)
virtual float GetEscapeActionCost (Combatant user)
virtual float GetNoneActionCost (Combatant user)
virtual float GetChangeMemberActionCost (Combatant user)
virtual float GetGridMoveActionCost (Combatant user)
virtual void BattleMenuCanceled (Combatant user)
virtual bool CombatantClicked (Combatant combatant)
virtual bool UseControlMap ()
virtual void StartBattle (bool changed)
virtual void RemoveFromOrder (Combatant combatant)
virtual void OrderChange (Combatant combatant, float change)
virtual void CombatantChanged (Combatant oldCombatant, Combatant newCombatant)
virtual void Tick ()
virtual bool DoCombatantTick ()
virtual void ActionAdded (BaseAction action)
virtual void ActionUnshifted (BaseAction action)
void PerformAction (BaseAction action)
virtual void PerformingAction (BaseAction action)
virtual void ActionFinished (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

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

void PerformNextAction ()
IEnumerator PerformNextAction2 ()
abstract void PerformNextAction3 ()

Protected Attributes

List< CombatantgroupAuto


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.BaseBattle.SetData ( DataObject  data)

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

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseData.

Reimplemented in ORKFramework.PhaseBattle, and ORKFramework.TurnBasedBattle.