CreateMetric

What it does

This compatibility method behaves like CreateStat. Creates an animated statistic with optional delta and duration. It is kept so scripts written with the older CreateMetric name continue to work.

When to use it

Use it for a single KPI that may change and should emphasize the new value. Prefer CreateStat in new code so the method name matches the current API.

ElementFunction:CreateMetric(StatConfig)

local Result = Section:CreateMetric({
    Name = "Example",
    Callback = function(value)
        print(value)
    end,
})

Behavior and return value

This alias forwards to CreateStat, so its options, callbacks, and returned value follow the canonical method.

Fields marked optional may be omitted. XLQP then uses the method’s built-in default or leaves that feature disabled.

Related reference

• All element options
• Controller methods
• Full example