ORK Framework  3.17.1
API Documentation
GamingIsLove.ORKFramework.StatusEffect Class Reference
Inheritance diagram for GamingIsLove.ORKFramework.StatusEffect:
GamingIsLove.ORKFramework.IGUID GamingIsLove.ORKFramework.ITimestamp GamingIsLove.ORKFramework.IStatusBonus GamingIsLove.ORKFramework.IAddRandomStatusBonus

Public Member Functions

 StatusEffect (StatusEffectSetting effect)
 
 StatusEffect (DataObject data, Combatant owner)
 
 StatusEffect (StatusEffectSetting effect, Combatant owner, string guid, bool displayOnly, float endAfter, float timestamp)
 
bool CanChangeStatusValue (StatusValueSetting statusValue, int change)
 
AbsorbStatusValue GetEffectAbsorb (StatusValueSetting statusValue, int change)
 
void AddPrefabs (Combatant combatant)
 
void DestroyPrefabs ()
 
void AddAppliedToOthers ()
 
void RemoveAppliedToOthers ()
 
bool ReApply (Combatant user, IStatusEffectCast cast, VariableHandler castLocalVariables, SelectedDataHandler castSelectedData)
 
bool ApplyEffect (Combatant user, Combatant target, IStatusEffectCast cast, bool force, object source, VariableHandler castLocalVariables, SelectedDataHandler castSelectedData)
 
void RemoveEffect (bool force, bool showFlyingText, bool showConsole, EffectRemoveOrigin removeOrigin)
 
void ResetChange (bool isUser, bool isCombined)
 
void PreviewResetChange (StatusPreview preview, bool isUser, bool isCombined)
 
int GetStackedCount ()
 
string RemainingTimeHUD (int decimals, string noTimeText)
 
string RemainingTimeMaxHUD (int decimals, string noTimeText)
 
bool ChangeDuration (float value, FloatOperator floatOperator)
 
void DurationEnd ()
 
bool TurnCheck (bool turnStart, ref bool checkStatusBounds)
 
bool BattleTurnCheck (bool turnStart, ref bool checkStatusBounds)
 
bool TimeCheck (float t, ref bool checkStatusBounds)
 
bool ActionCheck (BaseAction action, bool actionStart, ref bool checkStatusBounds)
 
bool PhaseCheck (bool phaseStart, ref bool checkStatusBounds)
 
bool CustomCheck (string key, ref bool checkStatusBounds)
 
string GetName ()
 
string GetShortName ()
 
string GetDescription ()
 
string GetIconTextCode ()
 
Texture GetIconTexture ()
 
virtual Sprite GetIconSprite ()
 
virtual string GetCustomContent (string contentKey)
 
IContent GetTypeContent ()
 
virtual StatusPreviewInformation GetStatusBonus ()
 Gets the blank bonus provided by the status bonus. More...
 
virtual void GetStatusBonus (ref StatusPreviewInformation info)
 Adds the bonus provided by the status bonus to existing status bonus information. More...
 
virtual void AddRandomStatusBonus (RandomStatusBonusSettings settings)
 
virtual void RemoveAllStatusBonuses ()
 
void ShowAddText (Combatant combatant, bool showFlyingText, bool showConsole, bool isRecast)
 
void ShowMissText (Combatant combatant, bool showFlyingText, bool showConsole)
 
void ShowRemoveText (Combatant combatant, bool showFlyingText, bool showConsole)
 
DataObject SaveGame ()
 
void LoadGame (DataObject data)
 

Protected Member Functions

void InitializeCallsLoad ()
 
void InitializeCalls (VariableHandler castLocalVariables, SelectedDataHandler castSelectedData)
 
void Initialize ()
 

Protected Attributes

StatusEffectSetting setting
 
string guid = ""
 
bool displayOnly = false
 
BaseEffectStatusChangeType.Instance [] statusChange
 
Combatant user
 
Combatant target
 
object source
 
float timestamp = 0
 
VariableHandler localVariables
 
SelectedDataHandler localSelectedData
 
DataCall call
 
DataCall callSwitched
 
StatusBonusInstance statusBonus
 
float endAfter = 0
 
float endAfterMax = 0
 
int appliedTurns = 0
 
int appliedBattleTurns = 0
 
int appliedActions = 0
 
float appliedTime = 0
 
int appliedPhases = 0
 
int appliedCustom = 0
 
GameObject [] spawnedPrefabs
 

Properties

StatusEffectSetting Setting [get]
 
string GUID [get, set]
 
float Timestamp [get, set]
 
bool DisplayOnly [get, set]
 
int AppliedTurns [get, set]
 
int AppliedBattleTurns [get, set]
 
int AppliedActions [get, set]
 
float AppliedTime [get, set]
 
int AppliedPhases [get, set]
 
int AppliedCustom [get, set]
 
Combatant User [get, set]
 
Combatant Target [get]
 
DataCall Call [get]
 
DataCall CallSwitched [get]
 
VariableHandler Variables [get]
 
SelectedDataHandler SelectedData [get]
 
object Source [get]
 
float Duration [get, set]
 
float DurationMax [get, set]
 
int ID [get]
 
- Properties inherited from GamingIsLove.ORKFramework.IGUID
string GUID [get, set]
 
- Properties inherited from GamingIsLove.ORKFramework.ITimestamp
float Timestamp [get, set]
 

Member Function Documentation

◆ GetStatusBonus() [1/2]

virtual StatusPreviewInformation GamingIsLove.ORKFramework.StatusEffect.GetStatusBonus ( )
virtual

Gets the blank bonus provided by the status bonus.

Returns
Status bonus information.

Implements GamingIsLove.ORKFramework.IStatusBonus.

◆ GetStatusBonus() [2/2]

virtual void GamingIsLove.ORKFramework.StatusEffect.GetStatusBonus ( ref StatusPreviewInformation  info)
virtual

Adds the bonus provided by the status bonus to existing status bonus information.

Parameters
infoStatus bonus information.

Implements GamingIsLove.ORKFramework.IStatusBonus.