Class RegionMapRegistry

Namespace

WorldgenLib

Assembly

WorldgenLib.VintageStory.dll

Registry for persistent, bounded custom maps attached to an Vintagestory.API.Common.IMapRegion. A slot is registered during mod startup and its data is serialized into the region's permanent moddata when the host finishes a region.

public static class RegionMapRegistry

Inheritance

object

RegionMapRegistry

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

All

public static IReadOnlyList<RegionMapSlot> All { get; }

Property Value

IReadOnlyList<RegionMapSlot>

IsFrozen

public static bool IsFrozen { get; }

Property Value

bool

Methods

GetSlot(string)

public static RegionMapSlot? GetSlot(string mapCode)

Parameters

mapCode string

Returns

RegionMapSlot

Register(string, string, int, int, int)

Register a bounded map slot. The declared storage budget is charged against a 4 MiB per-region aggregate before registration succeeds, preventing an accidental unbounded save format.

public static RegionMapSlot Register(string modId, string mapCode, int innerSize, int padding, int formatVersion)

Parameters

modId string

mapCode string

innerSize int

padding int

formatVersion int

Returns

RegionMapSlot