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()

Sub-functions

AddModifier

AddModifier

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

Info & Usage

AddModifiers

AddModifiers

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

Info & Usage

AddSavedModifier

AddSavedModifier

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

Info & Usage

ApplyModifierGroup

ApplyModifierGroup

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

Info & Usage

DefineModifierGroupFromRecord

DefineModifierGroupFromRecord

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

Info & Usage

GetDamageRecordFromId

GetDamageRecordFromId

GetDamageRecordFromId(damageTypeRecordId : TweakDBID) : wref:DamageType_Record;

Info & Usage

GetDamageRecordFromType

GetDamageRecordFromType

GetDamageRecordFromType(damageType : gamedataDamageType) : wref:DamageType_Record;

Info & Usage

GetDamageRecordId

GetDamageRecordId

GetDamageRecordId(damageType : gamedataDamageType) : TweakDBID;

Info & Usage

GetDamageType

GetDamageType

GetDamageType(statType : gamedataStatType) : gamedataDamageType;

Info & Usage

GetDamageTypeByRecordID

GetDamageTypeByRecordID

GetDamageTypeByRecordID(damageTypeRecordId : TweakDBID) : gamedataDamageType;

Info & Usage

GetStatBoolValue

GetStatBoolValue

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

Info & Usage

GetStatDetails

GetStatDetails

GetStatDetails(objID : StatsObjectID) : array:gameStatDetailedData;

Info & Usage

GetStatType

GetStatType

GetStatType(damageType : gamedataDamageType) : gamedataStatType;

Info & Usage

GetStatValue

GetStatValue

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

Info & Usage

GetStatValueFromDamageType

GetStatValueFromDamageType

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

Info & Usage

RegisterListener

RegisterListener

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

Info & Usage

RemoveAllModifiers

RemoveAllModifiers

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

Info & Usage

RemoveModifier

RemoveModifier

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

Info & Usage

RemoveModifierGroup

RemoveModifierGroup

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

Info & Usage

UndefineModifierGroup

UndefineModifierGroup

UndefineModifierGroup(groupID : Uint64) : Bool;

Info & Usage

UnregisterListener

UnregisterListener

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

Info & Usage