Optional
colorOptional
darkThe CSS variable to use for the background of the stat bar Defaults to black
Optional
displayFor the order this stat displays in. Smaller numbers appear higher in the list.
Not providing displayPriority
uses 100
.
Optional
displayDefaults to StatDisplayType.Auto
Optional
imageThe number of alternate textures that this image has. Not supported for most things.
Optional
imageA replacement image to use. Used in modding.
Optional
modDo not provide or modify this value, only reference it. This is set by the modding system during the process of registration.
Optional
multiThis stat displays as multiple sub-stats. (Incompatible with all other properties)
Sub-stats always display as StatDisplayType.Attribute
Optional
onHandlers for when the stat changes. Called when the stat changes & when the stat max changes.
Optional
rgbThe CSS variable to use for the stat bar color in RGB format Defaults to white
Optional
subscriberOptional
tooltipA function that will initialize a tooltip for this stat element, or a reference to show a tooltip for
Optional
unlockableWhether this stat display should be unlockable. (Unlocked by doing player.addMilestone(Milestone.InternalStatDiscovery, stat)
)
Optional
getRequires StatDisplayType.Attribute
.
For overriding the normal formatted output of a stat.
Optional
stat: IStatOptional
getOptional
entity: default<unknown, number, EntityReferenceTypes, unknown>Optional
getOptional
entity: default<unknown, number, EntityReferenceTypes, unknown>Generated using TypeDoc
The CSS variable to use for the stat bar color Defaults to white