Struct PluginStorageScope

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

Identifies a plugin storage namespace. Scope names are logical names and are sanitized by the host; plugins must not construct filesystem paths.

public readonly record struct PluginStorageScope : IEquatable<PluginStorageScope>

Implements

IEquatable<PluginStorageScope>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginStorageScope(string)

Identifies a plugin storage namespace. Scope names are logical names and are sanitized by the host; plugins must not construct filesystem paths.

public PluginStorageScope(string Name)

Parameters

Name string

Properties

Global

The plugin-wide namespace.

public static PluginStorageScope Global { get; }

Property Value

PluginStorageScope

Name

public string Name { get; init; }

Property Value

string

Methods

Character(string)

Creates a character-specific namespace.

public static PluginStorageScope Character(string characterId)

Parameters

characterId string

Returns

PluginStorageScope

World(string)

Creates a world-specific namespace.

public static PluginStorageScope World(string worldId)

Parameters

worldId string

Returns

PluginStorageScope