de.ellpeck.rockbottom.api.world

Interface IChunk

All Superinterfaces:

IChunkOrWorld

public interface IChunk
extends IChunkOrWorld

The world is split up into parts with the dimensions Constants.CHUNK_SIZE, Constants.CHUNK_SIZE, these parts are what are known as chunks.
Every chunk is independent of one another and so they are being loaded and unloaded when the player leaves their range to save on memory and to allow for the world to be infinte.
Use this interface to interact with chunks

Method Summary

Modifier and Type	Method and Description
byte	getArtificialLightInner(int x, int y) Gets the artificial light at the specified coordinates inside of the chunk rather than the tile coordinates in the world
Biome	getBiomeInner(int x, int y)
byte	getCombinedLightInner(int x, int y) Gets the combined light at the specified coordinates inside of the chunk rather than the tile coordinates in the world
int	getGridX() Gets the chunk's grid x coordinate This is different from getX() in that it returns the grid coordinate of the chunk, meaning a chunk at grid coordinates 1, 1 would start at tile coordinates Constants.CHUNK_SIZE, Constants.CHUNK_SIZE
int	getGridY() Gets the chunk's grid y coordinate This is different from getX() in that it returns the grid coordinate of the chunk, meaning a chunk at grid coordinates 1, 1 would start at tile coordinates Constants.CHUNK_SIZE, Constants.CHUNK_SIZE
java.util.Map<AbstractEntityPlayer,MutableInt>	getLeftPlayerTimers()
java.util.Set<TileLayer>	getLoadedLayers()
int	getLowestAirUpwardsInner(TileLayer layer, int x, int y)
java.util.List<AbstractEntityPlayer>	getPlayersInRange()
java.util.List<AbstractEntityPlayer>	getPlayersLeftRange()
int	getScheduledUpdateAmount()
byte	getSkylightInner(int x, int y) Gets the skylight at the specified coordinates inside of the chunk rather than the tile coordinates in the world
TileState	getStateInner(int x, int y)
TileState	getStateInner(TileLayer layer, int x, int y)
IWorld	getWorld() Gets the IWorld that this chunk is in
int	getX() Gets the chunk's tile x coordinate This is different from getGridX() in that it returns the coordinate of the chunk based on its tile coordinates, meaning a chunk that contains tile coordinates 1, 1 would be at grid coordinates 0, 0
int	getY() Gets the chunk's tile y coordinate This is different from getGridX() in that it returns the coordinate of the chunk based on its tile coordinates, meaning a chunk that contains tile coordinates 1, 1 would be at grid coordinates 0, 0
boolean	needsSave()
void	save(DataSet set) Saves the chunk to the given DataSet
void	setArtificialLightInner(int x, int y, byte light) Sets the artificial light at the specified coordinates inside of the chunk rather than the tile coordinates in the world
void	setBiomeInner(int x, int y, Biome biome)
void	setGenerating(boolean generating) Puts the chunk into generating mode which means that it will not call Tile.onChangeAround(IWorld, int, int, TileLayer, int, int, TileLayer) or be marked dirty if anything changes
void	setSkylightInner(int x, int y, byte light) Sets the skylight at the specified coordinates inside of the chunk rather than the tile coordinates in the world
void	setStateInner(int x, int y, TileState tile)
void	setStateInner(TileLayer layer, int x, int y, TileState tile) Sets a tile at the specified coordinates inside of the chunk rather than the tile coordinates in the world
boolean	shouldUnload()
void	update(IGameInstance game) Updates the chunk This is 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, getSkyLight, getState, getState, getTileEntity, getTileEntity, getTileEntity, getTileEntity, isClient, isServer, removeEntity, removeTileEntity, scheduleUpdate, setArtificialLight, setBiome, setDirty, setSkyLight, setState, setState

Method Detail

getPlayersInRange

java.util.List<AbstractEntityPlayer> getPlayersInRange()

Returns:

The players that are in loading range of the chunk

getPlayersLeftRange

java.util.List<AbstractEntityPlayer> getPlayersLeftRange()

Returns:

The players that were in range of the chunk but have left it

See Also:

getLeftPlayerTimers()

getLeftPlayerTimers

java.util.Map<AbstractEntityPlayer,MutableInt> getLeftPlayerTimers()

Returns:

The timers of the players that have left the range of the chunk

See Also:

getPlayersLeftRange()

getGridX

int getGridX()

Gets the chunk's grid x coordinate
This is different from getX() in that it returns the grid coordinate of the chunk, meaning a chunk at grid coordinates 1, 1 would start at tile coordinates Constants.CHUNK_SIZE, Constants.CHUNK_SIZE

Returns:

The x coordinate

getGridY

int getGridY()

Gets the chunk's grid y coordinate
This is different from getX() in that it returns the grid coordinate of the chunk, meaning a chunk at grid coordinates 1, 1 would start at tile coordinates Constants.CHUNK_SIZE, Constants.CHUNK_SIZE

Returns:

The y coordinate

getWorld

IWorld getWorld()

Gets the IWorld that this chunk is in

Returns:

The world

getX

int getX()

Gets the chunk's tile x coordinate
This is different from getGridX() in that it returns the coordinate of the chunk based on its tile coordinates, meaning a chunk that contains tile coordinates 1, 1 would be at grid coordinates 0, 0

Returns:

The x coordinate

getY

int getY()

Gets the chunk's tile y coordinate
This is different from getGridX() in that it returns the coordinate of the chunk based on its tile coordinates, meaning a chunk that contains tile coordinates 1, 1 would be at grid coordinates 0, 0

Returns:

The y coordinate

getLowestAirUpwardsInner

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

getStateInner

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

getStateInner

TileState getStateInner(int x,
                        int y)

setStateInner

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

setStateInner

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

Sets a tile at the specified coordinates inside of the chunk rather than the tile coordinates in the world

Parameters:

layer - The layer

x - The x coordinate

y - The y coordinate

getSkylightInner

byte getSkylightInner(int x,
                      int y)

Gets the skylight at the specified coordinates inside of the chunk rather than the tile coordinates in the world

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The skylight

setSkylightInner

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

Sets the skylight at the specified coordinates inside of the chunk rather than the tile coordinates in the world

Parameters:

x - The x coordinate

y - The y coordinate

light - The skylight

getArtificialLightInner

byte getArtificialLightInner(int x,
                             int y)

Gets the artificial light at the specified coordinates inside of the chunk rather than the tile coordinates in the world

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The artificial light

setArtificialLightInner

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

Sets the artificial light at the specified coordinates inside of the chunk rather than the tile coordinates in the world

Parameters:

x - The x coordinate

y - The y coordinate

light - The artificial light

setGenerating

void setGenerating(boolean generating)

Puts the chunk into generating mode which means that it will not call Tile.onChangeAround(IWorld, int, int, TileLayer, int, int, TileLayer) or be marked dirty if anything changes

Parameters:

generating - If it is generating

needsSave

boolean needsSave()

Returns:

If the chunk needs to be saved to disk

shouldUnload

boolean shouldUnload()

Returns:

If the chunk is ready to unload

save

void save(DataSet set)

Saves the chunk to the given DataSet

Parameters:

set - The set

update

void update(IGameInstance game)

Updates the chunk
This is not supposed to be used by mods

Parameters:

game - The chunk

getCombinedLightInner

byte getCombinedLightInner(int x,
                           int y)

Gets the combined light at the specified coordinates inside of the chunk rather than the tile coordinates in the world

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

The combined light

getScheduledUpdateAmount

int getScheduledUpdateAmount()

Returns:

The amount of currently scheduled updates

See Also:

IChunkOrWorld.scheduleUpdate(int, int, TileLayer, int)

getBiomeInner

Biome getBiomeInner(int x,
                    int y)

setBiomeInner

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

getLoadedLayers

java.util.Set<TileLayer> getLoadedLayers()