Skip to main content

Introduction

Base class for all Stat Sources

Fields#

NameDescription
On Stats ReloadedEvent raised when Stats are reloaded
On HeartbeatEvent raised every Update
On Token HeartbeatEvent raised when a Token Heartbeat is invoked

Properties#

NameDescription
initializedGets if the source has been initialized
instanceIdGets id for the instanced object
statIdsReturns a list of stat ids
statsReturns a dictionary of stats, keyed by id
registeredSourcesReturns a list of all registered sources
remoteStatSourcesReturns a dictionary of remote Stat Sources

Methods#

NameDescription
AddHotStatAdd a run-time stat
AddRemoteStatSourceAdd a new keyed remote Stat Source for use in formulas/expressions
AddStatModifierAdd a new Stat Modifier
ClearSourcesRemove all sources
ClearStatsRemove all stats
GetSourceGet a source
GetStatGet a stat
GetValueGet the value of a formula
InitializeInitialize this object
IsConditionTrueCheck if a condition is true
LoadDataLoad a list of stats
RaiseHeartbeatRaise a heartbeat event
RaiseTokenHeartbeatRaise a token heartbeat event
RegisterActionRegister an action
RegisterSourceRegister a source
RemoveRemoteStatSourceRemove a keyed remote Stat Source for use in formulas/expressions
RemoveSourceRemove a source
RemoveStatModifierRemove a Stat Modifier
RemoveStatModifiersFromSourceRemove all Stat Modifiers associated with a source
RunActionRun an action
ShutdownShutdown Stat Source
SubscribeToHeartbeatAdd subscription to heartbeat events
SubscribeToTokenHeartbeatAdd subscription to token heartbeat events
UnitializedStatListReturn a list of all stats in their uninitialized state
UnsubscribeFromHeartbeatRemove subscription from heartbeat events
UnsubscribeFromTokenHeartbeatRemove subscription from token heartbeat events