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(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes, out isModifierDefault : Bool) : TweakDBID;
GetBonus
GetBonus(objID : StatsObjectID, statPoolType : gamedataStatPoolType, optional perc : Bool) : Float;
GetModifier
GetModifier(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes, out modifier : StatPoolModifier) : Bool;
GetStatPoolMaxPointValue
GetStatPoolMaxPointValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Float;
GetStatPoolType
GetStatPoolType(damageType : gamedataDamageType) : gamedataStatPoolType;
GetStatPoolValue
GetStatPoolValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, optional perc : Bool) : Float;
GetStatPoolValueCustomLimit
GetStatPoolValueCustomLimit(objID : StatsObjectID, statPoolType : gamedataStatPoolType, optional perc : Bool) : Float;
HasActiveStatPool
HasActiveStatPool(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;
HasStatPoolValueReachedCustomLimit
HasStatPoolValueReachedCustomLimit(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;
HasStatPoolValueReachedMax
HasStatPoolValueReachedMax(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;
HasStatPoolValueReachedMin
HasStatPoolValueReachedMin(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;
IsStatPoolAdded
IsStatPoolAdded(objID : StatsObjectID, statPoolType : gamedataStatPoolType) : Bool;
RequestAddingStatPool
RequestAddingStatPool(objID : StatsObjectID, statPoolRecordID : TweakDBID, optional forceCreateStatPools : Bool);
RequestChangingStatPoolValue
RequestChangingStatPoolValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, diff : Float, instigator : wref:GameObject, forceChunkTransfering : Bool, optional perc : Bool);
RequestRegisteringListener
RequestRegisteringListener(objID : StatsObjectID, statPoolType : gamedataStatPoolType, listener : ref:IStatPoolsListener);
RequestRemovingStatPool
RequestRemovingStatPool(objID : StatsObjectID, statPoolType : gamedataStatPoolType);
RequestResetingModifier
RequestResetingModifier(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes);
RequestSettingModifier
RequestSettingModifier(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes, modifier : StatPoolModifier);
RequestSettingModifierWithRecord
RequestSettingModifierWithRecord(objID : StatsObjectID, statPoolType : gamedataStatPoolType, type : gameStatPoolModificationTypes, modifierRecordID : TweakDBID);
RequestSettingStatPoolBonus
RequestSettingStatPoolBonus(objID : StatsObjectID, statPoolType : gamedataStatPoolType, bonus : Float, instigator : wref:GameObject, persistentBonus : Bool, optional perc : Bool);
RequestSettingStatPoolMaxValue
RequestSettingStatPoolMaxValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, instigator : wref:GameObject);
RequestSettingStatPoolMinValue
RequestSettingStatPoolMinValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, instigator : wref:GameObject);
RequestSettingStatPoolValue
RequestSettingStatPoolValue(objID : StatsObjectID, statPoolType : gamedataStatPoolType, newValue : Float, instigator : wref:GameObject, optional perc : Bool);
RequestSettingStatPoolValueCustomLimit
RequestSettingStatPoolValueCustomLimit(objID : StatsObjectID, statPoolType : gamedataStatPoolType, newValue : Float, instigator : wref:GameObject, optional perc : Bool);
RequestSettingStatPoolValueIgnoreChangeMode
RequestSettingStatPoolValueIgnoreChangeMode(objID : StatsObjectID, statPoolType : gamedataStatPoolType, newValue : Float, instigator : wref:GameObject, optional perc : Bool);
RequestUnregisteringListener
RequestUnregisteringListener(objID : StatsObjectID, statPoolType : gamedataStatPoolType, listener : ref:IStatPoolsListener);
ToPercentage
ToPercentage(objID : StatsObjectID, statPoolType : gamedataStatPoolType, value : Float) : Float;
ToPoints
ToPoints(objID : StatsObjectID, statPoolType : gamedataStatPoolType, percValue : Float) : Float;