ORK Framework  2.27.1
API Documentation
ORKFramework.StatusValue Class Reference
Inheritance diagram for ORKFramework.StatusValue:
ORKFramework.ISaveData

Public Member Functions

 StatusValue (int id, StatusValueSetting s, Combatant o)
 
void InitValue (int val)
 
int GetDisplayValue ()
 
void Tick (float t)
 
int GetPreviewValue (bool display)
 
int GetPreviewValueMax (bool display)
 
int GetPreviewMinValue ()
 
int GetPreviewMaxValue ()
 
void FinalPreviewValue (float percentBonus)
 
float GetCompareValuePreview (ValueSetter setter)
 
void AddValuePreview (int add, ref int[] statusValue, bool ignoreBarrier)
 
int GetValue ()
 
int GetBaseValue ()
 
int GetMinValue ()
 
int GetMaxValue ()
 
int GetConsumePotential ()
 
int GetTypeValue (StatusValueGetValue getType)
 
void SetValueAccess (int newValue, bool isCritical, bool ignoreBarrier, bool showFlyingText, bool showConsole, StatusValueChangeSource source)
 Sets the value via the access handler. More...
 
void SetValue (int newValue, bool isCritical, bool ignoreBarrier, bool showFlyingText, bool showConsole, StatusValueChangeSource source)
 Sets the value. More...
 
void AddValueAccess (int addValue, bool isCritical, bool checkDeath, bool checkLevelUp, bool ignoreBarrier, bool showFlyingText, bool showConsole, StatusValueChangeSource source)
 Adds to the value via the access handler. More...
 
void AddValue (int addValue, bool isCritical, bool checkDeath, bool checkLevelUp, bool ignoreBarrier, bool showFlyingText, bool showConsole, StatusValueChangeSource source)
 Adds a value. More...
 
void ResetValue (int bonus, bool checkBounds)
 
void SetBaseValueAccess (int newValue)
 Sets the base value via the access handler. More...
 
void SetBaseValue (int newValue)
 Sets the base value. More...
 
void AddBaseValueAccess (int addValue)
 Adds a value to the base value via the access handler. More...
 
void AddBaseValue (int addValue)
 Adds a value to the base value. More...
 
void FinalValue (float percentBonus)
 
void CheckBounds (bool checkDeath, bool checkLevelUp)
 
bool MaxReached ()
 
float GetCompareValue (StatusValueGetValue getType, ValueSetter setter)
 
bool IsDead ()
 
bool IsNormal ()
 
bool IsConsumable ()
 
bool IsExperience ()
 
bool IsBaseLevel ()
 
bool IsClassLevel ()
 
bool IsNoneLevel ()
 
bool IsCombined ()
 
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

StatusValueChanged Changed
 
int RealID [get]
 
StatusValueSetting Setting [get]
 
int RealValue [get]
 
float Percent [get]
 
float PercentPreview [get]
 

Member Function Documentation

◆ AddBaseValue()

void ORKFramework.StatusValue.AddBaseValue ( int  addValue)

Adds a value to the base value.

Parameters
addValueThe value that will be added.

◆ AddBaseValueAccess()

void ORKFramework.StatusValue.AddBaseValueAccess ( int  addValue)

Adds a value to the base value via the access handler.

Parameters
addValueThe value that will be added.

◆ AddValue()

void ORKFramework.StatusValue.AddValue ( int  addValue,
bool  isCritical,
bool  checkDeath,
bool  checkLevelUp,
bool  ignoreBarrier,
bool  showFlyingText,
bool  showConsole,
StatusValueChangeSource  source 
)

Adds a value.

Parameters
addValueThe value that will be added.
isCriticaltrue if this is a critical value change.
checkDeathtrue if the combatant should check for death.
checkLevelUptrue if the combatant should check for level up.
ignoreBarriertrue if the change should ignore barrier status values.
showFlyingTexttrue if the change should display flying texts.
showConsoletrue if a console line should be added.
sourceThe source of the value change (e.g. combatant causing the change).

◆ AddValueAccess()

void ORKFramework.StatusValue.AddValueAccess ( int  addValue,
bool  isCritical,
bool  checkDeath,
bool  checkLevelUp,
bool  ignoreBarrier,
bool  showFlyingText,
bool  showConsole,
StatusValueChangeSource  source 
)

Adds to the value via the access handler.

Parameters
addValueThe value that will be added.
isCriticaltrue if this is a critical value change.
checkDeathtrue if the combatant should check for death.
checkLevelUptrue if the combatant should check for level up.
ignoreBarriertrue if the change should ignore barrier status values.
showFlyingTexttrue if the change should display flying texts.
showConsoletrue if a console line should be added.
sourceThe source of the value change (e.g. combatant causing the change).

◆ LoadGame()

void ORKFramework.StatusValue.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.StatusValue.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.

◆ SetBaseValue()

void ORKFramework.StatusValue.SetBaseValue ( int  newValue)

Sets the base value.

Parameters
newValueThe new value that will be used.

◆ SetBaseValueAccess()

void ORKFramework.StatusValue.SetBaseValueAccess ( int  newValue)

Sets the base value via the access handler.

Parameters
newValueThe new value that will be used.

◆ SetValue()

void ORKFramework.StatusValue.SetValue ( int  newValue,
bool  isCritical,
bool  ignoreBarrier,
bool  showFlyingText,
bool  showConsole,
StatusValueChangeSource  source 
)

Sets the value.

Parameters
newValueThe new value that will be used.
isCriticaltrue if this is a critical value change.
ignoreBarriertrue if the change should ignore barrier status values.
showFlyingTexttrue if the change should display flying texts.
showConsoletrue if a console line should be added.
sourceThe source of the value change (e.g. combatant causing the change).

◆ SetValueAccess()

void ORKFramework.StatusValue.SetValueAccess ( int  newValue,
bool  isCritical,
bool  ignoreBarrier,
bool  showFlyingText,
bool  showConsole,
StatusValueChangeSource  source 
)

Sets the value via the access handler.

Parameters
newValueThe new value that will be used.
isCriticaltrue if this is a critical value change.
ignoreBarriertrue if the change should ignore barrier status values.
showFlyingTexttrue if the change should display flying texts.
showConsoletrue if a console line should be added.
sourceThe source of the value change (e.g. combatant causing the change).