Table of Contents

Class GameEventExtensions

Namespace
SkyrimForge
Assembly
SkyrimForge.dll

Provides extension members for IGameEvent<TArgs> of FrameEventArgs.

public static class GameEventExtensions
Inheritance
GameEventExtensions
Inherited Members

Methods

SubscribeEvery(IGameEvent<FrameEventArgs>, TimeSpan, Action<TimeSpan>)

Registers handler to run each time UnpausedTime advances by interval.

public static ISubscription SubscribeEvery(this IGameEvent<FrameEventArgs> frames, TimeSpan interval, Action<TimeSpan> handler)

Parameters

frames IGameEvent<FrameEventArgs>
interval TimeSpan

The unpaused time between runs.

handler Action<TimeSpan>

Receives the unpaused time since the previous run, which is interval or more.

Returns

ISubscription

Exceptions

ArgumentNullException

handler is null.

ArgumentOutOfRangeException

interval is zero or negative.

SubscribeEvery(IGameEvent<FrameEventArgs>, TimeSpan, Func<TimeSpan, Task>)

Registers handler to run each time UnpausedTime advances by interval.

public static ISubscription SubscribeEvery(this IGameEvent<FrameEventArgs> frames, TimeSpan interval, Func<TimeSpan, Task> handler)

Parameters

frames IGameEvent<FrameEventArgs>
interval TimeSpan

The unpaused time between runs.

handler Func<TimeSpan, Task>

Receives the unpaused time since the previous run, which is interval or more.

Returns

ISubscription

Remarks

One run at a time: an interval that completes while the previous run is in progress starts no run.

Exceptions

ArgumentNullException

handler is null.

ArgumentOutOfRangeException

interval is zero or negative.