de.ellpeck.rockbottom.api.world

Interface IChunkOrWorld

All Known Subinterfaces:

IChunk, IWorld

public interface IChunkOrWorld

This is implemented by both IWorld and IChunk

Method Summary

Modifier and Type	Method and Description
void	addEntity(Entity entity) Adds the specified Entity to the world
void	addTileEntity(TileEntity tile) Adds the specified TileEntity to the world
java.util.List<Entity>	getAllEntities()
java.util.List<TileEntity>	getAllTileEntities()
byte	getArtificialLight(int x, int y) Gets the artifical light at the given coordinates This can be things like torches and furnaces that emit light
Biome	getBiome(int x, int y)
byte	getCombinedLight(int x, int y) Gets a combination of getSkyLight(int, int), getArtificialLight(int, int) and the time of day of the world for the given coordinate to determine the light at which things are displayed
java.util.List<Entity>	getEntities(BoundBox area) Gets a list of all Entity in the specified BoundBox
<T extends Entity> java.util.List<T>	getEntities(BoundBox area, java.lang.Class<T> type) Gets a list of all Entity in the specified BoundBox that are instances of or extend the specified Class
<T extends Entity> java.util.List<T>	getEntities(BoundBox area, java.lang.Class<T> type, java.util.function.Predicate<T> test) Gets a list of all Entity in the specified BoundBox that are instances of or extend the specified Class and pass the specified Predicate
java.util.List<Entity>	getEntities(BoundBox area, java.util.function.Predicate<Entity> test) Gets a list of all Entity in the specified BoundBox that pass the specified Predicate
Entity	getEntity(java.util.UUID id) Gets an Entity with the specified UUID
int	getLowestAirUpwards(TileLayer layer, int x, int y) Gets the lowest position from the specified y coordiante upwards at the specified x coordiante that contains air Is used to determine the x coordiante of the world's spawn point
byte	getSkyLight(int x, int y) Gets the sky light at the given coordinates This is light caused by there being no blocks obstructing the background
TileState	getState(int x, int y)
TileState	getState(TileLayer layer, int x, int y)
TileEntity	getTileEntity(int x, int y)
<T extends TileEntity> T	getTileEntity(int x, int y, java.lang.Class<T> tileClass) Gets a TileEntity of a certain type at the specified coordinates
boolean	isClient()
void	removeEntity(Entity entity) Removes the specified Entity from the world
void	removeTileEntity(int x, int y) Removes the TileEntity at the specified coordinates from the world
void	scheduleUpdate(int x, int y, TileLayer layer, int time) Schedules an update in the world that will cause Tile.onScheduledUpdate(IWorld, int, int, TileLayer) to be called for the tile at the specified coordinates after the specified time has run out
void	setArtificialLight(int x, int y, byte light) Sets the artifical light at the given coordinates to the given amount This can be things like torches and furnaces that emit light This is not supposed to be used by mods
void	setBiome(int x, int y, Biome biome)
void	setDirty(int x, int y) Tells the world or chunk that it needs to be saved
void	setSkyLight(int x, int y, byte light) Sets the sky light at the given coordinates to the given amount This is light caused by there being no blocks obstructing the background This is not supposed to be used by mods
void	setState(int x, int y, TileState tile)
void	setState(TileLayer layer, int x, int y, TileState tile)

Method Detail

getState

TileState getState(int x,
                   int y)

getState

TileState getState(TileLayer layer,
                   int x,
                   int y)

setState

void setState(int x,
              int y,
              TileState tile)

setState

void setState(TileLayer layer,
              int x,
              int y,
              TileState tile)

addEntity

void addEntity(Entity entity)

Adds the specified Entity to the world

Parameters:

entity - The entity

addTileEntity

void addTileEntity(TileEntity tile)

Adds the specified TileEntity to the world

Parameters:

tile - The tileentity

removeEntity

void removeEntity(Entity entity)

Removes the specified Entity from the world

Parameters:

entity - The entity

removeTileEntity

void removeTileEntity(int x,
                      int y)

Removes the TileEntity at the specified coordinates from the world

Parameters:

x - The x coordinate

y - The y coordinate

getTileEntity

TileEntity getTileEntity(int x,
                         int y)

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The TileEntity at the specified coordinates

getTileEntity

<T extends TileEntity> T getTileEntity(int x,
                                       int y,
                                       java.lang.Class<T> tileClass)

Gets a TileEntity of a certain type at the specified coordinates

Type Parameters:

T - The type

Parameters:

x - The x coordinate

y - The y coordinate

tileClass - The tileentity class

Returns:

The tileentity of the type, or null if there is none or it is not the right type

getAllEntities

java.util.List<Entity> getAllEntities()

Returns:

A list of all Entity in the world

getAllTileEntities

java.util.List<TileEntity> getAllTileEntities()

Returns:

A list of all TileEntity in the world

getEntity

Entity getEntity(java.util.UUID id)

Gets an Entity with the specified UUID

Parameters:

id - The id

Returns:

The entity

getEntities

java.util.List<Entity> getEntities(BoundBox area)

Gets a list of all Entity in the specified BoundBox

Parameters:

area - The bounding box

Returns:

The list

getEntities

java.util.List<Entity> getEntities(BoundBox area,
                                   java.util.function.Predicate<Entity> test)

Gets a list of all Entity in the specified BoundBox that pass the specified Predicate

Parameters:

area - The bounding box

test - The test to pass

Returns:

The list

getEntities

<T extends Entity> java.util.List<T> getEntities(BoundBox area,
                                                 java.lang.Class<T> type)

Gets a list of all Entity in the specified BoundBox that are instances of or extend the specified Class

Parameters:

area - The bounding box

type - The type class

Returns:

The list

getEntities

<T extends Entity> java.util.List<T> getEntities(BoundBox area,
                                                 java.lang.Class<T> type,
                                                 java.util.function.Predicate<T> test)

Gets a list of all Entity in the specified BoundBox that are instances of or extend the specified Class and pass the specified Predicate

Parameters:

area - The bounding box

type - The type class

test - The test to pass

Returns:

The list

getCombinedLight

byte getCombinedLight(int x,
                      int y)

Gets a combination of getSkyLight(int, int), getArtificialLight(int, int) and the time of day of the world for the given coordinate to determine the light at which things are displayed

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The light

getSkyLight

byte getSkyLight(int x,
                 int y)

Gets the sky light at the given coordinates
This is light caused by there being no blocks obstructing the background

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The light

getArtificialLight

byte getArtificialLight(int x,
                        int y)

Gets the artifical light at the given coordinates
This can be things like torches and furnaces that emit light

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The light

setSkyLight

void setSkyLight(int x,
                 int y,
                 byte light)

Sets the sky light at the given coordinates to the given amount
This is light caused by there being no blocks obstructing the background
This is not supposed to be used by mods

Parameters:

x - The x coordinate

y - The y coordinate

light - The light

setArtificialLight

void setArtificialLight(int x,
                        int y,
                        byte light)

Sets the artifical light at the given coordinates to the given amount
This can be things like torches and furnaces that emit light
This is not supposed to be used by mods

Parameters:

x - The x coordinate

y - The y coordinate

light - The light

scheduleUpdate

void scheduleUpdate(int x,
                    int y,
                    TileLayer layer,
                    int time)

Schedules an update in the world that will cause Tile.onScheduledUpdate(IWorld, int, int, TileLayer) to be called for the tile at the specified coordinates after the specified time has run out

Parameters:

x - The x coordinate

y - The y coordinate

layer - The layer

time - The time in ticks

setDirty

void setDirty(int x,
              int y)

Tells the world or chunk that it needs to be saved

Parameters:

x - The x coordinate

y - The y coordinate

getLowestAirUpwards

int getLowestAirUpwards(TileLayer layer,
                        int x,
                        int y)

Gets the lowest position from the specified y coordiante upwards at the specified x coordiante that contains air
Is used to determine the x coordiante of the world's spawn point

Parameters:

layer - The layer

x - The x coordinate

y - The y coordinate

Returns:

The lowest y coordinate upwards

getBiome

Biome getBiome(int x,
               int y)

setBiome

void setBiome(int x,
              int y,
              Biome biome)

isClient

boolean isClient()