Class TimbnPluginClock

Namespace

Timbn.GraveyardKeeperTwo.Core.Framework

Assembly

Timbn.GraveyardKeeperTwo.Core.dll

Changes how fast the game's time runs on behalf of a plugin, undone when the plugin unloads or the player returns to the main menu. See TimbnClock to read the day and time. Reach it through the plugin's Clock property.

public sealed class TimbnPluginClock

Inheritance

object

TimbnPluginClock

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Freeze()

Stops the game's clock until the returned handle is disposed, so the time of day, the weather and the calendar stand still while the world keeps moving. Several plugins can hold it at once, and the clock runs again when the last one lets go, unless the game unpaused it meanwhile. Setting the clock's pause flag directly instead makes mods undo each other.

public IDisposable Freeze()

Returns

IDisposable

A handle that starts the clock again when disposed. It is also released when the plugin unloads and on the way to the main menu.

Examples

_frozen = Clock.Freeze();
// later
_frozen?.Dispose();

MultiplyGameSpeed(float)

Makes the game's time run faster or slower until the returned handle is disposed, the way sleeping runs it 50 times faster. Several plugins can hold a speed at once, and the newest one wins. When the last is released, the speed goes back to what it was, unless the game changed it meanwhile, in which case the game's value stays. Changing the speed directly with SetTimeSpeedMultiplier instead makes mods undo each other.

public IDisposable MultiplyGameSpeed(float multiplier)

Parameters

multiplier float

How many times faster than normal time runs. 1 is normal speed.

Returns

IDisposable

A handle that puts the speed back when disposed. It is also released when the plugin unloads and on the way to the main menu.

Examples

_fastTime = Clock.MultiplyGameSpeed(7f);
// later
_fastTime?.Dispose();