ORK Framework  2.29.0
API Documentation
ORKFramework.PhaseBattle Class Reference
Inheritance diagram for ORKFramework.PhaseBattle:
ORKFramework.BaseBattle ORKFramework.Events.IEventStarter ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

override void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
override void Tick ()
override void BattleMenuCanceled (Combatant user)
void CombatantCanceled (Combatant user, bool unsetLatestTurn)
override bool CombatantClicked (Combatant combatant)
override bool UseControlMap ()
override bool IsDynamicCombat ()
override bool CanChoose (Combatant combatant)
override bool CanDecreaseActionTime (Combatant combatant)
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)
void CombatantSelected (Combatant combatant)
void ClearPlayerChoice (bool close)
void ClearCurrentFaction ()
override void CombatantChanged (Combatant oldCombatant, Combatant newCombatant)
override void ActionAdded (BaseAction action)
override void PerformingAction (BaseAction action)
IEnumerator ActionFinished2 (BaseAction action)
override void ActionFinished (BaseAction action)
override void EndBattle ()
void EventEnded ()
void DontDestroy ()
void OnSceneLoaded ()
- Public Member Functions inherited from ORKFramework.BaseBattle
virtual void SetDecisionTime (Combatant combatant)
virtual void RemoveFromOrder (Combatant combatant)
virtual void OrderChange (Combatant combatant, float change)
virtual bool DoCombatantTick ()
virtual void ActionUnshifted (BaseAction action)
void PerformAction (BaseAction action)
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

bool activeCommand = false
bool dynamicCombat = false
float minTimeBetween = 0
PhaseTurnStartType autoStartTurn = PhaseTurnStartType.PhaseEnd
bool calculatePhase = false
int phaseFormulaID = 0
float initialValuePhase = 0
bool sumValues = false
TypeSorter sorter = new TypeSorter()
bool calculateCombatantOrder = false
int combatantOrderFormulaID = 0
float initialValueCombatantOrder = 0
TypeSorter combatantSorter = new TypeSorter(TypeSorter.Type.None)
bool groupLeadersFirst = false
bool autoCallBattleMenu = true
int battleMenuKey = 0
bool battleMenuCancelCloses = false
bool battleMenuKeyCloses = false
bool battleMenuKeyBack = false
bool canCounter = true
bool defeatPlayerDead = false
bool deathImmediately = false
bool endImmediately = false
bool defendFirst = false
bool selectingControlMap = false
ActionsPerTurnSettings actionsPerTurn = new ActionsPerTurnSettings()
ActionTimeSettings actionTime = new ActionTimeSettings()
PhaseCombatantChoice combatantChoice = new PhaseCombatantChoice()
- 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 useLeaveArenaNonPlayer = false
bool leaveArenaDestroyNonPlayer = false
bool leaveArenaDistanceToPlayer = false
Range leaveArenaRangeNonPlayer = 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 canCancelAutoGridMove = true
bool gridTurnEndOrientation = false
BattleBonuses bonuses = new BattleBonuses()

Protected Member Functions

void StartTurn ()
float GetFactionValue (List< Combatant > list)
IEnumerator NextPhaseWait ()
void NextPhase ()
void CheckPhaseCombatants ()
void SelectAction (Combatant combatant)
void GetNextAction ()
IEnumerator GetNextAction2 ()
override void PerformNextAction3 ()
- Protected Member Functions inherited from ORKFramework.BaseBattle
void PerformNextAction ()
IEnumerator PerformNextAction2 ()

Protected Attributes

List< KeyValuePair< int, List< Combatant > > > phaseOrder
List< CombatantcurrentFaction
List< CombatantperformedOrder = new List<Combatant>()
bool performingActions = false
bool inPlayerSelection = false
PhaseChangeEvent phaseEvent
int phaseEventFlag = 0
List< CombatantplayerControlled = new List<Combatant>()
Combatant selectingCombatant
int selectingCombatantIndex = -1
int firstPhaseRounds = 1
- Protected Attributes inherited from ORKFramework.BaseBattle
List< CombatantgroupAuto


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]
int CurrentFactionID [get]
bool PhaseEventRunning [get]
override bool IsMenuBackAllowed [get]
GameObject GameObject [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]
- Properties inherited from ORKFramework.Events.IEventStarter
GameObject GameObject [get]

Member Function Documentation

◆ SetData()

override void ORKFramework.PhaseBattle.SetData ( DataObject  data)

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

dataORKFramework.DataObject containing the data.

Reimplemented from ORKFramework.BaseBattle.