Skip to content

Stat

Inherits Instance

Stat is an object that represents a player stat to which players can be assigned to have their own number or string values.

Properties

DisplayName : string

The display name for this stat.

Methods

GetDisplayName → string

Parameters: ``

Returns the display name of the stat. If DisplayName is specified, it returns DisplayName; otherwise, it returns Name.

Set → nil

Parameters

player [ Player ]

val [ number ]

Set the value stat of player to string

Set → nil

Parameters

player [ Player ]

val [ string ]

Set the value stat of player to string

Get → any

Parameters: player [ Player ]

Get the value stat of player

GetTotalForTeam → number

Parameters: team [ Team ]

Get the total value for team

GetDisplayValue → string

Parameters: plr [ Player ]

Gets the display value for a player. If the value is a number, it is automatically converted to K/M/S format (e.g., 1K+, 12.3K+).