ORK Framework  2.26.1
API Documentation
ORKFramework.Combatants.CombatantStatus Class Reference
Inheritance diagram for ORKFramework.Combatants.CombatantStatus:
ORKFramework.ISaveData

Public Member Functions

 CombatantStatus (Combatant owner)
 
void MarkResetStatus ()
 Marks this combatant for a status recalculation in the next Update tick. More...
 
void MarkStatusBoundsCheck ()
 Marks this combatant for a status value bounds theck in the next Update tick. More...
 
void Tick (float time)
 
bool CheckDeath ()
 
bool CheckDeath (Combatant killedBy)
 
void Death ()
 
void HasDied ()
 
void SelectedShortcutChanged (PreviewSelection selectedPreview)
 
void UpdatePreview ()
 
void Init (int level)
 
float GetCounterChance (Combatant target)
 
float GetBlockChance (Combatant user)
 
float GetEscapeChance ()
 
float GetHitBonus ()
 
float GetCounterBonus ()
 
float GetCriticalBonus ()
 
float GetBlockBonus ()
 
float GetEscapeBonus ()
 
float GetWalkBonus ()
 
float GetRunBonus ()
 
float GetSprintBonus ()
 
float GetItemStealBonus ()
 
float GetMoneyStealBonus ()
 
float GetItemLimitBonus ()
 
float GetRandomBattleBonus ()
 
float GetExperienceFactorBonus ()
 
float GetGridMoveRangeBonus ()
 
float GetPositiveChangeModifier (int statusID)
 
float GetNegativeChangeModifier (int statusID)
 
int GetValueAtLevel (int statusID, int lvl)
 
void SetBaseDevelopmentAtLevel (int lvl, int percentPoints, int[] statusValues)
 
bool GetBaseDevelopmentAtLevel (ref int value, int lvl, int statusID)
 
bool GetBaseDevelopmentBonus (ref int value, int lvl, int statusID)
 
void SetClassDevelopmentAtLevel (int classID, int lvl, int percentPoints, int[] statusValues)
 
bool GetClassDevelopmentAtLevel (ref int value, int classID, int lvl, int statusID)
 
bool GetClassDevelopmentBonus (ref int value, int classID, int lvl, int statusID)
 
bool CheckLevelUp (ref string changes)
 
string ForceLevelUp ()
 
string LevelUp ()
 
AttackAttribute GetAttackAttribute (int index)
 
int [] GetDefenceAttributeIDs ()
 
DefAttrID GetDefenceAttributeID (int index)
 
DefenceAttribute GetDefenceAttribute (int index)
 
void CheckStatusBounds ()
 
void Regenerate (bool revive)
 Sets the 'Consumable' type status values to their maximum value. More...
 
void SetConsumableStartValues ()
 
void ResetStatus (bool checkDeath)
 
StatusPreviewInformation GetStatusChanges (EquipPartSlot[] equipment)
 
void GetStatusChanges (ref StatusPreviewInformation info, EquipPartSlot[] equipment)
 
StatusPreview GetPreviewChanges (StatusPreviewInformation info)
 
void PreviewCombinedStatusValues (StatusPreview preview)
 
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

LevelChanged LevelChanged
 
CombatantChanged DeathStateChanged
 
StatusValue this[int index] [get]
 
CombatantEffects Effects [get]
 
int Level [get]
 
int MaxLevel [get]
 
StatusDevelopment Development [get]
 
CombatantDeathState DeathState [get, set]
 
bool IsDead [get]
 
bool PreviewAvailable [get]
 
StatusPreview Preview [get]
 
float? ExperienceFactor [get]
 
AttributeTraits AttackAttributeTraits [get]
 
AttributeTraits DefenceAttributeTraits [get]
 

Member Function Documentation

◆ LoadGame()

void ORKFramework.Combatants.CombatantStatus.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.

◆ MarkResetStatus()

void ORKFramework.Combatants.CombatantStatus.MarkResetStatus ( )

Marks this combatant for a status recalculation in the next Update tick.

◆ MarkStatusBoundsCheck()

void ORKFramework.Combatants.CombatantStatus.MarkStatusBoundsCheck ( )

Marks this combatant for a status value bounds theck in the next Update tick.

◆ Regenerate()

void ORKFramework.Combatants.CombatantStatus.Regenerate ( bool  revive)

Sets the 'Consumable' type status values to their maximum value.

Parameters
revivetrue if a dead combatant should be revived.

◆ SaveGame()

DataObject ORKFramework.Combatants.CombatantStatus.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.