Meter
Overview
The meter module allows for radial and linear meters. These are useful for showing progress, cooldowns, and other percentage based indicators.
Properties
Meter Type
Default: Radial
Whether the meter should be radial or linear in presentation.
Start Angle
The start angle of the radial meter in degrees. Vertical is 0. Can be negative.
End Angle
The start angle of the radial meter in degrees. Vertical is 0. Can be negative.
Meter Stroke
The weight of the stroke in percentage of radius. For example, a meter 100px wide, with a 50 stroke would have a 25px stroke.
Min Value
The minimum value of the meter.
Max Value
The maximum value of the meter.
Initial Value
The initial value of the meter when the Module is loaded.
Style Properties
Min Height
The minimum height of the meter.
Max Height
The maximum height of the meter.
Min Width
The minimum width of the meter.
Max Width
The maximum width of the meter.
Width
The width of the meter.
Height
The height of the meter.
Background Color
The background color of the meter.
Start Color
The color of the meter progress at the minimum value.
End Color
The color of the meter progress at the maximum value.
Broadcasters
On Complete
Fires when the current value reaches the minimum or maximum value.
Type
"maximum" | "minimum"
Whether the meter reached the minimum or maximum value.
meta.type
Listeners
Set Value
Sets the current value of the meter.
Value
number
The new value to set the meter to.
Set Min Value
Sets the minimum value of the meter.
Value
number
The new value to set the minimum value to.
Set Max Value
Sets the maximum value of the meter.
Value
number
The new value to set the maximum value to.
Last updated
Was this helpful?