Interface ICooldown

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

A span of UnpausedTime from each start, which a plugin tests to prevent an action, such as a reaction to a hit, from repeating within it. A new game or a save load ends it.

public interface ICooldown

Remarks

Callable on any thread. The time compared is that of the latest frame.

Properties

IsActive

Whether the cooldown has started in the current game and its duration has not passed since.

bool IsActive { get; }

Property Value

bool

Methods

TryStart()

Starts the cooldown where it is not active.

bool TryStart()

Returns

bool

True where it started, and false where it was active, which leaves its end unchanged.

Remarks

The test and the start are one step, so of two threads calling this at once, one starts it.