appeng.api.parts

Interface IPart

All Superinterfaces:

IBoxProvider, ICustomCableConnection

All Known Subinterfaces:

IPartCable, IPartMonitor, IPartStorageMonitor

public interface IPart
extends IBoxProvider, ICustomCableConnection

Method Summary

Modifier and Type	Method and Description
void	addToWorld() called when your part is being added to the world.
boolean	canBePlacedOn(BusSupport what) Used to determine which parts can be placed on what cables.
boolean	canConnectRedstone()
float	getCableConnectionLength(AECableType cable)
default <T> T	getCapability(net.minecraftforge.common.capabilities.Capability<T> capabilityClass) Implement this method if your part exposes capabilitys.
void	getDrops(java.util.List<net.minecraft.item.ItemStack> drops, boolean wrenched) Add drops to the items being dropped into the world, if your item stores its contents when wrenched use the wrenched boolean to control what data is saved vs dropped when it is broken.
IGridNode	getExternalFacingNode() used for tunnels.
IGridNode	getGridNode() get the Grid Node for the Bus, be sure your IGridBlock is NOT isWorldAccessible, if it is your going to cause crashes.
net.minecraft.item.ItemStack	getItemStack(PartItemStack type) get an ItemStack that represents the bus, should contain the settings for whatever, can also be used in conjunction with removePart to take a part off and drop it or something.
int	getLightLevel()
default java.lang.Long	getRenderFlag() Flag to be passed to the renderer.
default IPartModel	getStaticModels() This method is used when a chunk is rebuilt to determine how this part should be rendered.
default boolean	hasCapability(net.minecraftforge.common.capabilities.Capability<?> capabilityClass) Implement this method if your part exposes capabilitys.
boolean	isLadder(net.minecraft.entity.EntityLivingBase entity) does this part act like a ladder?
int	isProvidingStrongPower()
int	isProvidingWeakPower()
boolean	isSolid()
boolean	onActivate(net.minecraft.entity.player.EntityPlayer player, net.minecraft.util.EnumHand hand, net.minecraft.util.math.Vec3d pos) Called when you right click the part, very similar to Block.onActivateBlock
default boolean	onClicked(net.minecraft.entity.player.EntityPlayer player, net.minecraft.util.EnumHand hand, net.minecraft.util.math.Vec3d pos) Called when you left click the part, very similar to Block.onBlockClicked
void	onEntityCollision(net.minecraft.entity.Entity entity) called when an entity collides with the bus.
void	onNeighborChanged(net.minecraft.world.IBlockAccess w, net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.BlockPos neighbor) a block around the bus's host has been changed.
void	onPlacement(net.minecraft.entity.player.EntityPlayer player, net.minecraft.util.EnumHand hand, net.minecraft.item.ItemStack held, AEPartLocation side) Called when placed in the world by a player, this happens before addWorld.
boolean	onShiftActivate(net.minecraft.entity.player.EntityPlayer player, net.minecraft.util.EnumHand hand, net.minecraft.util.math.Vec3d pos) Called when you right click the part, very similar to Block.onActivateBlock
default boolean	onShiftClicked(net.minecraft.entity.player.EntityPlayer player, net.minecraft.util.EnumHand hand, net.minecraft.util.math.Vec3d pos) Called when you shift-left click the part, very similar to Block.onBlockClicked
void	randomDisplayTick(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, java.util.Random r) same as Block.randomDisplayTick, for but parts.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound data) Read the previously written NBT Data. this is the mirror for writeToNBT
boolean	readFromStream(io.netty.buffer.ByteBuf data) read data from bus packet.
void	removeFromWorld() called when your part is being removed from the world.
default void	renderDynamic(double x, double y, double z, float partialTicks, int destroyStage) Render dynamic portions of this part, as part of the cable bus TESR.
boolean	requireDynamicRender() return true only if your part require dynamic rendering, must be consistent.
void	setPartHostInfo(AEPartLocation side, IPartHost host, net.minecraft.tileentity.TileEntity tile) called by the Part host to keep your part informed.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound data) Write the part information for saving, the part will be saved with getItemStack(false) and this method will be called after to load settings, inventory or other values from the world.
void	writeToStream(io.netty.buffer.ByteBuf data) write data to bus packet.

Methods inherited from interface appeng.api.parts.IBoxProvider

getBoxes

Method Detail

getItemStack

net.minecraft.item.ItemStack getItemStack(PartItemStack type)

get an ItemStack that represents the bus, should contain the settings for whatever, can also be used in conjunction with removePart to take a part off and drop it or something. This is used to drop the bus, and to save the bus, when saving the bus, wrenched is false, and writeToNBT will be called to save important details about the part, if the part is wrenched include in your NBT Data any settings you might want to keep around, you can restore those settings when constructing your part.

Parameters:

type - , what kind of ItemStack to return?

Returns:

item of part

renderDynamic

default void renderDynamic(double x,
                           double y,
                           double z,
                           float partialTicks,
                           int destroyStage)

Render dynamic portions of this part, as part of the cable bus TESR. This part has to return true for requireDynamicRender() in order for this method to be called.

requireDynamicRender

boolean requireDynamicRender()

return true only if your part require dynamic rendering, must be consistent.

Returns:

true to enable renderDynamic

isSolid

boolean isSolid()

Returns:

if the bus has a solid side, and you can place random stuff on it like torches or levers

canConnectRedstone

boolean canConnectRedstone()

Returns:

true if this part can connect to redstone ( also MFR Rednet )

writeToNBT

void writeToNBT(net.minecraft.nbt.NBTTagCompound data)

Write the part information for saving, the part will be saved with getItemStack(false) and this method will be called after to load settings, inventory or other values from the world.

Parameters:

data - to be written nbt data

readFromNBT

void readFromNBT(net.minecraft.nbt.NBTTagCompound data)

Read the previously written NBT Data. this is the mirror for writeToNBT

Parameters:

data - to be read nbt data

getLightLevel

int getLightLevel()

Returns:

get the amount of light produced by the bus

isLadder

boolean isLadder(net.minecraft.entity.EntityLivingBase entity)

does this part act like a ladder?

Parameters:

entity - climbing entity

Returns:

true if entity can climb

onNeighborChanged

void onNeighborChanged(net.minecraft.world.IBlockAccess w,
                       net.minecraft.util.math.BlockPos pos,
                       net.minecraft.util.math.BlockPos neighbor)

a block around the bus's host has been changed.

isProvidingStrongPower

int isProvidingStrongPower()

Returns:

output redstone on facing side

isProvidingWeakPower

int isProvidingWeakPower()

Returns:

output redstone on facing side

writeToStream

void writeToStream(io.netty.buffer.ByteBuf data)
            throws java.io.IOException

write data to bus packet.

Parameters:

data - to be written data

Throws:

java.io.IOException

readFromStream

boolean readFromStream(io.netty.buffer.ByteBuf data)
                throws java.io.IOException

read data from bus packet.

Parameters:

data - to be read data

Returns:

true will re-draw the part.

Throws:

java.io.IOException

getGridNode

IGridNode getGridNode()

get the Grid Node for the Bus, be sure your IGridBlock is NOT isWorldAccessible, if it is your going to cause crashes. or null if you don't have a grid node.

Returns:

grid node

onEntityCollision

void onEntityCollision(net.minecraft.entity.Entity entity)

called when an entity collides with the bus.

Parameters:

entity - colliding entity

removeFromWorld

void removeFromWorld()

called when your part is being removed from the world.

addToWorld

void addToWorld()

called when your part is being added to the world.

getExternalFacingNode

IGridNode getExternalFacingNode()

used for tunnels.

Returns:

a grid node that represents the external facing side, these must be isWorldAccessible with the correct faces marked as external

setPartHostInfo

void setPartHostInfo(AEPartLocation side,
                     IPartHost host,
                     net.minecraft.tileentity.TileEntity tile)

called by the Part host to keep your part informed.

Parameters:

host - part side

tile - tile entity of part

onActivate

boolean onActivate(net.minecraft.entity.player.EntityPlayer player,
                   net.minecraft.util.EnumHand hand,
                   net.minecraft.util.math.Vec3d pos)

Called when you right click the part, very similar to Block.onActivateBlock

Parameters:

player - right clicking player

hand - hand used

pos - position of block

Returns:

if your activate method performed something.

onShiftActivate

boolean onShiftActivate(net.minecraft.entity.player.EntityPlayer player,
                        net.minecraft.util.EnumHand hand,
                        net.minecraft.util.math.Vec3d pos)

Called when you right click the part, very similar to Block.onActivateBlock

Parameters:

player - shift right clicking player

hand - hand used

pos - position of block

Returns:

if your activate method performed something, you should use false unless you really need it.

onClicked

default boolean onClicked(net.minecraft.entity.player.EntityPlayer player,
                          net.minecraft.util.EnumHand hand,
                          net.minecraft.util.math.Vec3d pos)

Called when you left click the part, very similar to Block.onBlockClicked

Parameters:

player - left clicking player

hand - hand used

pos - position of block

Returns:

if your activate method performed something, you should use false unless you really need it.

onShiftClicked

default boolean onShiftClicked(net.minecraft.entity.player.EntityPlayer player,
                               net.minecraft.util.EnumHand hand,
                               net.minecraft.util.math.Vec3d pos)

Called when you shift-left click the part, very similar to Block.onBlockClicked

Parameters:

player - shift-left clicking player

hand - hand used

pos - position of block

Returns:

if your activate method performed something, you should use false unless you really need it.

getDrops

void getDrops(java.util.List<net.minecraft.item.ItemStack> drops,
              boolean wrenched)

Add drops to the items being dropped into the world, if your item stores its contents when wrenched use the wrenched boolean to control what data is saved vs dropped when it is broken.

Parameters:

drops - item drops if wrenched

wrenched - control flag for wrenched vs broken

getCableConnectionLength

float getCableConnectionLength(AECableType cable)

Specified by:

getCableConnectionLength in interface ICustomCableConnection

Returns:

0 - 8, reasonable default 3-4, this controls the cable connection to the node. -1 to render connection yourself.

randomDisplayTick

void randomDisplayTick(net.minecraft.world.World world,
                       net.minecraft.util.math.BlockPos pos,
                       java.util.Random r)

same as Block.randomDisplayTick, for but parts.

Parameters:

world - world of block

pos - location of block

r - random

onPlacement

void onPlacement(net.minecraft.entity.player.EntityPlayer player,
                 net.minecraft.util.EnumHand hand,
                 net.minecraft.item.ItemStack held,
                 AEPartLocation side)

Called when placed in the world by a player, this happens before addWorld.

Parameters:

player - placing player

held - held item

side - placing side

canBePlacedOn

boolean canBePlacedOn(BusSupport what)

Used to determine which parts can be placed on what cables.

Parameters:

what - placed part

Returns:

true if the part can be placed on this support.

getStaticModels

@Nonnull
default IPartModel getStaticModels()

This method is used when a chunk is rebuilt to determine how this part should be rendered. The returned models should represent the part oriented north. They will be automatically rotated to match the part's actual orientation. Tint indices 1-4 can be used in the models to access the parts color.

Tint Index 1

The dark variant color of the cable that this part is attached to.

Tint Index 2

The color of the cable that this part is attached to.

Tint Index 3

The bright variant color of the cable that this part is attached to.

Tint Index 4

A color variant that is between the cable's color and its bright variant.

Important: All models must have been registered via the IPartModels API before use.

hasCapability

default boolean hasCapability(net.minecraftforge.common.capabilities.Capability<?> capabilityClass)

Implement this method if your part exposes capabilitys. Any requests for capabilities on the cable bus will be forwarded to parts on the appropriate side.

Returns:

True if your part has the requested capability.

See Also:

TileEntity.hasCapability(Capability, EnumFacing)

getCapability

default <T> T getCapability(net.minecraftforge.common.capabilities.Capability<T> capabilityClass)

Implement this method if your part exposes capabilitys. Any requests for capabilities on the cable bus will be forwarded to parts on the appropriate side.

Returns:

The capability or null.

See Also:

TileEntity.getCapability(Capability, EnumFacing)

getRenderFlag

default java.lang.Long getRenderFlag()

Flag to be passed to the renderer.

Returns:

flag or null