Biome

A proxy for a Minecraft biome

warning

This page is a WIP. It contains all the information in Figura's documentation but we're working on adding more helpful descriptions.

Instances are obtained through the WorldAPI

This proxy also contains a saved position for the Biome

For this page assume:

local biome = world.getBiome(player:getPos())

---

Weather

getDownfall()

Gets this biome's humidity

getDownfall()

Returns:

Type	Description
Number	-

Example:

biome:getDownfall()

---

getPrecipitation()

Gets the rain type of this biome

The type can be "NONE", "RAIN" or "SNOW"

getPrecipitation()

Returns:

Type	Description
String	-

Example:

biome:getPrecipitation()

---

getTemperature()

Gets the temperature of this biome

getTemperature()

Returns:

Type	Description
Number	-

Example:

biome:getTemperature()

---

isCold()

Checks if this biome is cold

isCold()

Returns:

Type	Description
Boolean	-

Example:

biome:isCold()

---

isHot()

Checks if this biome is hot

isHot()

Returns:

Type	Description
Boolean	-

Example:

biome:isHot()

---

Biome Colors

getFogColor()

Gets this biome's fog color as an RGB vector

getFogColor()

Returns:

Type	Description
Vector3	-

Example:

biome:getFogColor()

---

getFoliageColor()

Gets this biome's foliage color as an RGB vector

getFoliageColor()

Returns:

Type	Description
Vector3	-

Example:

biome:getFoliageColor()

---

getGrassColor()

Gets this biome's grass color as an RGB vector

getGrassColor()

Returns:

Type	Description
Vector3	-

Example:

biome:getGrassColor()

---

getSkyColor()

Gets this biome's sky color as an RGB vector

getSkyColor()

Returns:

Type	Description
Vector3	-

Example:

biome:getSkyColor()

---

getWaterColor()

Gets this biome's water color as an RGB vector

getWaterColor()

Returns:

Type	Description
Vector3	-

Example:

biome:getWaterColor()

---

getWaterFogColor()

Gets this biome's water fog color as an RGB vector

getWaterFogColor()

Returns:

Type	Description
Vector3	-

Example:

biome:getWaterFogColor()

---

Biome Data

setPos()

Aliases: pos()

Sets the saved position for this Biome's proxy

The saved position is used in Biome functions that require a position

Overload 1

setPos(pos)

Parameters:

Name	Type	Description	Default
pos	Vector3	-	-

Returns:

Type	Description
Biome	Returns self for chaining

Overload 2

setPos(x, y, z)

Parameters:

Name	Type	Description	Default
x	Number	-	-
y	Number	-	-
z	Number	-	-

Returns:

Type	Description
Biome	Returns self for chaining

Example:

biome:setPos(player:getPos())

---

getPos()

Returns the saved position for this Biome's proxy

The saved position is used in Biome functions that require a position

getPos()

Returns:

Type	Description
Vector3	-

Example:

biome:getPos()

---

getTags()

Gets the worldgen related tags from this Biome

getTags()

Returns:

Type	Description
Table	-

Example:

biome:getTags()

---

id

The id of this biome

Example:

biome.id

---