Table of Contents

Class Dimensions

Namespace
Vintagestory.API.Config
Assembly
VintagestoryAPI.dll
public class Dimensions
Inheritance
Dimensions
Inherited Members
Extension Methods

Fields

AltWorld

The dimension dedicated for storage of blocks in an timeswitched alt-world, such as the Devastation

public const int AltWorld = 2

Field Value

int

BlocksPreviewSubDimension_Client

The subdimension Id, within the MiniDimensions system, for the World Edit Blocks Preview dimension. Accessed client-side only

public static int BlocksPreviewSubDimension_Client

Field Value

int

MiniDimensions

The dimension dedicated for storage of 'mini-dimensions', i.e. many separate 16k cubes of block space used for WorldEdit preview, vehicles etc

public const int MiniDimensions = 1

Field Value

int

NormalWorld

Used to make explicit all places in the code where the default dimension, dimension 0, is assumed, in case we need to search and replace them later

public const int NormalWorld = 0

Field Value

int

subDimensionIndexZMultiplier 

public const int subDimensionIndexZMultiplier = 4096

Field Value

int

subDimensionSize

This represents the XZ size of mini-dimensions (individual BlockAccessorMovables) within an overall dimension - we can pack 16 million of these into one dimension, which should be enough!

public const int subDimensionSize = 16384

Field Value

int

Methods

ShouldNotTick(EntityPos, ICoreAPI)

Indicates whether a given BlockPos should not be ticked due to being in an unusual dimension, such as the preview minidimension

public static bool ShouldNotTick(EntityPos pos, ICoreAPI api)

Parameters

pos EntityPos
api ICoreAPI

Returns

bool

ShouldNotTick(BlockPos, ICoreAPI)

Indicates whether a given BlockPos should not be ticked due to being in an unusual dimension, such as the preview minidimension

public static bool ShouldNotTick(BlockPos pos, ICoreAPI api)

Parameters

pos BlockPos
api ICoreAPI

Returns

bool

SubDimensionIdForPos(int, int) 

public static int SubDimensionIdForPos(int posX, int posZ)

Parameters

posX int
posZ int

Returns

int