Skip to content

Components

RadialProgress

A ring or pie that fills with a value from 0 to 1: a cooldown ring, a charge meter, a shield gauge. It fills clockwise, anticlockwise or both ways, and a hole in the middle makes it a ring. Goes under a Canvas.

On this page

Add it

Add component → RadialProgressComponent in the Inspector, on the node that should carry it.

From a script

A script on the same node writes these fields by name. RadialProgressComponent is the name to pass.

rgs
set_number("RadialProgressComponent", "value", 1.0);
set_number("RadialProgressComponent", "start", -90.0);
set_number("RadialProgressComponent", "inner_radius", 0.0);
set_colour("RadialProgressComponent", "color", vec4(1.0, 1.0, 1.0, 1.0));

Fields

FieldScript nameKindDefaultWhat it does
Valuevaluenumber, 0 to 1, step 0.011How full it is.
Startstartnumber-90 °Degrees clockwise from three o'clock.
Directiondirectionone of Clockwise, CounterClockwise, BothClockwiseWhich way the fill grows.
Inner Radiusinner_radiusnumber, 0 to 0.95, step 0.010The hole in the middle, as a fraction of the outer radius.
Segmentssegmentsnumber, 3 to 51264Segments a full turn would use.
Colorcolorcolour#ffffffColour of the ring or pie, including transparency.