Class NoOpPluginMapResourceCatalog

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

Inert map resource provider for headless hosts.

public sealed class NoOpPluginMapResourceCatalog : IPluginMapResourceCatalog

Inheritance

object

NoOpPluginMapResourceCatalog

Implements

IPluginMapResourceCatalog

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Instance

The one shared instance.

public static NoOpPluginMapResourceCatalog Instance { get; }

Property Value

NoOpPluginMapResourceCatalog

Methods

OpenMapAsync(string, CancellationToken)

Opens a tiled map among the plugin's resources.

public ValueTask<IPluginTiledMapResource?> OpenMapAsync(string resourceId, CancellationToken cancellationToken = default)

Parameters

resourceId string

The id of the map resource.

cancellationToken CancellationToken

Cancels the open.

Returns

ValueTask<IPluginTiledMapResource>

The map, or null when the host loads no maps or has no such resource. Dispose it when done.