de.ellpeck.rockbottom.api.tile

Class Tile

java.lang.Object

de.ellpeck.rockbottom.api.tile.Tile

Direct Known Subclasses:

BasicTile

public class Tile
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static BoundingBox	BOTTOM_LEFT
static BoundingBox	BOTTOM_RIGHT
static BoundingBox[]	CHISEL_BOUNDS
static BoundingBox	DEFAULT_BOUNDS
protected java.util.Map<ToolProperty,java.lang.Integer>	effectiveToolProps
protected boolean	forceDrop
protected float	hardness
protected boolean	isChiselable
protected ResourceName	name
static BoundingBox	TOP_LEFT
static BoundingBox	TOP_RIGHT

Constructor Summary

Constructors

Constructor and Description
Tile(ResourceName name)

Method Summary

Modifier and Type	Method and Description
Tile	addEffectiveTool(ToolProperty property, int level)
Tile	addProps(TileProp... props)
boolean	canBreak(IWorld world, int x, int y, TileLayer layer, AbstractPlayerEntity player, boolean isRightTool)
boolean	canClimb(IWorld world, int x, int y, TileLayer layer, TileState state, BoundingBox entityBox, BoundingBox entityBoxMotion, java.util.List<BoundingBox> tileBoxes, Entity entity)
boolean	canGrassSpreadTo(IWorld world, int x, int y, TileLayer layer)
boolean	canKeepFarmablePlants(IWorld world, int x, int y, TileLayer layer)
boolean	canKeepPlants(IWorld world, int x, int y, TileLayer layer)
boolean	canLiquidSpread(IWorld world, int x, int y, LiquidTile liquid, Direction dir)
boolean	canPlace(IWorld world, int x, int y, TileLayer layer, AbstractPlayerEntity player)
boolean	canPlaceInLayer(TileLayer layer)
boolean	canProvideTileEntity()
boolean	canReplace(IWorld world, int x, int y, TileLayer layer)
boolean	canStay(IWorld world, int x, int y, TileLayer layer, int changedX, int changedY, TileLayer changedLayer)
boolean	canSwim(IWorld world, int x, int y, TileLayer layer, Entity entity)
boolean	chisel(IWorld world, int x, int y, TileState state, double mouseX, double mouseY) Attempts to chisel a corner of the tile based on the cursor position.
protected TileItem	createItemTile()
void	describeItem(IAssetManager manager, ItemInstance instance, java.util.List<java.lang.String> desc, boolean isAdvanced)
void	doBreak(IWorld world, int x, int y, TileLayer layer, AbstractPlayerEntity breaker, boolean isRightTool, boolean allowDrop)
boolean	doesSustainLeaves(IWorld world, int x, int y, TileLayer layer)
void	doPlace(IWorld world, int x, int y, TileLayer layer, ItemInstance instance, AbstractPlayerEntity placer)
boolean	factorsIntoHeightMap(IWorld world, int x, int y, TileLayer layer)
BoundingBox	getActualBoundBox(IWorld world, TileState state, int x, int y, TileLayer layer)
BoundingBox	getBoundBox(IWorld world, int x, int y, TileLayer layer) Deprecated.
BoundingBox	getBoundBox(IWorld world, TileState state, int x, int y, TileLayer layer)
java.util.List<BoundingBox>	getBoundBoxes(IWorld world, int x, int y, TileLayer layer, MovableWorldObject object, BoundingBox objectBox, BoundingBox objectBoxMotion) Deprecated.
java.util.List<BoundingBox>	getBoundBoxes(IWorld world, TileState state, int x, int y, TileLayer layer, MovableWorldObject object, BoundingBox objectBox, BoundingBox objectBoxMotion)
ResourceName	getBreakSound(IWorld world, int x, int y, TileLayer layer, Entity destroyer)
protected java.util.List<BoundingBox>	getChiselBoundBoxes(IWorld world, int x, int y)
TileState	getDefState()
java.util.List<ItemInstance>	getDrops(IWorld world, int x, int y, TileLayer layer, Entity destroyer)
float	getHardness(IWorld world, int x, int y, TileLayer layer)
int	getInteractionPriority(IWorld world, int x, int y, TileLayer layer, double mouseX, double mouseY, AbstractPlayerEntity player)
Item	getItem()
int	getLight(IWorld world, int x, int y, TileLayer layer)
double	getMaxInteractionDistance(IWorld world, int x, int y, TileLayer layer, double mouseX, double mouseY, AbstractPlayerEntity player)
ResourceName	getName()
TileState	getPlacementState(IWorld world, int x, int y, TileLayer layer, ItemInstance instance, AbstractPlayerEntity placer)
ResourceName	getPlaceSound(IWorld world, int x, int y, TileLayer layer, Entity placer, TileState state)
java.util.List<BoundingBox>	getPlatformBounds(IWorld world, int x, int y, TileLayer layer, TileState state, MovableWorldObject object, BoundingBox objectBox, BoundingBox objectBoxMotion)
java.util.List<TileProp>	getProps()
ITileRenderer	getRenderer()
float	getTranslucentModifier(IWorld world, int x, int y, TileLayer layer, boolean skylight)
protected boolean	hasItem()
boolean	hasProp(TileProp prop)
boolean	hasSolidSurface(IWorld world, int x, int y, TileLayer layer)
boolean	hasState(ResourceName name, java.util.Map<java.lang.String,java.lang.Comparable> props)
boolean	isAir()
boolean	isChiselable()
boolean	isChiseled(IWorld world, int x, int y, TileLayer layer, TileState state)
boolean	isFullTile()
boolean	isLiquid()
boolean	isPlatform()
boolean	isToolEffective(IWorld world, int x, int y, TileLayer layer, ToolProperty property, int level)
boolean	makesGrassSnowy(IWorld world, int x, int y, TileLayer layer)
boolean	obscuresBackground(IWorld world, int x, int y, TileLayer layer)
void	onAdded(IWorld world, int x, int y, TileLayer layer)
void	onChangeAround(IWorld world, int x, int y, TileLayer layer, int changedX, int changedY, TileLayer changedLayer)
void	onCollideWithEntity(IWorld world, int x, int y, TileLayer layer, TileState state, BoundingBox entityBox, BoundingBox entityBoxMotion, java.util.List<BoundingBox> tileBoxes, Entity entity)
void	onDestroyed(IWorld world, int x, int y, Entity destroyer, TileLayer layer, boolean shouldDrop)
boolean	onInteractWith(IWorld world, int x, int y, TileLayer layer, double mouseX, double mouseY, AbstractPlayerEntity player)
boolean	onInteractWithBreakKey(IWorld world, int x, int y, TileLayer layer, double mouseX, double mouseY, AbstractPlayerEntity player)
void	onIntersectWithEntity(IWorld world, int x, int y, TileLayer layer, TileState state, BoundingBox entityBox, BoundingBox entityBoxMotion, java.util.List<BoundingBox> tileBoxes, Entity entity)
void	onRemoved(IWorld world, int x, int y, TileLayer layer)
void	onScheduledUpdate(IWorld world, int x, int y, TileLayer layer, int scheduledMeta)
TileEntity	provideTileEntity(IWorld world, int x, int y, TileLayer layer)
Tile	register()
Tile	setChiselable() Call this to make your tile chiselable.
Tile	setForceDrop()
Tile	setHardness(float hardness)
Tile	setMaxAmount(int amount)
java.lang.String	toString()
void	updateRandomly(IWorld world, int x, int y, TileLayer layer)
void	updateRandomlyInPlayerView(IWorld world, int x, int y, TileLayer layer, TileState state, IParticleManager manager)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_BOUNDS

public static final BoundingBox DEFAULT_BOUNDS

TOP_LEFT

public static final BoundingBox TOP_LEFT

TOP_RIGHT

public static final BoundingBox TOP_RIGHT

BOTTOM_LEFT

public static final BoundingBox BOTTOM_LEFT

BOTTOM_RIGHT

public static final BoundingBox BOTTOM_RIGHT

CHISEL_BOUNDS

public static final BoundingBox[] CHISEL_BOUNDS

name

protected final ResourceName name

effectiveToolProps

protected java.util.Map<ToolProperty,java.lang.Integer> effectiveToolProps

forceDrop

protected boolean forceDrop

hardness

protected float hardness

isChiselable

protected boolean isChiselable

Constructor Detail

Tile

public Tile(ResourceName name)

Method Detail

getRenderer

public ITileRenderer getRenderer()

getActualBoundBox

public BoundingBox getActualBoundBox(IWorld world,
                                     TileState state,
                                     int x,
                                     int y,
                                     TileLayer layer)

getBoundBox

public BoundingBox getBoundBox(IWorld world,
                               TileState state,
                               int x,
                               int y,
                               TileLayer layer)

getBoundBox

@Deprecated
public BoundingBox getBoundBox(IWorld world,
                                           int x,
                                           int y,
                                           TileLayer layer)

Deprecated.

getBoundBoxes

public java.util.List<BoundingBox> getBoundBoxes(IWorld world,
                                                 TileState state,
                                                 int x,
                                                 int y,
                                                 TileLayer layer,
                                                 MovableWorldObject object,
                                                 BoundingBox objectBox,
                                                 BoundingBox objectBoxMotion)

getBoundBoxes

@Deprecated
public java.util.List<BoundingBox> getBoundBoxes(IWorld world,
                                                             int x,
                                                             int y,
                                                             TileLayer layer,
                                                             MovableWorldObject object,
                                                             BoundingBox objectBox,
                                                             BoundingBox objectBoxMotion)

Deprecated.

isPlatform

public boolean isPlatform()

getPlatformBounds

public java.util.List<BoundingBox> getPlatformBounds(IWorld world,
                                                     int x,
                                                     int y,
                                                     TileLayer layer,
                                                     TileState state,
                                                     MovableWorldObject object,
                                                     BoundingBox objectBox,
                                                     BoundingBox objectBoxMotion)

getChiselBoundBoxes

protected java.util.List<BoundingBox> getChiselBoundBoxes(IWorld world,
                                                          int x,
                                                          int y)

canBreak

public boolean canBreak(IWorld world,
                        int x,
                        int y,
                        TileLayer layer,
                        AbstractPlayerEntity player,
                        boolean isRightTool)

canPlace

public boolean canPlace(IWorld world,
                        int x,
                        int y,
                        TileLayer layer,
                        AbstractPlayerEntity player)

canPlaceInLayer

public boolean canPlaceInLayer(TileLayer layer)

register

public Tile register()

createItemTile

protected TileItem createItemTile()

hasItem

protected boolean hasItem()

getItem

public Item getItem()

onRemoved

public void onRemoved(IWorld world,
                      int x,
                      int y,
                      TileLayer layer)

onAdded

public void onAdded(IWorld world,
                    int x,
                    int y,
                    TileLayer layer)

onInteractWith

public boolean onInteractWith(IWorld world,
                              int x,
                              int y,
                              TileLayer layer,
                              double mouseX,
                              double mouseY,
                              AbstractPlayerEntity player)

onInteractWithBreakKey

public boolean onInteractWithBreakKey(IWorld world,
                                      int x,
                                      int y,
                                      TileLayer layer,
                                      double mouseX,
                                      double mouseY,
                                      AbstractPlayerEntity player)

getInteractionPriority

public int getInteractionPriority(IWorld world,
                                  int x,
                                  int y,
                                  TileLayer layer,
                                  double mouseX,
                                  double mouseY,
                                  AbstractPlayerEntity player)

canReplace

public boolean canReplace(IWorld world,
                          int x,
                          int y,
                          TileLayer layer)

doesSustainLeaves

public boolean doesSustainLeaves(IWorld world,
                                 int x,
                                 int y,
                                 TileLayer layer)

chisel

public boolean chisel(IWorld world,
                      int x,
                      int y,
                      TileState state,
                      double mouseX,
                      double mouseY)

Attempts to chisel a corner of the tile based on the cursor position. Only works if the tile is isChiselable()

Parameters:

world - The IWorld the tile is in.

x - The x position of the tile

y - The y position of the tile

state - The TileState of the tile

mouseX - The x position of the cursor

mouseY - The y position of the cursor

Returns:

True if the tile has been chiseled, false otherwise.

onDestroyed

public void onDestroyed(IWorld world,
                        int x,
                        int y,
                        Entity destroyer,
                        TileLayer layer,
                        boolean shouldDrop)

getDrops

public java.util.List<ItemInstance> getDrops(IWorld world,
                                             int x,
                                             int y,
                                             TileLayer layer,
                                             Entity destroyer)

provideTileEntity

public TileEntity provideTileEntity(IWorld world,
                                    int x,
                                    int y,
                                    TileLayer layer)

canProvideTileEntity

public boolean canProvideTileEntity()

onChangeAround

public void onChangeAround(IWorld world,
                           int x,
                           int y,
                           TileLayer layer,
                           int changedX,
                           int changedY,
                           TileLayer changedLayer)

canStay

public boolean canStay(IWorld world,
                       int x,
                       int y,
                       TileLayer layer,
                       int changedX,
                       int changedY,
                       TileLayer changedLayer)

isFullTile

public boolean isFullTile()

obscuresBackground

public boolean obscuresBackground(IWorld world,
                                  int x,
                                  int y,
                                  TileLayer layer)

updateRandomly

public void updateRandomly(IWorld world,
                           int x,
                           int y,
                           TileLayer layer)

updateRandomlyInPlayerView

public void updateRandomlyInPlayerView(IWorld world,
                                       int x,
                                       int y,
                                       TileLayer layer,
                                       TileState state,
                                       IParticleManager manager)

doBreak

public void doBreak(IWorld world,
                    int x,
                    int y,
                    TileLayer layer,
                    AbstractPlayerEntity breaker,
                    boolean isRightTool,
                    boolean allowDrop)

doPlace

public void doPlace(IWorld world,
                    int x,
                    int y,
                    TileLayer layer,
                    ItemInstance instance,
                    AbstractPlayerEntity placer)

getPlacementState

public TileState getPlacementState(IWorld world,
                                   int x,
                                   int y,
                                   TileLayer layer,
                                   ItemInstance instance,
                                   AbstractPlayerEntity placer)

getHardness

public float getHardness(IWorld world,
                         int x,
                         int y,
                         TileLayer layer)

setHardness

public Tile setHardness(float hardness)

setForceDrop

public Tile setForceDrop()

isChiselable

public boolean isChiselable()

setChiselable

public Tile setChiselable()

Call this to make your tile chiselable. Make sure you do this before you call the register() method.

Returns:

The tile

isChiseled

public boolean isChiseled(IWorld world,
                          int x,
                          int y,
                          TileLayer layer,
                          TileState state)

isToolEffective

public boolean isToolEffective(IWorld world,
                               int x,
                               int y,
                               TileLayer layer,
                               ToolProperty property,
                               int level)

addEffectiveTool

public Tile addEffectiveTool(ToolProperty property,
                             int level)

getLight

public int getLight(IWorld world,
                    int x,
                    int y,
                    TileLayer layer)

getTranslucentModifier

public float getTranslucentModifier(IWorld world,
                                    int x,
                                    int y,
                                    TileLayer layer,
                                    boolean skylight)

isAir

public boolean isAir()

getName

public ResourceName getName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

onScheduledUpdate

public void onScheduledUpdate(IWorld world,
                              int x,
                              int y,
                              TileLayer layer,
                              int scheduledMeta)

canClimb

public boolean canClimb(IWorld world,
                        int x,
                        int y,
                        TileLayer layer,
                        TileState state,
                        BoundingBox entityBox,
                        BoundingBox entityBoxMotion,
                        java.util.List<BoundingBox> tileBoxes,
                        Entity entity)

onCollideWithEntity

public void onCollideWithEntity(IWorld world,
                                int x,
                                int y,
                                TileLayer layer,
                                TileState state,
                                BoundingBox entityBox,
                                BoundingBox entityBoxMotion,
                                java.util.List<BoundingBox> tileBoxes,
                                Entity entity)

onIntersectWithEntity

public void onIntersectWithEntity(IWorld world,
                                  int x,
                                  int y,
                                  TileLayer layer,
                                  TileState state,
                                  BoundingBox entityBox,
                                  BoundingBox entityBoxMotion,
                                  java.util.List<BoundingBox> tileBoxes,
                                  Entity entity)

describeItem

public void describeItem(IAssetManager manager,
                         ItemInstance instance,
                         java.util.List<java.lang.String> desc,
                         boolean isAdvanced)

canGrassSpreadTo

public boolean canGrassSpreadTo(IWorld world,
                                int x,
                                int y,
                                TileLayer layer)

canKeepPlants

public boolean canKeepPlants(IWorld world,
                             int x,
                             int y,
                             TileLayer layer)

canKeepFarmablePlants

public boolean canKeepFarmablePlants(IWorld world,
                                     int x,
                                     int y,
                                     TileLayer layer)

getDefState

public TileState getDefState()

addProps

public Tile addProps(TileProp... props)

getProps

public java.util.List<TileProp> getProps()

hasProp

public boolean hasProp(TileProp prop)

hasState

public boolean hasState(ResourceName name,
                        java.util.Map<java.lang.String,java.lang.Comparable> props)

getBreakSound

public ResourceName getBreakSound(IWorld world,
                                  int x,
                                  int y,
                                  TileLayer layer,
                                  Entity destroyer)

getPlaceSound

public ResourceName getPlaceSound(IWorld world,
                                  int x,
                                  int y,
                                  TileLayer layer,
                                  Entity placer,
                                  TileState state)

getMaxInteractionDistance

public double getMaxInteractionDistance(IWorld world,
                                        int x,
                                        int y,
                                        TileLayer layer,
                                        double mouseX,
                                        double mouseY,
                                        AbstractPlayerEntity player)

hasSolidSurface

public boolean hasSolidSurface(IWorld world,
                               int x,
                               int y,
                               TileLayer layer)

canLiquidSpread

public boolean canLiquidSpread(IWorld world,
                               int x,
                               int y,
                               LiquidTile liquid,
                               Direction dir)

isLiquid

public boolean isLiquid()

canSwim

public boolean canSwim(IWorld world,
                       int x,
                       int y,
                       TileLayer layer,
                       Entity entity)

setMaxAmount

public Tile setMaxAmount(int amount)

factorsIntoHeightMap

public boolean factorsIntoHeightMap(IWorld world,
                                    int x,
                                    int y,
                                    TileLayer layer)

makesGrassSnowy

public boolean makesGrassSnowy(IWorld world,
                               int x,
                               int y,
                               TileLayer layer)