Skip to content
Version 2.32.0
↓ Get the launcher

ITimeOfDay interface

Pins the in-world clock (time of day) to a chosen hour, then hands it back to the server. Shared by every plugin. Main thread only.

public interface ITimeOfDay
name description
CurrentHour { get; } The in-world hour right now (0..24), or 0 when it cannot be read.
IsAvailable { get; } Whether this client can pin the clock at all (grey the control out when false).
Pin(…) Pins the clock to hour (0..24, clamped) until the pin is disposed. The newest held pin wins; disposing it falls back to the previous held pin, and disposing the last one hands time back to the server.

Interiors and cutscenes set the clock themselves; while a pin is held the framework re-asserts it after those (event-driven). The clock is driven through the game’s own time-of-day calls; the server clock itself is never touched. Pins a plugin still holds are released when it unloads.