Class TimedUpdateRegistration

Namespace

Artemis.Core

Assembly

Artemis.Core.dll

Represents a registration for a timed plugin update

public sealed class TimedUpdateRegistration : IDisposable

Inheritance

object

TimedUpdateRegistration

Implements

IDisposable

Properties

Action

Gets the action that gets called each time the update event fires

public Action<double>? Action { get; }

Property Value

Action<double>

AsyncAction

Gets the task that gets called each time the update event fires

public Func<double, Task>? AsyncAction { get; }

Property Value

Func<double, Task>

Feature

Gets the plugin feature this registration is associated with

public PluginFeature Feature { get; }

Property Value

PluginFeature

Interval

Gets the interval at which the update should occur

public TimeSpan Interval { get; }

Property Value

TimeSpan

Name

Gets the name of this timed update

public string Name { get; }

Property Value

string

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Start()

Starts calling the Action or AsyncAction at the configured Interval

Note: Called automatically when the plugin enables

public void Start()

Stop()

Stops calling the Action or AsyncAction at the configured Interval

Note: Called automatically when the plugin disables

public void Stop()

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.