Interface ICalendarTimerFactory

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

Creates timers on the game's calendar that are saved with the game.

public interface ICalendarTimerFactory

Remarks

A running timer is stored in this plugin's saved state, and is due at the same calendar time after a save is loaded. The calendar is read on each frame while a game is loaded and one of this plugin's timers runs. Call members on the game's thread.

Methods

Create(string)

Creates a timer, which runs where the loaded game stored it as running.

ICalendarTimer Create(string key)

Parameters

key string

The saved-state name of the timer, unique among this plugin's timers and the same in every version of the plugin.

Returns

ICalendarTimer

Remarks

Callable from a plugin's start, before the game has data or a save.

Exceptions

ArgumentNullException

key is null.

ArgumentException

This plugin created a timer with key already.