ORK Framework  2.23.0
API Documentation
ORKFramework.Battle Class Reference
Inheritance diagram for ORKFramework.Battle:
ORKFramework.ISaveData

Public Member Functions

void SetSettings ()
 
void ClearBattle ()
 
bool IsTurnBased ()
 
bool IsActiveTime ()
 
bool IsRealTime ()
 
bool IsRealTimeArea ()
 
bool IsPhase ()
 
bool IsType (BattleSystemType type)
 
bool IsBattleRunning ()
 
bool IsDynamicCombat ()
 
bool CanChoose (Combatant combatant)
 
bool CanDecreaseActionTime (Combatant combatant)
 
void SetDecisionTime (Combatant combatant)
 
float GetDefendActionCost (Combatant user)
 
float GetEscapeActionCost (Combatant user)
 
float GetNoneActionCost (Combatant user)
 
float GetChangeMemberActionCost (Combatant user)
 
float GetGridMoveActionCost (Combatant user)
 
void Join (List< Combatant > list)
 
void Join (Combatant combatant)
 
void RemoveCombatant (Combatant combatant, bool died)
 
void EnemyDefeated (Combatant combatant)
 
void GetGainsFrom (Combatant combatant)
 
void FireLatestTurn (Combatant combatant)
 Notifies all listeners to the 'LatestTurn' event handler that a combatant's turn started. More...
 
void FireCombatantJoined (Combatant combatant)
 Notifies all listeners to the 'CombatantJoined' event handler that a combatant joined the battle. More...
 
void FireCombatantRemoved (Combatant combatant)
 Notifies all listeners to the 'CombatantRemoved' event handler that a combatant was removed from battle. More...
 
void Tick ()
 
bool DoCombatantTick ()
 
void RemoveFromOrder (Combatant combatant)
 
void OrderChange (Combatant combatant, int change)
 
void CombatantChanged (Combatant oldCombatant, Combatant newCombatant)
 
void SetType (BattleSystemType type)
 
void SetBattleArena (BattleComponent arena)
 
void StartBattle (bool canEscape)
 
void ChangeType (BattleSystemType type, bool clearActions, bool stopActions)
 
void StartBonus (Combatant combatant)
 
void TurnBonus (Combatant combatant)
 
void EndBonus (Combatant combatant)
 
void ReviveBonus (Combatant combatant)
 
void EndBattle (BattleOutcome outcome)
 
void CancelBattleEnd ()
 
void CheckBattleEnd ()
 
void BattleVictory ()
 
void BattleEscaped ()
 
void BattleLost ()
 
void BattleLeftArena ()
 
void ClearObjectsAndAnimations ()
 
bool HasGains ()
 
void ClearGains ()
 
void AddLoot (ItemGain item)
 
void AddExperienceReward (int statusID, int exp, int level, int classLevel)
 
void AddNormalStatusValueReward (int statusID, int value)
 
void CollectGains (bool collectLoot, bool collectExp, bool showGains, float autoClose, bool autoCloseControlable, bool useItemBox, bool itemBoxAddType, string itemBoxID, BaseEvent baseEvent, int next)
 
void SetLooks (Combatant user)
 
void DoLookAt (Combatant user, List< Combatant > group, List< Combatant > enemies)
 
void DoLookAt (Combatant user, List< Combatant > targets)
 
Vector3 GetGroupCenterPosition (List< Combatant > cs)
 
GameObject GetGroupCenter (List< Combatant > cs)
 
GameObject GetGroupBaseCenter (List< Combatant > cs)
 
void GroupLookAt (Combatant user, List< Combatant > cs, Vector3 position)
 
void UserLookAt (Combatant user, Vector3 position)
 
GameObject GetCombatantCenter ()
 
GameObject GetArenaCenter ()
 
void AddChoosingCombatant (Combatant combatant)
 
void RemoveChoosingCombatant (Combatant combatant)
 
void ClearChoosingCombatants ()
 
bool DisplayInfoTexts ()
 
Combatant GetMenuUser ()
 
void AddMenuUser (Combatant c)
 
void RemoveMenuUser (Combatant combatant)
 
void ClearMenuUsers ()
 
bool CombatantClicked (Combatant combatant)
 
void ResetCursorOverCombatant ()
 
bool CombatantCursorOver (Combatant combatant)
 
void ChangeMenuUserIndex (int change)
 
void ChangeMenuAbilityLevel (int change)
 
void BattleMenuCanceled (Combatant user)
 
void DoBattleBlock (int add)
 
void DoBattleMenuBlock (int add)
 
void DoAllActionsBlock (int add)
 
void DoPlayerActionsBlock (int add)
 
void AllowPlayerTurnControl (int add, Combatant combatant, AllowTurnControl state)
 
void TransferPlayerControl (Combatant combatant, bool reset)
 
bool CanUseMoveAI (Combatant combatant)
 
void DoMoveAIBlock (int add)
 
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...
 

Static Public Member Functions

static Battle Instance ()
 

Properties

Notify BattleStarted
 
Notify SystemChanged
 
Notify BattleEnded
 
CombatantChanged EnemyKilled
 
CombatantChanged LatestTurn
 
CombatantChanged CombatantJoined
 
CombatantChanged CombatantRemoved
 
BattleSettings Settings [get]
 
BattleSystemSettings SystemSettings [get]
 
int Turn [get, set]
 
BattleActionHandler Actions [get]
 
BaseBattle System [get]
 
bool InBattle [get]
 
bool BattleEnd [get]
 
bool WaitForLastAction [get]
 
bool CanEscape [get]
 
bool CanCounter [get]
 
bool DeathImmediately [get]
 
bool MenuBlockAutoAttack [get]
 
bool CanAutoAttack [get]
 
bool DefendFirst [get]
 
bool IsCastTimeTick [get]
 
BattleComponent BattleArena [get]
 
BattleGridComponent Grid [get, set]
 
int RealTimeAreaCount [get, set]
 
GroupAdvantageType Advantage [get]
 
int PlayerMaxBattleGroupSize [get, set]
 
bool HasChoosingCombatants [get]
 
bool IsMenuBackAllowed [get]
 
bool MenuActive [get]
 
int MenuCount [get]
 
Combatant CursorOverCombatant [get]
 
Combatant SelectingCombatant [get]
 
bool IsTargetSelectionActive [get, set]
 

Member Function Documentation

void ORKFramework.Battle.FireCombatantJoined ( Combatant  combatant)

Notifies all listeners to the 'CombatantJoined' event handler that a combatant joined the battle.

Parameters
combatantThe combatant who joined.
void ORKFramework.Battle.FireCombatantRemoved ( Combatant  combatant)

Notifies all listeners to the 'CombatantRemoved' event handler that a combatant was removed from battle.

Parameters
combatantThe combatant who was removed.
void ORKFramework.Battle.FireLatestTurn ( Combatant  combatant)

Notifies all listeners to the 'LatestTurn' event handler that a combatant's turn started.

Parameters
combatantThe combatant who's turn started.
void ORKFramework.Battle.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.

DataObject ORKFramework.Battle.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.