Class NoOpPluginMapRegistry

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The map registry of a host that shows no maps.

public sealed class NoOpPluginMapRegistry : IPluginMapRegistry

Inheritance

object

NoOpPluginMapRegistry

Implements

IPluginMapRegistry

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Accepts every call and shows nothing; what is set is not kept. No client shows maps yet, so every host answers with this.

Properties

Instance

The one shared instance.

public static NoOpPluginMapRegistry Instance { get; }

Property Value

NoOpPluginMapRegistry

Methods

AddMap(string, PluginMapViewport)

Adds a map. Dispose the returned surface to remove it.

public IPluginMapSurface AddMap(string mapId, PluginMapViewport initialViewport)

Parameters

mapId string

The map's name, unique within the plugin that adds it.

initialViewport PluginMapViewport

The part of the world the map shows to begin with.

Returns

IPluginMapSurface

The surface the plugin sets the map's image, markers and route through.