Introduction

This component inherits from BasicStats and adds stats and effects to an object. It provides access to Stats, Attributes, Status Conditions, Stat Events, Status Effects, and Plugins.

Fields

Name	Description
On Effect Added	Event raised when a Status Effect is added
On Effect Removed	Event raised when a Status Effect is removed
On Resistance Added	Event raised when a Status Effect Resistance is added
On Resistance Removed	Event raised when a Status Effect Resistance is removed
Broadcast Messages	Broadcast message to 'GDTK_STATS' channel
Plugins	List of plugins to run in sequence
On Stats Reloaded	Event raised when Stats are reloaded
On Initialized	Event raised when Stats is initialized
On Shutdown	Event raised when Stats is initialized
On Event Triggered	Event raised when a Stat Event is triggered
On Attribute Added	Event raised when an Attribute is added
On Attribute Removed	Event raised when an Attribute is removed
On Status Condition Added	Event raised when a Status Condition is added
On Status Condition Removed	Event raised when a Status Condition is removed
On Focus Added	Event raised when Focus is added
On Focus Removed	Event raised when Focus is removed
On Focuses Changed	Event raised when Focuses change
On Heartbeat	Event raised every Update
On Token Heartbeat	Event raised when a Token Heartbeat is invoked
On Display Name Changed	Event raised when Display Name changes
On Color Changed	Event raised when Color changes

Properties

Name	Description
activeEffects	Returns a read-only list of Status Effects currently active on this object.
resistances	Returns a read-only list of Status Effects currently active on this object.
actor	Gets reference to the associated actor
attributes	Returns a read-only list of Attributes on the object.
blackboard	Returns the blackboard for the object
busy	True if the system is currently loading or saving data.
color	Color associated with this object
focuses	Returns a read-only list of Foceses assigned to the object
database	Returns a reference to the Stats Database in the scene.
displayName	Name of the creature or object attached
globalStats	Returns a reference to the Global Stats in the scene.
initialized	True if object has been initialized.
registeredSources	Returns a list of registered IUniquelyIdentifiable sources.
source	Returns base StatSource
startingAttributeIds	Returns list of starting attribute ids
startingConditionIds	Returns list of starting status condition ids
stats	Returns a list of initialized stats.
statusConditions	Returns a read-only list of initialized Status Conditions.

Methods

Name	Description
AddEffect	Adds a Status Effect to the object by id.
AddEffectResistance	Adds a Status Effect Resistance to the object by id.
DataLoad	Loads data to a specified stream
DataLoadJSON	Load data from JSON string
DataLoadJSONFile	Load JSON data from file
DataSave	Saves data to a specified file
DataSaveJSON	Save data as a JSON string
GetModifier	Get a Stat Modifier by instance id
Initialize	Initialize the object. This is done automatically on Awake.
RemoveEffect	Removes an effect from the object by id.
RemoveEffectResistance	Removes all Status Effect Resistance by id
RemoveEffectResistancesFromSource	Remove all Status Effect Resistance from a specified source
Shutdown	Shutdown the system
SubscribeToEffectEvents	Subscribes to Status Effect events.
UnsubscribeFromEffectEvents	Unsubscribes from Status Effect events.
AddAttribute	Add an Attribute to the object.
AddFocus	Adds a Focus to the object. If that Focus already exists its level is increased by 1.
AddStat	Adds a new Stat to the object. Cannot be done while object is initialized.
AddStatModifier	Adds a new Stat Modifier to the object.
AddStatusCondition	Adds a Status Condition to the object.
ClearSources	Removes all Identifiable Sources. Cannot be done while initialized.
ClearStats	Removes all Stats. Cannot be done while initialized.
GetFocus	Get a Focus available on this object by id
GetFocusLevel	Get the level of a Focus available on this object by id
GetPlugin	Get a plugin of a specific tyep
GetSource	Returns an Identifiable Source by id
GetStat	Get a Stat by id.
GetValue	Get the value of a formula/expression.
GetValueWithDictionary	Get the value of a formula/expression.
HasAttribute	True if object has an Attribute with the provided id.
HasFocus	Check if object has a specific Focus
HasFocuses	Check if object has a list Focuses
IsConditionTrue	Check if an expression resolves to true.
JSONExport	Export all data to JSON
JSONImport	Import JSON data
RaiseEvent	Raises a Stat Event by id
RaiseTokenHeartbeat	Raises a Token Heartbeat
RefreshActor	Attempt to find actor for component
RegisterSource	Manually add an IUniquelyIdentifiable source
RemoveAttribute	Remove an Attribute by id
RemoveAttributesFromSource	Remove all Attributes from a specified source
RemoveFocus	Remove a Focus from object
RemoveFocusesFromSource	Remove all Focuses from a specified source
RemoveSource	Remove a IUniquelyIdentifiable source
RemoveStatModifier	Remove a Stat Modifier
RemoveStatModifiersFromSource	Remove all Stat Modifiers from a specified source
RemoveStatusCondition	Remove a Status Condition by Id
RemoveStatusConditionsFromSource	Remove all Status Conditions from a specified source
SubscribeToAttributeChange	Subscribe to Attribute changes
SubscribeToEventTriggers	Subscribe to Stat Events
SubscribeToFocusChange	Subscribe to Focus changes
SubscribeToHeartbeat	Subscribe to Heartbeats
SubscribeToTokenHeartbeat	Subscribe to Token Heartbeats
UnsubscribeFromAttributeChange	Remove subscription from Attribute changes
UnsubscribeFromEventTriggers	Remove subscription from Stat Events
UnsubscribeFromFocusChange	Remove subscription from Focus changes
UnsubscribeFromHeartbeat	Remove subscription from Heartbeats
UnsubscribeFromTokenHeartbeat	Remove subscription from TokenHeartbeats