me.desht.pneumaticcraft.api.semiblock

Interface ISemiBlock

All Superinterfaces:

net.minecraftforge.common.capabilities.ICapabilityProvider

All Known Implementing Classes:

EntityCropSupport, EntityHeatFrame, EntityLogisticsActiveProvider, EntityLogisticsDefaultStorage, EntityLogisticsFrame, EntityLogisticsPassiveProvider, EntityLogisticsRequester, EntityLogisticsStorage, EntitySemiblockBase, EntitySpawnerAgitator, EntityTransferGadget

public interface ISemiBlock
extends net.minecraftforge.common.capabilities.ICapabilityProvider

Represents a "semiblock" - an attachable gadget which sits on a real block, such as a logistics frame or crop support.

Implementation Note:

While semiblocks are implemented as entities, this is an implementation detail which should not be relied upon any more than strictly necessary.

Method Summary

Modifier and Type	Method and Description
default void	addTooltip(java.util.List<net.minecraft.util.text.ITextComponent> curInfo, net.minecraft.entity.player.PlayerEntity player, net.minecraft.nbt.CompoundNBT tag, boolean extended) Add tooltip information for this semiblock.
static ISemiBlock	byTrackingId(net.minecraft.world.World world, int id) Retrieve a semiblock by tracking ID.
boolean	canCoexist(ISemiBlock otherSemiblock) Check if this semiblock can coexist with the other semiblock, in the same block pos.
boolean	canPlace(net.minecraft.util.Direction facing) Check if this semiblock can be placed here.
net.minecraft.util.math.BlockPos	getBlockPos() Get the block position this entity occupies.
net.minecraft.tileentity.TileEntity	getCachedTileEntity() Get the tile entity at the semiblock's position.
default int	getColor() A color in ARGB format.
net.minecraft.util.text.ITextComponent	getDisplayName() Get the displayed name for this semiblock.
net.minecraft.util.NonNullList<net.minecraft.item.ItemStack>	getDrops() Add any dropped items from this semiblock to the given list.
net.minecraft.util.ResourceLocation	getSemiblockId() Get a unique ID for this semiblock, which should match the corresponding item's registry name.
int	getTrackingId() Get the tracking for this semiblock; this should only be used for network sync purposes, and is subject to change on a world reload.
net.minecraft.world.World	getWorld() Get the world this semiblock is in.
boolean	isValid() Check if this semiblock is still valid, i.e.
default void	onPlaced(net.minecraft.entity.player.PlayerEntity player, net.minecraft.item.ItemStack stack, net.minecraft.util.Direction facing) Called immediately after the semiblock entity has been added to the world.
default boolean	onRightClickWithConfigurator(net.minecraft.entity.player.PlayerEntity player, net.minecraft.util.Direction side) Called when a semiblock is right-clicked with a Logistics Configurator
void	readFromBuf(net.minecraft.network.PacketBuffer payload) Read this semiblock from network buffer for network sync purposes.
void	removeSemiblock(net.minecraft.entity.player.PlayerEntity player) Mark this semiblock for removal.
net.minecraft.nbt.CompoundNBT	serializeNBT(net.minecraft.nbt.CompoundNBT tag) Written to the dropped item (under the "EntityTag" subtag) when the semiblock is broken, to persisted entity data by Entity#writeAdditional(), and displayed by info mods such as TOP or Waila.
void	tick() Implement tick logic here.
void	writeToBuf(net.minecraft.network.PacketBuffer payload) Write this semiblock to network buffer for network sync purposes.

Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability, getCapability

Method Detail

getSemiblockId

net.minecraft.util.ResourceLocation getSemiblockId()

Get a unique ID for this semiblock, which should match the corresponding item's registry name.

Returns:

a semiblock ID

getDisplayName

net.minecraft.util.text.ITextComponent getDisplayName()

Get the displayed name for this semiblock.

Returns:

the name

getWorld

net.minecraft.world.World getWorld()

Get the world this semiblock is in.

Returns:

the world

getBlockPos

net.minecraft.util.math.BlockPos getBlockPos()

Get the block position this entity occupies.

Returns:

the block pos

getCachedTileEntity

net.minecraft.tileentity.TileEntity getCachedTileEntity()

Get the tile entity at the semiblock's position. This is cached for performance.

Returns:

the tile entity, or null if there is none

serializeNBT

net.minecraft.nbt.CompoundNBT serializeNBT(net.minecraft.nbt.CompoundNBT tag)

Written to the dropped item (under the "EntityTag" subtag) when the semiblock is broken, to persisted entity data by Entity#writeAdditional(), and displayed by info mods such as TOP or Waila. Use this method rather than writeAdditional() for fields that either need to be serialized to the dropped item, or displayed on TOP/Waila.

Parameters:

tag - NBT tag to write data to

Implementation Note:

Data written to itemstacks is automatically applied to newly-spawned entities by EntityType.updateCustomEntityTag(World, PlayerEntity, Entity, CompoundNBT) when the semiblock entity is spawned from an item (i.e. placed by a player).

tick

void tick()

Implement tick logic here. Always be sure to call super.tick() in subclass overrides!

isValid

boolean isValid()

Check if this semiblock is still valid, i.e. the underlying entity is still alive.

Returns:

true if this semiblock is valid, false otherwise

getDrops

net.minecraft.util.NonNullList<net.minecraft.item.ItemStack> getDrops()

Add any dropped items from this semiblock to the given list. By default, just the semiblock item itself is added, but this can be overridden to drop extra items if needed.

canPlace

boolean canPlace(net.minecraft.util.Direction facing)

Check if this semiblock can be placed here.

Parameters:

facing - the side of the block against which it is placed

Returns:

true if the semiblock is placeable here, false otherwise

onPlaced

default void onPlaced(net.minecraft.entity.player.PlayerEntity player,
                      net.minecraft.item.ItemStack stack,
                      net.minecraft.util.Direction facing)

Called immediately after the semiblock entity has been added to the world.

Parameters:

player - player who is placing the semiblock

stack - itemstack used to create the entity

facing - the side of the block which was clicked to place the entity

onRightClickWithConfigurator

default boolean onRightClickWithConfigurator(net.minecraft.entity.player.PlayerEntity player,
                                             net.minecraft.util.Direction side)

Called when a semiblock is right-clicked with a Logistics Configurator

Parameters:

player - the player

side - the side of the block being clicked

Returns:

true if something was done, false if the semiblock doesn't care about being clicked

canCoexist

boolean canCoexist(ISemiBlock otherSemiblock)

Check if this semiblock can coexist with the other semiblock, in the same block pos. By default this is true if at least one of the semiblocks is a IDirectionalSemiblock and both semiblocks have a different side.

Parameters:

otherSemiblock - the other semiblock

Returns:

true if they can coexist, false otherwise

getTrackingId

int getTrackingId()

Get the tracking for this semiblock; this should only be used for network sync purposes, and is subject to change on a world reload.

Returns:

the underlying entity's ID, or -1 if the entity has not been added to the world

See Also:

byTrackingId(World, int)

removeSemiblock

void removeSemiblock(net.minecraft.entity.player.PlayerEntity player)

Mark this semiblock for removal.

Parameters:

player - player who is removing the semiblock

addTooltip

default void addTooltip(java.util.List<net.minecraft.util.text.ITextComponent> curInfo,
                        net.minecraft.entity.player.PlayerEntity player,
                        net.minecraft.nbt.CompoundNBT tag,
                        boolean extended)

Add tooltip information for this semiblock. This info is used by info mods such as Waila or TOP.

Parameters:

curInfo - append info to this list

player - the player looking at the entity or item

tag - NBT data as saved by serializeNBT(CompoundNBT)

extended - true if extended data should be shown

writeToBuf

void writeToBuf(net.minecraft.network.PacketBuffer payload)

Write this semiblock to network buffer for network sync purposes.

Parameters:

payload - the buffer

readFromBuf

void readFromBuf(net.minecraft.network.PacketBuffer payload)

Read this semiblock from network buffer for network sync purposes.

Parameters:

payload - the buffer

getColor

default int getColor()

A color in ARGB format. Used for various things: GUI/item/render tinting, as well as TOP colour coding.

Returns:

a color for this semiblock type

byTrackingId

static ISemiBlock byTrackingId(net.minecraft.world.World world,
                               int id)

Retrieve a semiblock by tracking ID. This is only intended to be used for network sync purposes and is subject to change on a world reload.

Parameters:

world - the world

id - the tracking ID

Returns:

a semiblock, or null if ID is not valid

See Also:

getTrackingId()