StatPoolsSystem

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

To invoke the stat pools system, use the following Global function:

sps = Game.StatPoolsSystem()

Sub-functions

GetActiveModifierRecordID

GetActiveModifierRecordID

GetActiveModifierRecordID(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes, out isModifierDefault : Bool) : TweakDBID;

Info & Usage

GetBonus

GetBonus

GetBonus(objID : StatsObjectID, statPoolType : gamedataStatPoolType, optional perc : Bool) : Float;

Info & Usage

GetModifier

GetModifier

GetModifier(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes, out modifier : StatPoolModifier) : Bool;

Info & Usage

GetStatPoolMaxPointValue

GetStatPoolMaxPointValue

GetStatPoolMaxPointValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Float;

Info & Usage

GetStatPoolType

GetStatPoolType

GetStatPoolType(damageType : gamedataDamageType) : gamedataStatPoolType;

Info & Usage

GetStatPoolValue

GetStatPoolValue

GetStatPoolValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, optional perc : Bool) : Float;

Info & Usage

GetStatPoolValueCustomLimit

GetStatPoolValueCustomLimit

GetStatPoolValueCustomLimit(objID : StatsObjectID, statPoolType : gamedataStatPoolType, optional perc : Bool) : Float;

Info & Usage

HasActiveStatPool

HasActiveStatPool

HasActiveStatPool(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;

Info & Usage

HasStatPoolValueReachedCustomLimit

HasStatPoolValueReachedCustomLimit

HasStatPoolValueReachedCustomLimit(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;

Info & Usage

HasStatPoolValueReachedMax

HasStatPoolValueReachedMax

HasStatPoolValueReachedMax(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;

Info & Usage

HasStatPoolValueReachedMin

HasStatPoolValueReachedMin

HasStatPoolValueReachedMin(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;

Info & Usage

IsStatPoolAdded

IsStatPoolAdded

IsStatPoolAdded(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;

Info & Usage

RequestAddingStatPool

RequestAddingStatPool

RequestAddingStatPool(objID : StatsObjectID, statPoolRecordID : TweakDBID, optional forceCreateStatPools : Bool);

Info & Usage

RequestChangingStatPoolValue

RequestChangingStatPoolValue

RequestChangingStatPoolValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, diff : Float, instigator : wref:GameObject, forceChunkTransfering : Bool, optional perc : Bool);

Info & Usage

RequestRegisteringListener

RequestRegisteringListener

RequestRegisteringListener(objID : StatsObjectID, statPoolType : gamedataStatPoolType, listener : ref:IStatPoolsListener);

Info & Usage

RequestRemovingStatPool

RequestRemovingStatPool

RequestRemovingStatPool(objID : StatsObjectID, statPoolType : gamedataStatPoolType);

Info & Usage

RequestResetingModifier

RequestResetingModifier

RequestResetingModifier(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes);

Info & Usage

RequestSettingModifier

RequestSettingModifier

RequestSettingModifier(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes, modifier : StatPoolModifier);

Info & Usage

RequestSettingModifierWithRecord

RequestSettingModifierWithRecord

RequestSettingModifierWithRecord(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes, modifierRecordID : TweakDBID);

Info & Usage

RequestSettingStatPoolBonus

RequestSettingStatPoolBonus

RequestSettingStatPoolBonus(objID : StatsObjectID, statPoolType : gamedataStatPoolType, bonus : Float, instigator : wref:GameObject, persistentBonus : Bool, optional perc : Bool);

Info & Usage

RequestSettingStatPoolMaxValue

RequestSettingStatPoolMaxValue

RequestSettingStatPoolMaxValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, instigator : wref:GameObject);

Info & Usage

RequestSettingStatPoolMinValue

RequestSettingStatPoolMinValue

RequestSettingStatPoolMinValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, instigator : wref:GameObject);

Info & Usage

RequestSettingStatPoolValue

RequestSettingStatPoolValue

RequestSettingStatPoolValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, newValue : Float, instigator : wref:GameObject, optional perc : Bool);

Info & Usage

RequestSettingStatPoolValueCustomLimit

RequestSettingStatPoolValueCustomLimit

RequestSettingStatPoolValueCustomLimit(objID : StatsObjectID, statPoolType : gamedataStatPoolType, newValue : Float, instigator : wref:GameObject, optional perc : Bool);

Info & Usage

RequestSettingStatPoolValueIgnoreChangeMode

RequestSettingStatPoolValueIgnoreChangeMode

RequestSettingStatPoolValueIgnoreChangeMode(objID : StatsObjectID, statPoolType : gamedataStatPoolType, newValue : Float, instigator : wref:GameObject, optional perc : Bool);

Info & Usage

RequestUnregisteringListener

RequestUnregisteringListener

RequestUnregisteringListener(objID : StatsObjectID, statPoolType : gamedataStatPoolType, listener : ref:IStatPoolsListener);

Info & Usage

ToPercentage

ToPercentage

ToPercentage(objID : StatsObjectID, statPoolType : gamedataStatPoolType, value : Float) : Float;

Info & Usage

ToPoints

ToPoints

ToPoints(objID : StatsObjectID, statPoolType : gamedataStatPoolType, percValue : Float) : Float;

Info & Usage