Skip to content
ct

Class

GameClockSpeedControl

Generated GDScript class reference for CalendarTime.GameClockSpeedControl.

Status
Current
Version
v2.0.4
Updated
2026-08-09

Root controller for the Game Clock Speed Control template. This is the stable user-facing contract for the template scene. All normal configuration lives on the root node. The internal nodes are implementation details; selecting the root in the Inspector is all a first-time user needs. Configuration covers the controlled clock, the speed choices, and whether a running speed resumes the SceneTree. ## What this controls This control changes the Calendar Time clock's speed_multiplier — how fast the in-game calendar advances. It does not change Engine.time_scale, physics speed, or any camera (Camera2D / Camera3D). Those are engine concepts; this is a game-time concept. ## How it works The facade forwards its exported configuration to the internal GameClockSpeedSlider, which owns the low-level slider interaction and clock synchronization. Keeping the public contract on the root means the internal node hierarchy can change without breaking user scenes.

Source: addons/calendar_time/ui/time_speed/game_clock_speed_control.gd

Syntax

class GameClockSpeedControl extends PanelContainer

Members

NameKindSummary
clockPropertyThe GameClock whose timeline speed this control drives. Defaults to the canonical Four Seasons clock shipped with the templates, so instancing the template beside `default_time_host.tscn` works immediately. Assign your own clock to replace the starter clock. This never touches `Engine.time_scale`.
speed_choicesPropertyThe speed multiplier offered at each slider tick. Index 0 (value 0) pauses the calendar; 1.0 is normal speed; higher values fast-forward the calendar timeline. Editing this list updates the slider tick count and range.
unpause_on_speed_changePropertyWhen true, selecting any non-paused speed resumes a paused SceneTree, so this control doubles as a visible "resume" control. Leave on unless the hosting game owns pause/resume elsewhere. Does not affect `Engine.time_scale`.
unpause_requestedSignalEmitted when this control resumes the SceneTree. Forwarded from the internal slider; demo UI can use it to restore an engine playback control's label.