Class CustomDimension

Class representing custom dimension

Hierarchy

CustomDimension

Index

Constructors

constructor

Properties

id

Methods

Constructors

constructor

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

- Defined in core-engine.d.ts:9248
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. 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

Methods

hasSkyLight

hasSkyLight(): boolean

- Defined in core-engine.d.ts:9274
Returns boolean
whether the sky produces light in the current dimension

resetCloudColor

resetCloudColor(): CustomDimension

- Defined in core-engine.d.ts:9322
Resets clouds color to the default value

Returns CustomDimension
reference to itself to be used in sequential calls

resetFogColor

resetFogColor(): CustomDimension

- Defined in core-engine.d.ts:9306
Resets fog color to the default value

Returns CustomDimension
reference to itself to be used in sequential calls

resetFogDistance

resetFogDistance(): CustomDimension

- Defined in core-engine.d.ts:9351
Resets fog displaying distance

Returns CustomDimension

resetSkyColor

resetSkyColor(): CustomDimension

- Defined in core-engine.d.ts:9290
Resets sky color to the default value

Returns CustomDimension
reference to itself to be used in sequential calls

resetSunsetColor

resetSunsetColor(): CustomDimension

- Defined in core-engine.d.ts:9338
Resets sunset sky color to the default value

Returns CustomDimension
reference to itself to be used in sequential calls

setCloudColor

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

- Defined in core-engine.d.ts:9316
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

setFogColor

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

- Defined in core-engine.d.ts:9300
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

- Defined in core-engine.d.ts:9346
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

- Defined in core-engine.d.ts:9261
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

- Defined in core-engine.d.ts:9269
Specifies whether the sky produces light (like in overworld) or not (like in the End or Nether). By default this value is true

Parameters
- hasSkyLight: boolean
  
  if true, the sky produces light in the dimension
Returns CustomDimension
reference to itself to be used in sequential calls

setSkyColor

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

- Defined in core-engine.d.ts:9284
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

setSunsetColor

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

- Defined in core-engine.d.ts:9332
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

Generated using TypeDoc