Dimensions | Core Engine v2.1 API

Namespace used to create and manipulate custom dimensions

Type Aliases

MaterialBlockData

MaterialBlockData: [number, number?, number?] | { data?: number; id: number; width?: number } | number

NoiseConversionParams

NoiseConversionParams: string | Vec2Data[]

NoiseOctaveStringType

Vec2Data

Vec2Data: [number, number] | { x: number; y: number } | number

Vec3Data

Vec3Data: [number, number, number] | { x: number; y: number; z: number } | number

Functions

getAllRegisteredCustomBiomes

getAllRegisteredCustomBiomes(): {}

- Defined in core-engine.d.ts:9601
Returns {}
JS object instance, containing all registered custom biomes
- [key: string]: CustomBiome

getDimensionById

getDimensionById(id: number): CustomDimension

- Defined in core-engine.d.ts:9580
Parameters
- id: number
  
  dimension id
Returns CustomDimension
custom dimension by its numeric id

getDimensionByName

getDimensionByName(name: string): CustomDimension

- Defined in core-engine.d.ts:9573
Parameters
- name: string
  
  dimension name
Returns CustomDimension
dimension by its string name specified in CustomDimension.constructor

isLimboId

isLimboId(id: number): boolean

- Defined in core-engine.d.ts:9589
Parameters
- id: number
  
  dimension id
Returns boolean
true, if dimension is a limbo dimension. Limbo dimension is created by Horizon automatically if you try to teleport the player to non-existing dimension

newGenerator

newGenerator(description: { base?: string | number; biome?: number; buildVanillaSurfaces?: boolean; generateVanillaStructures?: boolean; layers?: TerrainLayerParams[]; modWorldgenDimension?: string | number; type?: string }): CustomGenerator

- Defined in core-engine.d.ts:9609
Function used to simplify the creation of terrain generator by passing a json-like structure as a single generator parameter. For detailed explanations see {@See Custom Dimensions} page

Parameters
- description: { base?: string | number; biome?: number; buildVanillaSurfaces?: boolean; generateVanillaStructures?: boolean; layers?: TerrainLayerParams[]; modWorldgenDimension?: string | number; type?: string }
  
  object containing all the required generator information
  - Optional base?: string | number
    
    Specifies base generator, see CustomGenerator.constructor for details
  - Optional biome?: number
    
    Sets base biome for the current terrain, applicable only to "mono"
  - Optional buildVanillaSurfaces?: boolean
    
    Specifies whether to use vanilla biome surface cover blocks (grass, sand, podzol, etc.). See CustomGenerator.setBuildVanillaSurfaces for details
  - Optional generateVanillaStructures?: boolean
    
    Specifies whether to generate minecraft vanilla structures. See CustomGenerator.setGenerateVanillaStructures for details
  - Optional layers?: TerrainLayerParams[]
    
    An array of terrain layers descriptions, each one representing its own terrain layer. See MonoBiomeTerrainGenerator.addTerrainLayer for detailed explanation
  - Optional modWorldgenDimension?: string | number
    
    Can be either string for an existing dimensions ("overworld", "nether", "end") or -1 to disable mods generation. See CustomGenerator.setModGenerationBaseDimension for details
  - Optional type?: string
    
    Specifies what generator type to use. Default and the only currently available option is "mono", that is equivalent to creating a MonoBiomeTerrainGenerator
Returns CustomGenerator

overrideGeneratorForVanillaDimension

overrideGeneratorForVanillaDimension(id: number, generator: CustomGenerator): void

- Defined in core-engine.d.ts:9565
Overrides default generator of vanilla dimension

Parameters
- id: number
  
  vanilla dimension id, one of the Native.Dimension values
- generator: CustomGenerator
  
  custom landscape generator used for vanilla dimension
Returns void

transfer

transfer(entity: number, dimensionId: number): void

- Defined in core-engine.d.ts:9596
Transfers specified entity to the dimension with specified id

Parameters
- entity: number
  
  numeric id of the
- dimensionId: number
  
  numeric id of the dimension to transfer the entity to
Returns void

Index

Classes

Interfaces

Type Aliases

Functions

Type Aliases

MaterialBlockData

NoiseConversionParams

NoiseOctaveStringType

Vec2Data

Vec3Data

Functions

getAllRegisteredCustomBiomes

Returns {}

[key: string]: CustomBiome

getDimensionById

Parameters

id: number

Returns CustomDimension

getDimensionByName

Parameters

name: string

Returns CustomDimension

isLimboId

Parameters

id: number

Returns boolean

newGenerator

Parameters

description: { base?: string | number; biome?: number; buildVanillaSurfaces?: boolean; generateVanillaStructures?: boolean; layers?: TerrainLayerParams[]; modWorldgenDimension?: string | number; type?: string }

Optional base?: string | number

Optional biome?: number

Optional buildVanillaSurfaces?: boolean

Optional generateVanillaStructures?: boolean

Optional layers?: TerrainLayerParams[]

Optional modWorldgenDimension?: string | number

Optional type?: string

Returns CustomGenerator

overrideGeneratorForVanillaDimension

Parameters

id: number

generator: CustomGenerator

Returns void

transfer

Parameters

entity: number

dimensionId: number

Returns void