Interface IPluginTiledMapResource

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

Metadata and asynchronous tile access for a map resource.

public interface IPluginTiledMapResource : IAsyncDisposable

Inherited Members

IAsyncDisposable.DisposeAsync()

Properties

Id

The resource id the map was opened from.

string Id { get; }

Property Value

string

MaxZoom

The highest zoom level the map has tiles for.

int MaxZoom { get; }

Property Value

int

MinZoom

The lowest zoom level the map has tiles for.

int MinZoom { get; }

Property Value

int

TileSize

The width and height of a full tile, in pixels.

int TileSize { get; }

Property Value

int

WorldBounds

The part of the world the whole map covers.

PluginMapViewport WorldBounds { get; }

Property Value

PluginMapViewport

Methods

LoadTileAsync(PluginMapTileKey, CancellationToken)

Loads and decodes one tile.

ValueTask<PluginMapTile?> LoadTileAsync(PluginMapTileKey key, CancellationToken cancellationToken = default)

Parameters

key PluginMapTileKey

Which tile.

cancellationToken CancellationToken

Cancels the load.

Returns

ValueTask<PluginMapTile>

The tile, or null when the map has no tile there.