IForgeDimension (forge 1.14.4-28.2.23 API)

All Known Implementing Classes:

Dimension, EndDimension, NetherDimension, OverworldDimension
```
public interface IForgeDimension
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IForgeDimension.SleepResult

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IForgeDimension.SleepResult`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`calculateInitialWeather()`
`default boolean`	`canDoLightning(Chunk chunk)`
`default boolean`	`canDoRainSnowIce(Chunk chunk)`
`default boolean`	`canMineBlock(PlayerEntity player, BlockPos pos)`
`default IForgeDimension.SleepResult`	`canSleepAt(PlayerEntity player, BlockPos pos)` Determines if the player can sleep in this world (or if the bed should explode for example).
`default int`	`getActualHeight()`
`default Biome`	`getBiome(BlockPos pos)`
`default Vec3d`	`getCloudColor(float partialTicks)`
`IRenderHandler`	`getCloudRenderer()`
`default float`	`getCurrentMoonPhaseFactor(long time)` Calculates the current moon phase factor.
`default Dimension`	`getDimension()`
`default int`	`getHeight()`
`default double`	`getHorizon()`
`default void`	`getLightmapColors(float partialTicks, float sunBrightness, float skyLight, float blockLight, float[] colors)` Allows for manipulating the coloring of the lightmap texture.
`default double`	`getMovementFactor()` The dimension's movement factor.
`default MusicTicker.MusicType`	`getMusicType()` Called on the client to get the music type to play when in this world type.
`default DimensionType`	`getRespawnDimension(ServerPlayerEntity player)` Determines the dimension the player will be respawned in, typically this brings them back to the overworld.
`default int`	`getSeaLevel()`
`default long`	`getSeed()`
`default Vec3d`	`getSkyColor(BlockPos cameraPos, float partialTicks)`
`IRenderHandler`	`getSkyRenderer()`
`default BlockPos`	`getSpawnPoint()`
`default float`	`getStarBrightness(float partialTicks)` Gets the Star Brightness for rendering sky.
`default float`	`getSunBrightness(float partialTicks)` The current sun brightness factor for this dimension.
`IRenderHandler`	`getWeatherRenderer()`
`World`	`getWorld()`
`default long`	`getWorldTime()`
`default ICapabilityProvider`	`initCapabilities()` Called from `World#initCapabilities()`, to gather capabilities for this world.
`default boolean`	`isDaytime()`
`default boolean`	`isHighHumidity(BlockPos pos)`
`void`	`resetRainAndThunder()`
`default void`	`setAllowedSpawnTypes(boolean allowHostile, boolean allowPeaceful)`
`void`	`setCloudRenderer(IRenderHandler renderer)`
`void`	`setSkyRenderer(IRenderHandler skyRenderer)`
`default void`	`setSpawnPoint(BlockPos pos)`
`void`	`setWeatherRenderer(IRenderHandler renderer)`
`default void`	`setWorldTime(long time)`
`default boolean`	`shouldMapSpin(java.lang.String entity, double x, double z, double rotation)` Determine if the cursor on the map should 'spin' when rendered, like it does for the player in the nether.
`default void`	`updateWeather(java.lang.Runnable defaultLogic)`

- Method Detail
  - getDimension
```
default Dimension getDimension()
```
  - getWorld
```
World getWorld()
```
  - initCapabilities
```
default ICapabilityProvider initCapabilities()
```
    Called from World#initCapabilities(), to gather capabilities for this world. It's safe to access world here since this is called after world is registered. On server, called directly after mapStorage and world data such as Scoreboard and VillageCollection are initialized. On client, called when world is constructed, just before world load event is called. Note that this method is always called before the world load event.
    
    Returns:
    
    initial holder for capabilities on the world
  - getMovementFactor
```
default double getMovementFactor()
```
    The dimension's movement factor. Whenever a player or entity changes dimension from world A to world B, their coordinates are multiplied by worldA.provider.getMovementFactor() / worldB.provider.getMovementFactor() Example: Overworld factor is 1, nether factor is 8. Traveling from overworld to nether multiplies coordinates by 1/8.
    
    Returns:
    
    The movement factor
  - getSkyRenderer
```
@Nullable
IRenderHandler getSkyRenderer()
```
  - setSkyRenderer
```
void setSkyRenderer(IRenderHandler skyRenderer)
```
  - getCloudRenderer
```
@Nullable
IRenderHandler getCloudRenderer()
```
  - setCloudRenderer
```
void setCloudRenderer(IRenderHandler renderer)
```
  - getWeatherRenderer
```
@Nullable
IRenderHandler getWeatherRenderer()
```
  - setWeatherRenderer
```
void setWeatherRenderer(IRenderHandler renderer)
```
  - getLightmapColors
```
default void getLightmapColors(float partialTicks,
                               float sunBrightness,
                               float skyLight,
                               float blockLight,
                               float[] colors)
```
    Allows for manipulating the coloring of the lightmap texture. Will be called for each 16*16 combination of sky/block light values.
    
    Parameters:
    
    partialTicks - Progress between ticks.
    
    sunBrightness - Current sun brightness.
    
    skyLight - Sky light brightness factor.
    
    blockLight - Block light brightness factor.
    
    colors - The color values that will be used: [r, g, b].
    
    See Also:
    
    net.minecraft.client.renderer.GameRenderer#updateLightmap(float)
  - resetRainAndThunder
```
void resetRainAndThunder()
```
  - canDoLightning
```
default boolean canDoLightning(Chunk chunk)
```
  - canDoRainSnowIce
```
default boolean canDoRainSnowIce(Chunk chunk)
```
  - getMusicType
```
@Nullable
default MusicTicker.MusicType getMusicType()
```
    Called on the client to get the music type to play when in this world type. At the time of calling, the client player and world are guaranteed to be non-null
    
    Returns:
    
    null to use vanilla logic, otherwise a MusicType to play in this world
  - canSleepAt
```
default IForgeDimension.SleepResult canSleepAt(PlayerEntity player,
                                               BlockPos pos)
```
    Determines if the player can sleep in this world (or if the bed should explode for example).
    
    Parameters:
    
    player - The player that is attempting to sleep
    
    pos - The location where the player tries to sleep at (the position of the clicked on bed for example)
    
    Returns:
    
    the result of a player trying to sleep at the given location
  - getBiome
```
default Biome getBiome(BlockPos pos)
```
  - isDaytime
```
default boolean isDaytime()
```
  - getSunBrightness
```
default float getSunBrightness(float partialTicks)
```
    The current sun brightness factor for this dimension. 0.0f means no light at all, and 1.0f means maximum sunlight. This will be used for the "calculateSkylightSubtracted" which is for Sky light value calculation.
    
    Returns:
    
    The current brightness factor
  - getSkyColor
```
default Vec3d getSkyColor(BlockPos cameraPos,
                          float partialTicks)
```
  - getCloudColor
```
default Vec3d getCloudColor(float partialTicks)
```
  - getCurrentMoonPhaseFactor
```
default float getCurrentMoonPhaseFactor(long time)
```
    Calculates the current moon phase factor. This factor is effective for slimes. (This method do not affect the moon rendering)
  - getStarBrightness
```
default float getStarBrightness(float partialTicks)
```
    Gets the Star Brightness for rendering sky.
  - setAllowedSpawnTypes
```
default void setAllowedSpawnTypes(boolean allowHostile,
                                  boolean allowPeaceful)
```
  - calculateInitialWeather
```
default void calculateInitialWeather()
```
  - updateWeather
```
default void updateWeather(java.lang.Runnable defaultLogic)
```
  - getSeed
```
default long getSeed()
```
  - getWorldTime
```
default long getWorldTime()
```
  - setWorldTime
```
default void setWorldTime(long time)
```
  - getSpawnPoint
```
default BlockPos getSpawnPoint()
```
  - setSpawnPoint
```
default void setSpawnPoint(BlockPos pos)
```
  - canMineBlock
```
default boolean canMineBlock(PlayerEntity player,
                             BlockPos pos)
```
  - isHighHumidity
```
default boolean isHighHumidity(BlockPos pos)
```
  - getHeight
```
default int getHeight()
```
  - getActualHeight
```
default int getActualHeight()
```
  - getHorizon
```
default double getHorizon()
```
  - getSeaLevel
```
default int getSeaLevel()
```
  - shouldMapSpin
```
default boolean shouldMapSpin(java.lang.String entity,
                              double x,
                              double z,
                              double rotation)
```
    Determine if the cursor on the map should 'spin' when rendered, like it does for the player in the nether.
    
    Parameters:
    
    entity - The entity holding the map, playername, or frame-ENTITYID
    
    x - X Position
    
    z - Z Position
    
    rotation - the regular rotation of the marker
    
    Returns:
    
    True to 'spin' the cursor
  - getRespawnDimension
```
default DimensionType getRespawnDimension(ServerPlayerEntity player)
```
    Determines the dimension the player will be respawned in, typically this brings them back to the overworld.
    
    Parameters:
    
    player - The player that is respawning
    
    Returns:
    
    The dimension to respawn the player in

Interface IForgeDimension

Nested Class Summary

Method Summary

Method Detail

getDimension

getWorld

initCapabilities

getMovementFactor

getSkyRenderer

setSkyRenderer

getCloudRenderer

setCloudRenderer

getWeatherRenderer

setWeatherRenderer

getLightmapColors

resetRainAndThunder

canDoLightning

canDoRainSnowIce

getMusicType

canSleepAt

getBiome

isDaytime

getSunBrightness

getSkyColor

getCloudColor

getCurrentMoonPhaseFactor

getStarBrightness

setAllowedSpawnTypes

calculateInitialWeather

updateWeather

getSeed

getWorldTime

setWorldTime

getSpawnPoint

setSpawnPoint

canMineBlock

isHighHumidity

getHeight

getActualHeight

getHorizon

getSeaLevel

shouldMapSpin

getRespawnDimension