StatsSystem

Documents the StatsSystem 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 StatsSystem

To invoke the stats system, use the following Global function:

ss = Game.StatsSystem()

AddModifier(objID : StatsObjectID, modifierData : ref:gameStatModifierData) : Bool;

AddModifiers(objID : StatsObjectID, modifierData : array:ref:gameStatModifierData) : Bool;

AddSavedModifier(objID : StatsObjectID, modifierData : ref:gameStatModifierData) : Bool;

ApplyModifierGroup(objID : StatsObjectID, groupID : Uint64) : Bool;

DefineModifierGroupFromRecord(groupID : Uint64, recordID : TweakDBID) : Bool;

GetDamageRecordFromId(damageTypeRecordId : TweakDBID) : wref:DamageType_Record;

GetDamageRecordFromType(damageType : gamedataDamageType) : wref:DamageType_Record;

GetDamageRecordId(damageType : gamedataDamageType) : TweakDBID;

GetDamageType(statType : gamedataStatType) : gamedataDamageType;

GetDamageTypeByRecordID(damageTypeRecordId : TweakDBID) : gamedataDamageType;

GetStatBoolValue(objID : StatsObjectID, statType : gamedataStatType) : Bool;

GetStatDetails(objID : StatsObjectID) : array:gameStatDetailedData;

GetStatType(damageType : gamedataDamageType) : gamedataStatType;

GetStatValue(objID : StatsObjectID, statType : gamedataStatType) : Float;

GetStatValueFromDamageType(objId : StatsObjectID, damageType : gamedataDamageType) : Float;

RegisterListener(objID : StatsObjectID, listener : ref:IStatsListener);

RemoveAllModifiers(objID : StatsObjectID, statType : gamedataStatType, optional removeSavedModifiers : Bool) : Bool;

RemoveModifier(objID : StatsObjectID, modifierData : ref:gameStatModifierData) : Bool;

RemoveModifierGroup(objID : StatsObjectID, groupID : Uint64) : Bool;

UndefineModifierGroup(groupID : Uint64) : Bool;

UnregisterListener(objID : StatsObjectID, listener : ref:IStatsListener);

Last updated 3 years ago