Namespace Dimensions

getAllRegisteredCustomBiomes

• getAllRegisteredCustomBiomes(): {
      [key: string]: CustomBiome;
  }

• Returns {
      [key: string]: CustomBiome;
  }

  JS object instance, containing all registered custom biomes.

  • [key: string]: CustomBiome

  Since

  2.2.1b93

getDimensionById

• getDimensionById(id): CustomDimension

• Parameters

  • id: number

    dimension ID

  Returns CustomDimension

  Custom dimension by it's numeric ID.

getDimensionByName

• getDimensionByName(name): CustomDimension

• Parameters

  • name: string

    dimension name

  Returns CustomDimension

  Dimension by it's string name specified in CustomDimension constructor.

isLimboId

• isLimboId(id): 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): CustomGenerator

• Function used to simplify the creation of terrain generator by passing a json-like structure as a single generator parameter.

  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

    • Optionalbase?: string | number

      Specifies base generator, see CustomGenerator constructor for details.

    • Optionalbiome?: number

      Sets base biome for the current terrain, applicable only to "mono".

    • OptionalbuildVanillaSurfaces?: boolean

      Specifies whether to use vanilla biome surface cover blocks (grass, sand, podzol, etc.).

      See setBuildVanillaSurfaces for details.

    • OptionalgenerateVanillaStructures?: boolean

      Specifies whether to generate minecraft vanilla structures.

      See setGenerateVanillaStructures for details.

    • Optionallayers?: TerrainLayerParams[]

      An array of terrain layers descriptions, each one representing it's own terrain layer.

      See MonoBiomeTerrainGenerator.addTerrainLayer for details.

    • OptionalmodWorldgenDimension?: string | number

      Can be either string for an existing dimensions ("overworld", "nether", "end") or -1 to disable mods generation.

      See setModGenerationBaseDimension for details.

    • Optionaltype?: 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, generator): void

• Overrides default generator of vanilla dimension.

  Parameters

  • id: number

    vanilla dimension ID, one of the EDimension values
  • generator: CustomGenerator

    custom landscape generator used for vanilla dimension

  Returns void

transfer

• transfer(entity, dimensionId): void

• 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

MaterialBlockData

NoiseConversionParams

NoiseOctaveStringType

Vec2Data

Vec3Data