de.ellpeck.rockbottom.api.world

Interface IWorld

All Superinterfaces:

IChunkOrWorld

public interface IWorld
extends IChunkOrWorld

A world is the area that entities and tiles exist in
Use this interface to interact with the world

Method Summary

Modifier and Type	Method and Description
void	causeLightUpdate(int x, int y) Causes a light update at the given position Will recursively calculate light in the surrounding area
AbstractEntityPlayer	createPlayer(java.util.UUID id, IPlayerDesign design, io.netty.channel.Channel channel) Creates a player from the given UUID and adds it to the world Not supposed to be used by mods
void	destroyTile(int x, int y, TileLayer layer, Entity destroyer, boolean shouldDrop) Helper method to remove a tile, spawn its particles and spawn its drops
Biome	getBiomeForId(int id)
NameToIndexInfo	getBiomeRegInfo()
IChunk	getChunk(double x, double y) Gets an IChunk from the specified tile coordinates This is different from getChunkFromGridCoords(int, int) in that it getst a chunk based on the tile coordinates of the chunk, meaning a chunk that contains tile coordinates 1, 1 would be at grid coordinates 0, 0
IChunk	getChunkFromGridCoords(int gridX, int gridY) Gets an IChunk from the specified grid coordinates This is different from getChunk(double, double) in that it gets a chunk based on the grid coordinates of the chunk, meaning a chunk at grid coordinates 1, 1 would start at tile coordinates Constants.CHUNK_SIZE, Constants.CHUNK_SIZE
java.util.List<BoundBox>	getCollisions(BoundBox area) Gets a ArrayList of BoundBox of tiles that are contained by the specified BoundBox
int	getIdForBiome(Biome biome)
int	getIdForTile(Tile tile)
AbstractEntityPlayer	getPlayer(java.lang.String name)
AbstractEntityPlayer	getPlayer(java.util.UUID id) Gets a player with the specified UUID from the world
java.util.List<IWorldGenerator>	getSortedGenerators()
int	getSpawnX()
Tile	getTileForId(int id)
NameToIndexInfo	getTileRegInfo()
WorldInfo	getWorldInfo()
boolean	isChunkLoaded(int x, int y)
boolean	isPosLoaded(int x, int y)
void	notifyNeighborsOfChange(int x, int y, TileLayer layer) Notifies neighboring tiles that a change or an update has occured, calling their Tile.onChangeAround(IWorld, int, int, TileLayer, int, int, TileLayer) methods
void	save()
void	savePlayer(AbstractEntityPlayer player) Saves the specified player to disk Not supposed to be used by mods
void	unloadChunk(IChunk chunk) Forces a chunk to unload Not supposed to be used by mods

Methods inherited from interface de.ellpeck.rockbottom.api.world.IChunkOrWorld

addEntity, addTileEntity, getAllEntities, getAllTileEntities, getArtificialLight, getBiome, getCombinedLight, getEntities, getEntities, getEntities, getEntities, getEntity, getLowestAirUpwards, getMeta, getMeta, getSkyLight, getTile, getTile, getTileEntity, getTileEntity, removeEntity, removeTileEntity, scheduleUpdate, setArtificialLight, setBiome, setDirty, setMeta, setMeta, setSkyLight, setTile, setTile, setTile, setTile

Method Detail

getChunkFromGridCoords

IChunk getChunkFromGridCoords(int gridX,
                              int gridY)

Gets an IChunk from the specified grid coordinates
This is different from getChunk(double, double) in that it gets a chunk based on the grid coordinates of the chunk, meaning a chunk at grid coordinates 1, 1 would start at tile coordinates Constants.CHUNK_SIZE, Constants.CHUNK_SIZE

Parameters:

gridX - The grid x coordinate

gridY - The grid y coordinate

Returns:

The chunk at the specified coordinates

getChunk

IChunk getChunk(double x,
                double y)

Gets an IChunk from the specified tile coordinates
This is different from getChunkFromGridCoords(int, int) in that it getst a chunk based on the tile coordinates of the chunk, meaning a chunk that contains tile coordinates 1, 1 would be at grid coordinates 0, 0

Parameters:

x - The tile x coordinate

y - The tile y coordinate

Returns:

The chunk at the specified coordinates

isPosLoaded

boolean isPosLoaded(int x,
                    int y)

Parameters:

x - The tile x coordinate

y - The tile y coordinate

Returns:

true if the chunk that contains the specified tile coordinates is loaded, false otherwise

isChunkLoaded

boolean isChunkLoaded(int x,
                      int y)

Parameters:

x - The grid x coordinate

y - The grid y coordinate

Returns:

true if the chunk at the specified grid coordinates is loaded, false otherwise

getCollisions

java.util.List<BoundBox> getCollisions(BoundBox area)

Gets a ArrayList of BoundBox of tiles that are contained by the specified BoundBox

Parameters:

area - The bound box to check for tiles in

Returns:

The collisions of tiles inside the specified area

getIdForTile

int getIdForTile(Tile tile)

Parameters:

tile - The tile

Returns:

The id that the specified tile is saved as in the world's save files

getTileForId

Tile getTileForId(int id)

Parameters:

id - The id

Returns:

The tile that is saved in the world's save files using the specified id

getTileRegInfo

NameToIndexInfo getTileRegInfo()

Returns:

Information about which ids tiles are saved with in the world file

See Also:

getIdForTile(Tile), getTileForId(int)

getIdForBiome

int getIdForBiome(Biome biome)

getBiomeForId

Biome getBiomeForId(int id)

getBiomeRegInfo

NameToIndexInfo getBiomeRegInfo()

getWorldInfo

WorldInfo getWorldInfo()

Returns:

Information like the seed and time of the world

notifyNeighborsOfChange

void notifyNeighborsOfChange(int x,
                             int y,
                             TileLayer layer)

Notifies neighboring tiles that a change or an update has occured, calling their Tile.onChangeAround(IWorld, int, int, TileLayer, int, int, TileLayer) methods

Parameters:

x - The x coordinate

y - The y coordinate

layer - The layer

createPlayer

AbstractEntityPlayer createPlayer(java.util.UUID id,
                                  IPlayerDesign design,
                                  io.netty.channel.Channel channel)

Creates a player from the given UUID and adds it to the world
Not supposed to be used by mods

Parameters:

id - The id of the player

channel - A channel if it is a connected player

Returns:

The created player

getPlayer

AbstractEntityPlayer getPlayer(java.util.UUID id)

Gets a player with the specified UUID from the world

Parameters:

id - The id of the player

Returns:

The player, or null if there is no player with the id

getPlayer

AbstractEntityPlayer getPlayer(java.lang.String name)

destroyTile

void destroyTile(int x,
                 int y,
                 TileLayer layer,
                 Entity destroyer,
                 boolean shouldDrop)

Helper method to remove a tile, spawn its particles and spawn its drops

Parameters:

x - The x coordinate

y - The y coordinate

layer - The layer

destroyer - The entity destroying it, or null if there is none

shouldDrop - If its items should drop

getSpawnX

int getSpawnX()

Returns:

The spawn coordiante of the world

causeLightUpdate

void causeLightUpdate(int x,
                      int y)

Causes a light update at the given position
Will recursively calculate light in the surrounding area

Parameters:

x - The x coordinate

y - The y coordinate

unloadChunk

void unloadChunk(IChunk chunk)

Forces a chunk to unload
Not supposed to be used by mods

Parameters:

chunk - The chunk

savePlayer

void savePlayer(AbstractEntityPlayer player)

Saves the specified player to disk
Not supposed to be used by mods

Parameters:

player - The player

getSortedGenerators

java.util.List<IWorldGenerator> getSortedGenerators()

save

void save()