Dimensions.CustomDimension

Class representing custom dimension.

Index

Constructors

• constructor

Properties

• id

Methods

• hasSkyLight
• resetCloudColor
• resetFogColor
• resetFogDistance
• resetSkyColor
• resetStarBrightness
• resetSunsetColor
• resetTimeOfDay
• setBedExplodesOnSleep
• setCloudColor
• setCloudHeight
• setEvaporatesLiquids
• setFogColor
• setFogDistance
• setGenerator
• setHasSkyLight
• setSkyAtmosphereEnabled
• setSkyColor
• setStarBrightness
• setSunsetColor
• setTimeOfDay
• setTimeOfDayAmplifier
• setWeatherSeasons

Constructors

constructor

• new CustomDimension(name: string, preferredId: number): CustomDimension

• Constructs a new dimension with specified name and preferred ID.

  ---

  Parameters

  • name: string

    dimension name, can be used to get dimension via Dimensions.getDimensionByName call

  • preferredId: number

    preferred dimension ID, can't be smaller than 4; if ID is already occupied by some another dimension, constructor will look for the next empty dimension ID and assign it to the current dimension

  Returns CustomDimension

Properties

id

id: number

Custom dimension ID. Can't be smaller than 4.

Methods

hasSkyLight

• hasSkyLight(): boolean

• Returns boolean

  Whether the sky produces light in the current dimension.

resetCloudColor

• resetCloudColor(): CustomDimension

• Resets clouds color to the default value.

  ---

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

resetFogColor

• resetFogColor(): CustomDimension

• Resets fog color to the default value.

  ---

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

resetFogDistance

• resetFogDistance(): CustomDimension

• since: 2.0.2b20

  Resets fog displaying distance.

  ---

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

resetSkyColor

• resetSkyColor(): CustomDimension

• Resets sky color to the default value.

  ---

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

resetStarBrightness

• resetStarBrightness(): CustomDimension

• since: 3.1.0b126

  Resets star brightness.

  ---

  Returns CustomDimension

resetSunsetColor

• resetSunsetColor(): CustomDimension

• Resets sunset sky color to the default value.

  ---

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

resetTimeOfDay

• resetTimeOfDay(): CustomDimension

• since: 3.1.0b126

  Resets custom time of day interval.

  ---

  Returns CustomDimension

setBedExplodesOnSleep

• setBedExplodesOnSleep(explode: boolean): CustomDimension

• since: 3.1.0b126

  Sets behavior with interacting between player and bed like a nether or end.

  ---

  Parameters

  • explode: boolean

    if true player can't sleep on beds

  Returns CustomDimension

setCloudColor

• setCloudColor(r: number, g: number, b: number): CustomDimension

• Sets clouds color for the dimension in the RGB format. Default color is as in the Overworld.

  ---

  Parameters

  • r: number

    red color component, value from 0 to 1

  • g: number

    green color component, value from 0 to 1

  • b: number

    blue color component, value from 0 to 1

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

setCloudHeight

• setCloudHeight(height: number): CustomDimension

• since: 3.1.0b126

  Sets height of clouds.

  ---

  Parameters

  • height: number

    height by "y" angle

  Returns CustomDimension

setEvaporatesLiquids

• setEvaporatesLiquids(evaporates: boolean): CustomDimension

• since: 3.1.0b126

  Sets, can liquid evaporate or not.

  ---

  Parameters

  • evaporates: boolean

    if true water will evaporate just like nether

  Returns CustomDimension

setFogColor

• setFogColor(r: number, g: number, b: number): CustomDimension

• Sets fog color for the dimension in the RGB format. Default color is as in the Overworld.

  ---

  Parameters

  • r: number

    red color component, value from 0 to 1

  • g: number

    green color component, value from 0 to 1

  • b: number

    blue color component, value from 0 to 1

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

setFogDistance

• setFogDistance(start: number, end: number): CustomDimension

• since: 2.0.2b20

  Sets fog displaying distance.

  ---

  Parameters

  • start: number

    nearest fog distance

  • end: number

    farthest fog distance

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

setGenerator

• setGenerator(generator: CustomGenerator): CustomDimension

• Sets custom landscape generator.

  ---

  Parameters

  • generator: CustomGenerator

    custom landscape generator used for current dimension

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

setHasSkyLight

• setHasSkyLight(hasSkyLight: boolean): CustomDimension

• since: 3.1.0b126 (existed but not working until it)

  Specifies whether the sky produces light (like in overworld) or not (like in the End or Nether).

  ---

  Parameters

  • hasSkyLight: boolean

    if true, the sky produces light in the dimension

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

setSkyAtmosphereEnabled

• setSkyAtmosphereEnabled(enabled: boolean): CustomDimension

• since: 3.1.0b126

  Sets visualization of sky like overworld.

  ---

  Parameters

  • enabled: boolean

  Returns CustomDimension

setSkyColor

• setSkyColor(r: number, g: number, b: number): CustomDimension

• Sets sky color for the dimension in the RGB format. Default color is as in the Overworld.

  ---

  Parameters

  • r: number

    red color component, value from 0 to 1

  • g: number

    green color component, value from 0 to 1

  • b: number

    blue color component, value from 0 to 1

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

setStarBrightness

• setStarBrightness(interval: number): CustomDimension

• since: 3.1.0b126

  Sets star brightness.

  ---

  Parameters

  • interval: number

    number between 0 and 1

  Returns CustomDimension

setSunsetColor

• setSunsetColor(r: number, g: number, b: number): CustomDimension

• Sets sunset sky color for the dimension in the RGB format. Default color is as in the Overworld.

  ---

  Parameters

  • r: number

    red color component, value from 0 to 1

  • g: number

    green color component, value from 0 to 1

  • b: number

    blue color component, value from 0 to 1

  Returns CustomDimension

  Reference to itself to be used in sequential calls.

setTimeOfDay

• setTimeOfDay(interval: number): CustomDimension

• since: 3.1.0b126

  Overrides time of day by interval [0, 1].

  ---

  Parameters

  • interval: number

    number between 0 and 1, e.g. 0.25 represents noon, 0.75 midnight

  Returns CustomDimension

setTimeOfDayAmplifier

• setTimeOfDayAmplifier(amplifier: number): CustomDimension

• since: 3.1.0b126

  Multiplies time for dimension based on world one (e.g., World.getWorldTime() * amplifier).

  ---

  Parameters

  • amplifier: number

    any number

  Returns CustomDimension

setWeatherSeasons

• setWeatherSeasons(seasons: boolean): CustomDimension

• since: 3.1.0b126

  Sets, has world tick of weather seasons or not.

  ---

  Parameters

  • seasons: boolean

    if true weather will work

  Returns CustomDimension