Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Dimensions

Namespace used to create and manipulate custom dimensions

Index

Type aliases

MaterialBlockData

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

NoiseConversionParams

NoiseConversionParams: string | Vec2Data[]

Vec2Data

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

Vec3Data

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

Functions

getDimensionById

getDimensionByName

isLimboId

  • isLimboId(id: number): boolean
  • 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: number | string; biome: number; buildVanillaSurfaces: boolean; generateVanillaStructures: boolean; layers: TerrainLayerParams[]; modWorldgenDimension: number | string; type: string }): CustomGenerator
  • 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: number | string; biome: number; buildVanillaSurfaces: boolean; generateVanillaStructures: boolean; layers: TerrainLayerParams[]; modWorldgenDimension: number | string; type: string }

      object containing all the required generator information

    Returns CustomGenerator

overrideGeneratorForVanillaDimension

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

transfer

  • transfer(entity: number, dimensionId: number): void
  • Transferes 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

Generated using TypeDoc