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
`int`	`dimensionId` The id for the dimension (ex. -1: Nether, 0: Overworld, 1: The End)
`java.lang.String`	`field_82913_c`
`boolean`	`hasNoSky` A boolean that tells if a world does not have a sky.
`boolean`	`isHellWorld` States whether the Hell world provider is used(true) or if the normal world provider is used(false)
`float[]`	`lightBrightnessTable` Light to brightness conversion table
`static float[]`	`moonPhaseFactors`
`WorldType`	`terrainType`
`WorldChunkManager`	`worldChunkMgr` World chunk manager being used to generate chunks
`World`	`worldObj` world object being used

Constructor Summary

Constructors
Constructor and Description

WorldProvider()

Constructors
Constructor and Description
`WorldProvider()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`float[]`	`calcSunriseSunsetColors(float p_76560_1_, float p_76560_2_)` Returns array with sunrise/sunset colors
`float`	`calculateCelestialAngle(long p_76563_1_, float p_76563_3_)` Calculates the angle of sun and moon in the sky relative to a specified time (usually worldTime)
`void`	`calculateInitialWeather()`
`boolean`	`canBlockFreeze(int x, int y, int z, boolean byWater)`
`boolean`	`canCoordinateBeSpawn(int p_76566_1_, int p_76566_2_)` Will check if the x, z position specified is alright to be set as the map spawn point
`boolean`	`canDoLightning(Chunk chunk)`
`boolean`	`canDoRainSnowIce(Chunk chunk)`
`boolean`	`canMineBlock(EntityPlayer player, int x, int y, int z)`
`boolean`	`canRespawnHere()` True if the player can respawn in this dimension (true = overworld, false = nether).
`boolean`	`canSnowAt(int x, int y, int z, boolean checkLight)`
`IChunkProvider`	`createChunkGenerator()` Returns a new chunk provider which generates chunks for this world
`boolean`	`doesXZShowFog(int p_76568_1_, int p_76568_2_)` Returns true if the given X,Z coordinate should show environmental fog.
`Vec3`	`drawClouds(float partialTicks)`
`protected void`	`generateLightBrightnessTable()` Creates the light to brightness table
`int`	`getActualHeight()`
`int`	`getAverageGroundLevel()`
`BiomeGenBase`	`getBiomeGenForCoords(int x, int z)`
`float`	`getCloudHeight()` the y level at which clouds are rendered.
`IRenderHandler`	`getCloudRenderer()`
`float`	`getCurrentMoonPhaseFactor()` Calculates the current moon phase factor.
`java.lang.String`	`getDepartMessage()` A Message to display to the user when they transfer out of this dismension.
`abstract java.lang.String`	`getDimensionName()` Returns the dimension's name, e.g.
`ChunkCoordinates`	`getEntrancePortalLocation()` Gets the hard-coded portal location to use when entering this dimension.
`Vec3`	`getFogColor(float p_76562_1_, float p_76562_2_)` Return Vec3D with biome specific fog color
`int`	`getHeight()`
`double`	`getHorizon()`
`int`	`getMoonPhase(long p_76559_1_)`
`double`	`getMovementFactor()` The dimensions movement factor.
`static WorldProvider`	`getProviderForDimension(int p_76570_0_)`
`ChunkCoordinates`	`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()`
`Vec3`	`getSkyColor(Entity cameraEntity, float partialTicks)`
`IRenderHandler`	`getSkyRenderer()`
`ChunkCoordinates`	`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. 0.0f means no light at all, and 1.0f means maximum sunlight.
`double`	`getVoidFogYFactor()` Returns a double value representing the Y value relative to the top of the map at which void fog is at its maximum.
`IRenderHandler`	`getWeatherRenderer()`
`java.lang.String`	`getWelcomeMessage()` A message to display to the user when they transfer to this dimension.
`boolean`	`getWorldHasVoidParticles()` returns true if this dimension is supposed to display void particles and pull in the far plane based on the user's Y offset.
`long`	`getWorldTime()`
`boolean`	`isBlockHighHumidity(int x, int y, int z)`
`boolean`	`isDaytime()`
`boolean`	`isSkyColored()`
`boolean`	`isSurfaceWorld()` Returns 'true' if in the "main surface world", but 'false' if in the Nether or End dimensions.
`void`	`registerWorld(World p_76558_1_)` associate an existing world with a World provider, and setup its lightbrightness table
`protected void`	`registerWorldChunkManager()` creates a new world chunk manager for WorldProvider
`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(int x, int y, int z)`
`void`	`setWeatherRenderer(IRenderHandler renderer)`
`void`	`setWorldTime(long time)`
`boolean`	`shouldMapSpin(java.lang.String entity, double x, double y, double z)` Determine if the cusor 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
  - moonPhaseFactors
```
public static final float[] moonPhaseFactors
```
  - worldObj
```
public World worldObj
```
    world object being used
  - terrainType
```
public WorldType terrainType
```
  - field_82913_c
```
public java.lang.String field_82913_c
```
  - worldChunkMgr
```
public WorldChunkManager worldChunkMgr
```
    World chunk manager being used to generate chunks
  - isHellWorld
```
public boolean isHellWorld
```
    States whether the Hell world provider is used(true) or if the normal world provider is used(false)
  - hasNoSky
```
public boolean hasNoSky
```
    A boolean that tells if a world does not have a sky. Used in calculating weather and skylight
  - lightBrightnessTable
```
public float[] lightBrightnessTable
```
    Light to brightness conversion table
  - dimensionId
```
public int dimensionId
```
    The id for the dimension (ex. -1: Nether, 0: Overworld, 1: The End)
- Constructor Detail
  - WorldProvider
```
public WorldProvider()
```
- Method Detail
  - registerWorld
```
public final void registerWorld(World p_76558_1_)
```
    associate an existing world with a World provider, and setup its lightbrightness table
  - generateLightBrightnessTable
```
protected void generateLightBrightnessTable()
```
    Creates the light to brightness table
  - registerWorldChunkManager
```
protected void registerWorldChunkManager()
```
    creates a new world chunk manager for WorldProvider
  - createChunkGenerator
```
public IChunkProvider createChunkGenerator()
```
    Returns a new chunk provider which generates chunks for this world
  - canCoordinateBeSpawn
```
public boolean canCoordinateBeSpawn(int p_76566_1_,
                                    int p_76566_2_)
```
    Will check if the x, z position specified is alright to be set as the map spawn point
  - calculateCelestialAngle
```
public float calculateCelestialAngle(long p_76563_1_,
                                     float p_76563_3_)
```
    Calculates the angle of sun and moon in the sky relative to a specified time (usually worldTime)
  - getMoonPhase
```
public int getMoonPhase(long p_76559_1_)
```
  - isSurfaceWorld
```
public boolean isSurfaceWorld()
```
    Returns 'true' if in the "main surface world", but 'false' if in the Nether or End dimensions.
  - calcSunriseSunsetColors
```
public float[] calcSunriseSunsetColors(float p_76560_1_,
                                       float p_76560_2_)
```
    Returns array with sunrise/sunset colors
  - getFogColor
```
public Vec3 getFogColor(float p_76562_1_,
                        float p_76562_2_)
```
    Return Vec3D with biome specific fog color
  - canRespawnHere
```
public boolean canRespawnHere()
```
    True if the player can respawn in this dimension (true = overworld, false = nether).
  - getProviderForDimension
```
public static WorldProvider getProviderForDimension(int p_76570_0_)
```
  - getCloudHeight
```
public float getCloudHeight()
```
    the y level at which clouds are rendered.
  - isSkyColored
```
public boolean isSkyColored()
```
  - getEntrancePortalLocation
```
public ChunkCoordinates getEntrancePortalLocation()
```
    Gets the hard-coded portal location to use when entering this dimension.
  - getAverageGroundLevel
```
public int getAverageGroundLevel()
```
  - getWorldHasVoidParticles
```
public boolean getWorldHasVoidParticles()
```
    returns true if this dimension is supposed to display void particles and pull in the far plane based on the user's Y offset.
  - getVoidFogYFactor
```
public double getVoidFogYFactor()
```
    Returns a double value representing the Y value relative to the top of the map at which void fog is at its maximum. The default factor of 0.03125 relative to 256, for example, means the void fog will be at its maximum at (256*0.03125), or 8.
  - doesXZShowFog
```
public boolean doesXZShowFog(int p_76568_1_,
                             int p_76568_2_)
```
    Returns true if the given X,Z coordinate should show environmental fog.
  - getDimensionName
```
public abstract java.lang.String getDimensionName()
```
    Returns the dimension's name, e.g. "The End", "Nether", or "Overworld".
  - 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.
    
    Parameters:
    
    dim - Dimension ID
  - 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.
  - getWelcomeMessage
```
public java.lang.String getWelcomeMessage()
```
    A message to display to the user when they transfer to this dimension.
    
    Returns:
    
    The message to be displayed
  - getDepartMessage
```
public java.lang.String getDepartMessage()
```
    A Message to display to the user when they transfer out of this dismension.
    
    Returns:
    
    The message to be displayed
  - 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)
```
  - getRandomizedSpawnPoint
```
public ChunkCoordinates getRandomizedSpawnPoint()
```
  - shouldMapSpin
```
public boolean shouldMapSpin(java.lang.String entity,
                             double x,
                             double y,
                             double z)
```
    Determine if the cusor 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
    
    y - Y Position
    
    z - Z Postion
    
    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
  - getBiomeGenForCoords
```
public BiomeGenBase getBiomeGenForCoords(int x,
                                         int z)
```
  - 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 Vec3 getSkyColor(Entity cameraEntity,
                        float partialTicks)
```
  - drawClouds
```
public Vec3 drawClouds(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(int x,
                              int y,
                              int z,
                              boolean byWater)
```
  - canSnowAt
```
public boolean canSnowAt(int x,
                         int y,
                         int z,
                         boolean checkLight)
```
  - setWorldTime
```
public void setWorldTime(long time)
```
  - getSeed
```
public long getSeed()
```
  - getWorldTime
```
public long getWorldTime()
```
  - getSpawnPoint
```
public ChunkCoordinates getSpawnPoint()
```
  - setSpawnPoint
```
public void setSpawnPoint(int x,
                          int y,
                          int z)
```
  - canMineBlock
```
public boolean canMineBlock(EntityPlayer player,
                            int x,
                            int y,
                            int z)
```
  - isBlockHighHumidity
```
public boolean isBlockHighHumidity(int x,
                                   int y,
                                   int z)
```
  - 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)
```

Class WorldProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

moonPhaseFactors

worldObj

terrainType

field_82913_c

worldChunkMgr

isHellWorld

hasNoSky

lightBrightnessTable

dimensionId

Constructor Detail

WorldProvider

Method Detail

registerWorld

generateLightBrightnessTable

registerWorldChunkManager

createChunkGenerator

canCoordinateBeSpawn

calculateCelestialAngle

getMoonPhase

isSurfaceWorld

calcSunriseSunsetColors

getFogColor

canRespawnHere

getProviderForDimension

getCloudHeight

isSkyColored

getEntrancePortalLocation

getAverageGroundLevel

getWorldHasVoidParticles

getVoidFogYFactor

doesXZShowFog

getDimensionName

setDimension

getSaveFolder

getWelcomeMessage

getDepartMessage

getMovementFactor

getSkyRenderer

setSkyRenderer

getCloudRenderer

setCloudRenderer

getWeatherRenderer

setWeatherRenderer

getRandomizedSpawnPoint

shouldMapSpin

getRespawnDimension

getBiomeGenForCoords

isDaytime

getSunBrightnessFactor

getCurrentMoonPhaseFactor

getSkyColor

drawClouds

getSunBrightness

getStarBrightness

setAllowedSpawnTypes

calculateInitialWeather

updateWeather

canBlockFreeze

canSnowAt

setWorldTime

getSeed

getWorldTime

getSpawnPoint

setSpawnPoint

canMineBlock

isBlockHighHumidity

getHeight

getActualHeight

getHorizon

resetRainAndThunder

canDoLightning

canDoRainSnowIce