StatusEffectSystem

Documents the StatusEffectSystem class and its functions.

NOT DOCUMENTED We currently don't have information on how these functions work. They are being documented here for visibility.

Invoking StatusEffectSystem

To invoke the status effect system, use the following Global function:

ses = Game.StatusEffectSystem()

Sub-functions

ApplyStatusEffect

ApplyStatusEffect

ApplyStatusEffect(objID : EntityID, statusEffectID : TweakDBID, optional instigatorID : TweakDBID, optional instigatorEntityID : EntityID, optional applyCount : Uint32, optional direction : Vector4) : Bool;

Info & Usage

GetAppliedEffects

GetAppliedEffects

GetAppliedEffects(objID : EntityID, out appliedEffects : array:ref:StatusEffect);

Info & Usage

HasStatusEffect

HasStatusEffect

HasStatusEffect(objID : EntityID, statusEffectID : TweakDBID) : Bool;

Info & Usage

HasStatusEffectOfType

HasStatusEffectOfType

HasStatusEffectOfType(objID : EntityID, statusEffectType : gamedataStatusEffectType) : Bool;

Info & Usage

HasStatusEffectWithTag

HasStatusEffectWithTag

HasStatusEffectWithTag(objID : EntityID, tag : CName) : Bool;

Info & Usage

RegisterListener

RegisterListener

RegisterListener(objID : EntityID, listener : ref:IStatusEffectListener);

Info & Usage

RemoveAllStatusEffectOfType

RemoveAllStatusEffectOfType

RemoveAllStatusEffectOfType(objID : EntityID, statusEffectType : gamedataStatusEffectType) : Bool;

Info & Usage

RemoveStatusEffect

RemoveStatusEffect

RemoveStatusEffect(objID : EntityID, statusEffectID : TweakDBID, optional removeCount : Uint32) : Bool;

Info & Usage

SetStatusEffectRemainingDuration

SetStatusEffectRemainingDuration

SetStatusEffectRemainingDuration(objID : EntityID, statusEffectID : TweakDBID, duration : Float) : Bool;

Info & Usage