Interface IStatDisplayDescription

Hierarchy

Properties

color? darkColor? displayOrder? displayType? imageCount? imagePath? modIndex? onChange? rgbColor? subscribeCalculateEquipmentStats? tooltip?

Methods

getFormatted?

Properties

Optional color

color?: string | ((entity: default<unknown, number, unknown>, stat: IStat) => string)

The CSS variable to use for the stat bar color Defaults to white

Optional darkColor

darkColor?: string | ((entity: default<unknown, number, unknown>, stat: IStat) => string)

The CSS variable to use for the background of the stat bar Defaults to black

Optional displayOrder

displayOrder?: number

For the order this stat displays in. Smaller numbers appear higher in the list.

Not providing displayPriority uses 100.

Optional displayType

displayType?: StatDisplayType

Defaults to StatDisplayType.Auto

Optional imageCount

imageCount?: number

The number of alternate textures that this image has. Not supported for most things.

Optional imagePath

imagePath?: string | ((entity: default<unknown, number, unknown>, stat: IStat) => string)

A replacement image to use. Used in modding.

Optional modIndex

modIndex?: number

Do not provide or modify this value, only reference it. This is set by the modding system during the process of registration.

Optional onChange

onChange?: ((statElement: default<HTMLElement>, entity: default<unknown, number, unknown>, stat: IStat, oldValue?: number) => void)[]

Handlers for when the stat changes. Called when the stat changes & when the stat max changes.

Optional rgbColor

rgbColor?: string | ((entity: default<unknown, number, unknown>, stat: IStat) => string)

The CSS variable to use for the stat bar color in RGB format Defaults to white

Optional subscribeCalculateEquipmentStats

subscribeCalculateEquipmentStats?: true

Optional tooltip

tooltip?: Reference | ((tooltip: default, entity: default<unknown, number, unknown>, stat: IStat) => any)

A function that will initialize a tooltip for this stat element, or a reference to show a tooltip for

Methods

Optional getFormatted

  • Requires StatDisplayType.Attribute.

    For overriding the normal formatted output of a stat.

    Parameters

    • entity: default<unknown, number, unknown>
    • Optional stat: IStat

    Returns default

Settings

Member Visibility

Theme

Generated using TypeDoc