WorldProvider (Forge API)

java.lang.Object
- net.minecraft.world.WorldProvider

Direct Known Subclasses:

WorldProviderEnd, WorldProviderHell, WorldProviderSurface
```
public abstract class WorldProvider
extends java.lang.Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected BiomeProvider`	`biomeProvider`
`protected boolean`	`doesWaterVaporize`
`protected boolean`	`hasSkyLight`
`protected float[]`	`lightBrightnessTable`
`static float[]`	`MOON_PHASE_FACTORS`
`protected boolean`	`nether`
`protected World`	`world`

Constructor Summary

Constructors
Constructor and Description

WorldProvider()

Constructors
Constructor and Description
`WorldProvider()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`float[]`	`calcSunriseSunsetColors(float celestialAngle, float partialTicks)`
`float`	`calculateCelestialAngle(long worldTime, float partialTicks)`
`void`	`calculateInitialWeather()`
`boolean`	`canBlockFreeze(BlockPos pos, boolean byWater)`
`boolean`	`canCoordinateBeSpawn(int x, int z)`
`boolean`	`canDoLightning(Chunk chunk)`
`boolean`	`canDoRainSnowIce(Chunk chunk)`
`boolean`	`canDropChunk(int x, int z)`
`boolean`	`canMineBlock(EntityPlayer player, BlockPos pos)`
`boolean`	`canRespawnHere()`
`boolean`	`canSnowAt(BlockPos pos, boolean checkLight)`
`IChunkGenerator`	`createChunkGenerator()`
`WorldBorder`	`createWorldBorder()`
`boolean`	`doesWaterVaporize()`
`boolean`	`doesXZShowFog(int x, int z)`
`protected void`	`generateLightBrightnessTable()`
`int`	`getActualHeight()`
`int`	`getAverageGroundLevel()`
`Biome`	`getBiomeForCoords(BlockPos pos)`
`BiomeProvider`	`getBiomeProvider()`
`Vec3d`	`getCloudColor(float partialTicks)`
`float`	`getCloudHeight()`
`IRenderHandler`	`getCloudRenderer()`
`float`	`getCurrentMoonPhaseFactor()` Calculates the current moon phase factor.
`int`	`getDimension()`
`abstract DimensionType`	`getDimensionType()`
`Vec3d`	`getFogColor(float p_76562_1_, float p_76562_2_)`
`int`	`getHeight()`
`double`	`getHorizon()`
`float[]`	`getLightBrightnessTable()`
`void`	`getLightmapColors(float partialTicks, float sunBrightness, float skyLight, float blockLight, float[] colors)` Allows for manipulating the coloring of the lightmap texture.
`int`	`getMoonPhase(long worldTime)`
`double`	`getMovementFactor()` The dimensions movement factor.
`BlockPos`	`getRandomizedSpawnPoint()`
`int`	`getRespawnDimension(EntityPlayerMP player)` Determines the dimension the player will be respawned in, typically this brings them back to the overworld.
`java.lang.String`	`getSaveFolder()` Returns the sub-folder of the world folder that this WorldProvider saves to.
`long`	`getSeed()`
`Vec3d`	`getSkyColor(Entity cameraEntity, float partialTicks)`
`IRenderHandler`	`getSkyRenderer()`
`BlockPos`	`getSpawnCoordinate()`
`BlockPos`	`getSpawnPoint()`
`float`	`getStarBrightness(float par1)` Gets the Star Brightness for rendering sky.
`float`	`getSunBrightness(float par1)` Gets the Sun Brightness for rendering sky.
`float`	`getSunBrightnessFactor(float par1)` The current sun brightness factor for this dimension.
`double`	`getVoidFogYFactor()`
`IRenderHandler`	`getWeatherRenderer()`
`long`	`getWorldTime()`
`boolean`	`hasSkyLight()`
`protected void`	`init()`
`ICapabilityProvider`	`initCapabilities()` Called from `World.initCapabilities()`, to gather capabilities for this world.
`boolean`	`isBlockHighHumidity(BlockPos pos)`
`boolean`	`isDaytime()`
`boolean`	`isNether()`
`boolean`	`isSkyColored()`
`boolean`	`isSurfaceWorld()`
`void`	`onPlayerAdded(EntityPlayerMP player)`
`void`	`onPlayerRemoved(EntityPlayerMP player)`
`void`	`onWorldSave()`
`void`	`onWorldUpdateEntities()`
`void`	`resetRainAndThunder()`
`void`	`setAllowedSpawnTypes(boolean allowHostile, boolean allowPeaceful)`
`void`	`setCloudRenderer(IRenderHandler renderer)`
`void`	`setDimension(int dim)` Sets the providers current dimension ID, used in default getSaveFolder() Added to allow default providers to be registered for multiple dimensions.
`void`	`setSkyRenderer(IRenderHandler skyRenderer)`
`void`	`setSpawnPoint(BlockPos pos)`
`void`	`setWeatherRenderer(IRenderHandler renderer)`
`void`	`setWorld(World worldIn)`
`void`	`setWorldTime(long time)`
`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.
`void`	`updateWeather()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MOON_PHASE_FACTORS

public static final float[] MOON_PHASE_FACTORS

world
```
protected World world
```

biomeProvider
```
protected BiomeProvider biomeProvider
```

doesWaterVaporize
```
protected boolean doesWaterVaporize
```

nether
```
protected boolean nether
```

hasSkyLight
```
protected boolean hasSkyLight
```

lightBrightnessTable

protected final float[] lightBrightnessTable

Constructor Detail
- WorldProvider
```
public WorldProvider()
```

Method Detail

setWorld

public final void setWorld(World worldIn)

generateLightBrightnessTable

protected void generateLightBrightnessTable()

init
```
protected void init()
```

createChunkGenerator

public IChunkGenerator createChunkGenerator()

canCoordinateBeSpawn

public boolean canCoordinateBeSpawn(int x,
                                    int z)

calculateCelestialAngle

public float calculateCelestialAngle(long worldTime,
                                     float partialTicks)

getMoonPhase

public int getMoonPhase(long worldTime)

isSurfaceWorld
```
public boolean isSurfaceWorld()
```

calcSunriseSunsetColors

@Nullable
public float[] calcSunriseSunsetColors(float celestialAngle,
                                                  float partialTicks)

getFogColor

public Vec3d getFogColor(float p_76562_1_,
                         float p_76562_2_)

canRespawnHere
```
public boolean canRespawnHere()
```

getCloudHeight
```
public float getCloudHeight()
```

isSkyColored
```
public boolean isSkyColored()
```

getSpawnCoordinate

@Nullable
public BlockPos getSpawnCoordinate()

getAverageGroundLevel
```
public int getAverageGroundLevel()
```

getVoidFogYFactor
```
public double getVoidFogYFactor()
```

doesXZShowFog

public boolean doesXZShowFog(int x,
                             int z)

getBiomeProvider

public BiomeProvider getBiomeProvider()

doesWaterVaporize
```
public boolean doesWaterVaporize()
```

hasSkyLight
```
public boolean hasSkyLight()
```

isNether
```
public boolean isNether()
```

getLightBrightnessTable

public float[] getLightBrightnessTable()

createWorldBorder

public WorldBorder createWorldBorder()

setDimension
```
public void setDimension(int dim)
```
Sets the providers current dimension ID, used in default getSaveFolder() Added to allow default providers to be registered for multiple dimensions. This is to denote the exact dimension ID opposed to the 'type' in WorldType

Parameters:

dim - Dimension ID

getDimension
```
public int getDimension()
```

getSaveFolder
```
public java.lang.String getSaveFolder()
```
Returns the sub-folder of the world folder that this WorldProvider saves to. EXA: DIM1, DIM-1

Returns:

The sub-folder name to save this world's chunks to.

getMovementFactor
```
public double getMovementFactor()
```
The dimensions movement factor. Relative to normal overworld. It is applied to the players position when they transfer dimensions. Exa: Nether movement is 8.0

Returns:

The movement factor

getSkyRenderer

public IRenderHandler getSkyRenderer()

setSkyRenderer

public void setSkyRenderer(IRenderHandler skyRenderer)

getCloudRenderer

public IRenderHandler getCloudRenderer()

setCloudRenderer

public void setCloudRenderer(IRenderHandler renderer)

getWeatherRenderer

public IRenderHandler getWeatherRenderer()

setWeatherRenderer

public void setWeatherRenderer(IRenderHandler renderer)

getLightmapColors
```
public 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:

EntityRenderer.updateLightmap(float)

getRandomizedSpawnPoint

public BlockPos getRandomizedSpawnPoint()

shouldMapSpin
```
public 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
```
public int getRespawnDimension(EntityPlayerMP 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

initCapabilities
```
public 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

getBiomeForCoords

public Biome getBiomeForCoords(BlockPos pos)

isDaytime
```
public boolean isDaytime()
```

getSunBrightnessFactor
```
public float getSunBrightnessFactor(float par1)
```
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

getCurrentMoonPhaseFactor
```
public float getCurrentMoonPhaseFactor()
```
Calculates the current moon phase factor. This factor is effective for slimes. (This method do not affect the moon rendering)

getSkyColor

public Vec3d getSkyColor(Entity cameraEntity,
                         float partialTicks)

getCloudColor

public Vec3d getCloudColor(float partialTicks)

getSunBrightness
```
public float getSunBrightness(float par1)
```
Gets the Sun Brightness for rendering sky.

getStarBrightness
```
public float getStarBrightness(float par1)
```
Gets the Star Brightness for rendering sky.

setAllowedSpawnTypes

public void setAllowedSpawnTypes(boolean allowHostile,
                                 boolean allowPeaceful)

calculateInitialWeather
```
public void calculateInitialWeather()
```

updateWeather
```
public void updateWeather()
```

canBlockFreeze

public boolean canBlockFreeze(BlockPos pos,
                              boolean byWater)

canSnowAt

public boolean canSnowAt(BlockPos pos,
                         boolean checkLight)

setWorldTime
```
public void setWorldTime(long time)
```

getSeed
```
public long getSeed()
```

getWorldTime
```
public long getWorldTime()
```

getSpawnPoint
```
public BlockPos getSpawnPoint()
```

setSpawnPoint

public void setSpawnPoint(BlockPos pos)

canMineBlock

public boolean canMineBlock(EntityPlayer player,
                            BlockPos pos)

isBlockHighHumidity

public boolean isBlockHighHumidity(BlockPos pos)

getHeight
```
public int getHeight()
```

getActualHeight
```
public int getActualHeight()
```

getHorizon
```
public double getHorizon()
```

resetRainAndThunder
```
public void resetRainAndThunder()
```

canDoLightning

public boolean canDoLightning(Chunk chunk)

canDoRainSnowIce

public boolean canDoRainSnowIce(Chunk chunk)

onPlayerAdded

public void onPlayerAdded(EntityPlayerMP player)

onPlayerRemoved

public void onPlayerRemoved(EntityPlayerMP player)

getDimensionType

public abstract DimensionType getDimensionType()

onWorldSave
```
public void onWorldSave()
```

onWorldUpdateEntities
```
public void onWorldUpdateEntities()
```

canDropChunk

public boolean canDropChunk(int x,
                            int z)

Class WorldProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MOON_PHASE_FACTORS

world

biomeProvider

doesWaterVaporize

nether

hasSkyLight

lightBrightnessTable

Constructor Detail

WorldProvider

Method Detail

setWorld

generateLightBrightnessTable

init

createChunkGenerator

canCoordinateBeSpawn

calculateCelestialAngle

getMoonPhase

isSurfaceWorld

calcSunriseSunsetColors

getFogColor

canRespawnHere

getCloudHeight

isSkyColored

getSpawnCoordinate

getAverageGroundLevel

getVoidFogYFactor

doesXZShowFog

getBiomeProvider

doesWaterVaporize

hasSkyLight

isNether

getLightBrightnessTable

createWorldBorder

setDimension

getDimension

getSaveFolder

getMovementFactor

getSkyRenderer

setSkyRenderer

getCloudRenderer

setCloudRenderer

getWeatherRenderer

setWeatherRenderer

getLightmapColors

getRandomizedSpawnPoint

shouldMapSpin

getRespawnDimension

initCapabilities

getBiomeForCoords

isDaytime

getSunBrightnessFactor

getCurrentMoonPhaseFactor

getSkyColor

getCloudColor

getSunBrightness

getStarBrightness

setAllowedSpawnTypes

calculateInitialWeather

updateWeather

canBlockFreeze

canSnowAt

setWorldTime

getSeed

getWorldTime

getSpawnPoint

setSpawnPoint

canMineBlock

isBlockHighHumidity

getHeight

getActualHeight

getHorizon

resetRainAndThunder

canDoLightning

canDoRainSnowIce