Class WorldConfig

Namespace

Shard.Gameplay.Universe.World

Assembly

Shard.Gameplay.Universe.dll

Configuration loaded for a gameplay world.

public sealed class WorldConfig

Inheritance

object

WorldConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

WorldConfig(Guid, string, long, WorldBounds?, IReadOnlyCollection<string>?, WorldTimeConfig?)

Configuration loaded for a gameplay world.

public WorldConfig(Guid uuid, string displayName, long seed = 0, WorldBounds? bounds = null, IReadOnlyCollection<string>? disabledModules = null, WorldTimeConfig? time = null)

Parameters

uuid Guid

displayName string

seed long

bounds WorldBounds

disabledModules IReadOnlyCollection<string>

time WorldTimeConfig

Properties

Bounds

The world's chunk-space extent; unbounded (Infinite) by default.

public WorldBounds Bounds { get; }

Property Value

WorldBounds

DisabledModules

Gets the canonical module IDs disabled when the world starts.

public IReadOnlyCollection<string> DisabledModules { get; }

Property Value

IReadOnlyCollection<string>

DisplayName

Gets the display name shown for the world.

public string DisplayName { get; }

Property Value

string

Seed

The world-generation seed (deterministic terrain).

public long Seed { get; }

Property Value

long

Time

Gets the immutable settings used when the Time Module composes this world's Store.

public WorldTimeConfig Time { get; }

Property Value

WorldTimeConfig

Uuid

Gets the stable UUID for the world.

public Guid Uuid { get; }

Property Value

Guid

Methods

CreateDefault(string)

Creates a temporary default config until disk-backed world config loading exists.

public static WorldConfig CreateDefault(string name)

Parameters

name string

Returns

WorldConfig