ORK Framework  2.25.2
API Documentation
ORKFramework.Combatants.CombatantBattle Class Reference
Inheritance diagram for ORKFramework.Combatants.CombatantBattle:
ORKFramework.ISaveData

Public Member Functions

 CombatantBattle (Combatant owner)
 
void FireBattleStateChanged ()
 Notifies all battle state change listeners that the battle state changed. More...
 
void InitActionTime (float time, bool keepUnusedTime)
 
void SetAttackedBy (Combatant c, bool addFaction)
 
void RemoveAttackedBy (Combatant c, bool removeFaction)
 
void ClearAttackedBy ()
 
bool CheckAttackedByFaction (int factionID)
 
void InitGridMoveRange ()
 
void ChooseGridOrientation (Notify callback, bool canCancel)
 
void AddUseBlock (UseBlock block)
 
void RemoveUseBlock (UseBlockType type, int id)
 
bool IsReuseBlocked (UseBlockType type, int id)
 
string GetReuseTimeText (UseBlockType type, int id, int decimals)
 
void ClearUseBlock ()
 
void ClearUseBlock (UseBlockType type)
 
void AddAutoRemoveTemporaryAbility (RemoveTemporaryAbility remove)
 
void RemoveAutoRemoveTemporaryAbility (int abilityID)
 
void ClearAutoRemoveTemporaryAbility ()
 
void ClearBattle (bool start)
 
void StartBattle ()
 
void EndBattle ()
 
void Escape ()
 
void Death ()
 
bool CanUse (float actionCost)
 
bool Tick (float battleTime)
 
void TickActionTime ()
 
bool InitNewTurn (bool canPerform)
 
void StartTurn (bool canPerform, Notify callback)
 
void StartEndTurn (Notify callback)
 
void InitTurnEnd (bool stopActionTime)
 
void EndTurnCommand (bool isSilent)
 
void EndTurn (Notify callback)
 
void ShowBattleMenu ()
 
void EndBattleMenu (bool cancel)
 
DataObject SaveGame ()
 Used to save the data - you need to add the data to a ORKFramework.DataObject. More...
 
void LoadGame (DataObject data)
 Used to load the data - you need to get the data from the ORKFramework.DataObject. More...
 

Properties

CombatantChanged GridMoveRangeChanged
 
CombatantChanged ActionBarChanged
 
CombatantChanged BattleStateChanged
 
CombatantChanged TurnStateChanged
 
bool InBattle [get]
 
bool Defending [get, set]
 
bool EnableAutoAttack [get, set]
 
bool ItemStolen [get, set]
 
bool MoneyStolen [get, set]
 
CombatantTurnState TurnState [get, set]
 
AllowTurnControl TurnControlAllowed [get, set]
 
AllowTurnControl TurnCameraControlAllowed [get, set]
 
bool ReceiveActionsPerTurn [get, set]
 
GridMoveState GridMoveState [get, set]
 
BattleStatistic Statistic [get]
 
int LastTurnIndex [get, set]
 
int Turn [get]
 
float TurnValue [get, set]
 
float TurnValueDummy [get, set]
 
bool TimeBarRunning [get, set]
 
float ActionBar [get, set]
 
float UsedActionBar [get, set]
 
float MaxActionBar [get, set]
 
float DelayTime [get, set]
 
float DelayTimeMax [get]
 
bool ActionTimeRunning [get, set]
 
float ActionTime [get, set]
 
float ActionTimeMax [get]
 
Combatant KilledBy [get, set]
 
List< CombatantLastTargets [get, set]
 
List< CombatantAttackedBy [get]
 
float GridMoveRange [get, set]
 
float GridMoveRangeMax [get, set]
 
bool CanEndTurn [get]
 Gets a value indicating wheter the combatant can end the turn. More...
 
ActiveBattleMenu BattleMenu [get]
 
int BattleMenuID [get]
 

Member Function Documentation

◆ FireBattleStateChanged()

void ORKFramework.Combatants.CombatantBattle.FireBattleStateChanged ( )

Notifies all battle state change listeners that the battle state changed.

◆ LoadGame()

void ORKFramework.Combatants.CombatantBattle.LoadGame ( DataObject  data)

Used to load the data - you need to get the data from the ORKFramework.DataObject.

Parameters
dataA ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

◆ SaveGame()

DataObject ORKFramework.Combatants.CombatantBattle.SaveGame ( )

Used to save the data - you need to add the data to a ORKFramework.DataObject.

Returns
A ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

Property Documentation

◆ CanEndTurn

bool ORKFramework.Combatants.CombatantBattle.CanEndTurn
get

Gets a value indicating wheter the combatant can end the turn.

true if the combatant can end the turn; otherwise, false.