ORK Framework  3.17.1
API Documentation
GamingIsLove.ORKFramework.Combatants.CombatantBattle Class Reference
Inheritance diagram for GamingIsLove.ORKFramework.Combatants.CombatantBattle:

Public Member Functions

 CombatantBattle (Combatant owner)
 
void InitActionTime (float time, bool keepUnusedTime)
 
void SetKilledBy (Combatant attacker)
 Sets the combatant's killed by mark to another combatant. More...
 
void SetLastTargets (List< Combatant > list)
 
void AddToLastTargets (Combatant combatant)
 
void RemoveFromLastTargets (Combatant combatant)
 
void ClearLastTargets ()
 
void SetAttackedBy (Combatant attacker, bool addFaction)
 Adds an attacker to the combatant's attacked by list. More...
 
void RemoveAttackedBy (Combatant attacker, bool removeFaction)
 Removes an attacker from the combatant's attacked by list. More...
 
void ClearAttackedBy ()
 Clears the combatant's attacked by list. More...
 
bool CheckAttackedByFaction (FactionSetting faction)
 
void InitGridMoveRange ()
 
void ChooseGridOrientation (Notify callback, bool canCancel)
 
void AddUseBlock (UseBlock block)
 
void RemoveUseBlock (UseBlockType type, int id)
 
bool IsReuseBlocked (IShortcut shortcut)
 
float GetMaxReuseTime< T > (T shortcut)
 
float GetReuseTime (IShortcut shortcut)
 
string GetReuseTimeText (IShortcut shortcut, int decimals)
 
void ClearUseBlock ()
 
void ClearUseBlock (UseBlockType type)
 
void ChangeReuse (UseBlockType type, UseBlockScope scope, int id, int typeID, string customKey, float change, FloatOperator op)
 
void ChangeReuse (IShortcut shortcut, float change, FloatOperator op)
 
void AddAutoRemoveTemporaryAbility (RemoveTemporaryAbility remove)
 
void ClearAutoRemoveTemporaryAbility ()
 
void StartBattle ()
 
void EndBattle ()
 
void Escape ()
 
void Death ()
 
bool CanUse (float actionCost)
 
bool CheckActionCost (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)
 
virtual void InitBattleMenu ()
 
BattleMenu GetBattleMenuSettings ()
 
void ShowBattleMenu ()
 
void EndBattleMenu (bool cancel)
 
DataObject SaveGame ()
 
void LoadGame (DataObject data)
 

Protected Member Functions

void ClearBattle (bool start)
 

Properties

bool InBattle [get]
 
bool GroupChangeStayInBattle [get, set]
 
bool Defending [get, set]
 
bool EnableAutoAttack [get, set]
 
bool ItemStolen [get, set]
 
bool CurrencyStolen [get, set]
 
CombatantTurnState TurnState [get, set]
 
AllowTurnControl TurnControlAllowed [get, set]
 
AllowTurnControl TurnCameraControlAllowed [get, set]
 
bool ReceiveActionsPerTurn [get, set]
 
GridMoveState GridMoveState [get, set]
 
CombatantLinks CombatantLinks [get]
 
bool HasCombatantLinks [get]
 
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, set]
 
Combatant KilledBy [get]
 
List< CombatantLastTargets [get]
 
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]
 

Member Function Documentation

◆ ClearAttackedBy()

void GamingIsLove.ORKFramework.Combatants.CombatantBattle.ClearAttackedBy ( )

Clears the combatant's attacked by list.

◆ RemoveAttackedBy()

void GamingIsLove.ORKFramework.Combatants.CombatantBattle.RemoveAttackedBy ( Combatant  attacker,
bool  removeFaction 
)

Removes an attacker from the combatant's attacked by list.

Parameters
attackerThe attacker
removeFactiontrue if the combatant's faction should be removed (in case no other faction membe attacked the combatant).

◆ SetAttackedBy()

void GamingIsLove.ORKFramework.Combatants.CombatantBattle.SetAttackedBy ( Combatant  attacker,
bool  addFaction 
)

Adds an attacker to the combatant's attacked by list.

Parameters
attackerThe attacker.
addFactiontrue if the attacker's faction should be recorded as well.

◆ SetKilledBy()

void GamingIsLove.ORKFramework.Combatants.CombatantBattle.SetKilledBy ( Combatant  attacker)

Sets the combatant's killed by mark to another combatant.

Parameters
attackerThe attacker.

Property Documentation

◆ CanEndTurn

bool GamingIsLove.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.