Skip to content

Class

TimeProgressBar

Generated GDScript class reference for CalendarTime.TimeProgressBar.

Status
Current
Version
v2.1.1
Source updated
2026-08-09
Generated on
2026-09-26

UI for showing and updating clock-driven progress. Driven by an explicit [GameClock] and its [signal TimeSignalBus.game_seconds_advanced] signal, not engine [code]_process(delta)[/code], so the bar stays deterministic under speed multipliers, pauses, manual advancement, and large single-step advances.

Source: addons/calendar_time/game_time/ui/time_progress_bar.gd

Syntax

class TimeProgressBar extends Control

Members

NameKindSummary
updatedSignalPairs with [code]GameTimeProgress.updated(progress)[/code] so consumers can use one uniform contract for anything with progress.
finishedSignalEmitted when the action finishes its timer duration successfully.
clockPropertyClock that drives this progress. Replacing after [method start] reconnects.
update_frequencyPropertyHow often to update progress_bar visuals, in game seconds. 0 updates on every clock tick.
durationPropertyAction duration in game seconds. Used when [code]auto_start[/code] is enabled or as a default for [method start].
auto_startPropertyIf [code]true[/code], starts automatically when the node enters the tree and a clock is bound.
progress_barPropertyThe progress bar this node drives. Optional.
startMethod
pauseMethod
resumeMethod
cancelMethod
updateMethod
is_finishedMethod