Package alexiil.mc.lib.multipart.api

Class AbstractPart

java.lang.Object

alexiil.mc.lib.multipart.api.AbstractPart

Direct Known Subclasses:

MissingPart

public abstract class AbstractPart
extends Object

The base class for every part in a multipart block.

Generally implementations will want to override (in addition to the abstract methods):

• getPickStack(BlockHitResult) (and optionally addDrops(DefaultedList)}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbstractPart.ItemDropTarget	A target for retrieving item drops from addDrops(ItemDropTarget, LootContext).

Field Summary

Fields

Modifier and Type	Field	Description
final MultipartContainer	container
final PartDefinition	definition
final MultipartHolder	holder
static final ParentNetIdSingle<AbstractPart>	NET_ID
static final NetIdDataK<AbstractPart>	NET_RENDER_DATA
static final NetIdSignalK<AbstractPart>	NET_SPAWN_BREAK_PARTICLES
static final NetIdDataK<AbstractPart>	NET_SPAWN_FALL_PARTICLES

Constructor Summary

Constructors

Constructor	Description
AbstractPart(PartDefinition definition, MultipartHolder holder)

Method Summary

Modifier and Type	Method	Description
void	addAllAttributes(AttributeList<?> list)	Offers every contained attribute to the given attribute list.
void	addDrops(AbstractPart.ItemDropTarget target, LootContext context)
void	addDrops(DefaultedList<ItemStack> to)	Deprecated. Replaced by addDrops(ItemDropTarget, LootContext)
protected final void	addRequiredPart(AbstractPart required)
void	afterBreak(PlayerEntity player)	Called instead of Block.afterBreak(World, PlayerEntity, BlockPos, BlockState, BlockEntity, ItemStack), except that this shouldn't drop any items, as that's handled separately.
static float	calcBreakingDelta(PlayerEntity player, BlockState state, float hardness)	Calculates calculateBreakingDelta(PlayerEntity) as if this part was the given block state instead, but using a custom hardness value.
float	calculateBreakingDelta(PlayerEntity player)	Part version of AbstractBlock.calcBlockBreakingDelta(BlockState, PlayerEntity, BlockView, BlockPos).
final float	calculateBreakingDelta(PlayerEntity player, Block block)	Calculates calculateBreakingDelta(PlayerEntity) as if this part was the given block instead.
final float	calculateBreakingDelta(PlayerEntity player, BlockState state)	Calculates calculateBreakingDelta(PlayerEntity) as if this part was the given block state instead.
boolean	canOverlapWith(AbstractPart other)	Checks to see if this AbstractPart can overlap with the other part.
protected BlockState	getClosestBlockState()
VoxelShape	getCollisionShape()
VoxelShape	getCullingShape()
VoxelShape	getDynamicShape(float partialTicks)	Deprecated. Use (and implement) getDynamicShape(float, Vec3d) instead.
VoxelShape	getDynamicShape(float partialTicks, Vec3d hitVec)
abstract PartModelKey	getModelKey()	Called on the client for both rendering, and checking if this needs to re-render in MultipartContainer.redrawIfChanged().
VoxelShape	getOutlineShape()
ItemStack	getPickStack()	Deprecated. Use (and implement) getPickStack(BlockHitResult) instead.
ItemStack	getPickStack(BlockHitResult hitResult)	Called whenever this part is picked by the player (similar to Block.getPickStack(BlockView, BlockPos, BlockState) but with a BlockHitResult for picking pieces of parts).
abstract VoxelShape	getShape()
boolean	isBlocking(Direction searchDirection)
void	mirror(BlockMirror mirror)	Deprecated. Please use the PartTransformEvent.Mirror event instead.
void	onAdded(MultipartEventBus bus)	Called whenever this part was added to the MultipartContainer, either in BlockEntity.cancelRemoval() or when it is manually added by an item.
boolean	onBreak(PlayerEntity player)	Called instead of Block.onBreak(World, BlockPos, BlockState, PlayerEntity), to play the broken sound, and spawn break particles.
void	onPlacedBy(PlayerEntity player, Hand hand)	Open method, that's designed to be called from the Item that places this part into the world.
void	onRemoved()
boolean	onSpawnFallParticles(LivingEntity fallenEntity, Random entityRandom)	Called on the server when an entity has fallen on this part and is attempting to spawn particles for it.
ActionResult	onUse(PlayerEntity player, Hand hand, BlockHitResult hit)	Called whenever this part is used via AbstractBlock.onUse(BlockState, World, BlockPos, PlayerEntity, Hand, BlockHitResult).
protected void	playBreakSound()	Called by default in onBreak(PlayerEntity) to play the breaking sound.
protected final void	playBreakSound(BlockState blockState)
protected final void	playHitSound(BlockState blockState)
void	playHitSound(PlayerEntity player)	Called instead of Block.onBreak(World, BlockPos, BlockState, PlayerEntity), to play the broken sound, and spawn break particles.
protected static final double	pos(World world, Direction side, Direction.Axis axis, double size)
void	readRenderData(NetByteBuf buffer, IMsgReadCtx ctx)
protected final void	removeRequiredPart(AbstractPart required)
void	rotate(BlockRotation rotation)	Deprecated. Please use the PartTransformEvent.Rotate event instead.
final <T> void	sendNetworkUpdate(T obj, NetIdDataK<T> netId, NetIdDataK.IMsgDataWriterK<T> writer)	Sends the given NetIdDataK to every player currently watching this multipart, with a custom NetIdDataK.IMsgDataWriterK.
final <T> void	sendNetworkUpdate(T obj, NetIdTyped<T> netId)	Sends the given NetIdDataK or NetIdSignalK to every player currently watching this multipart.
final <T> void	sendNetworkUpdateExcept(PlayerEntity except, T obj, NetIdDataK<T> netId, NetIdDataK.IMsgDataWriterK<T> writer)	Sends the given NetIdDataK to every player currently watching this multipart, with a custom NetIdDataK.IMsgDataWriterK, except for the given player.
final <T> void	sendNetworkUpdateExcept(PlayerEntity except, T obj, NetIdTyped<T> netId)	Sends the given NetIdDataK or NetIdSignalK to every player currently watching this multipart, except for the given player.
protected final void	sendSpawnFallParticles(Vec3d pos, int count)	Actually Sends the packet from the server to the clients that spawns the fall particles.
boolean	spawnBreakingParticles(Direction side)	Deprecated. This was renamed to spawnHitParticle(Direction)
protected void	spawnBreakParticles()	Called on the client to spawn break particles.
protected final void	spawnBreakParticles(BlockState state)
protected final void	spawnBreakParticles(BlockState state, Sprite sprite)
protected final void	spawnBreakParticles(BlockState state, Identifier spriteId)
protected void	spawnFallParticles(Vec3d pos, int count)	Called on the client to spawn fall particles.
protected final void	spawnFallParticles(Vec3d pos, int count, BlockState state)
protected final void	spawnFallParticles(Vec3d pos, int count, BlockState state, Sprite sprite)
protected final void	spawnFallParticles(Vec3d pos, int count, BlockState state, Identifier spriteId)
boolean	spawnHitParticle(Direction side)	Spawns a single partial-break (hit) particle.
protected final void	spawnHitParticle(Direction side, BlockState state)
protected final void	spawnHitParticle(Direction side, BlockState state, Sprite sprite)
protected final void	spawnHitParticle(Direction side, BlockState state, Identifier spriteId)
protected final void	spawnHitParticle(Direction side, Box box, BlockState state, Sprite sprite)
boolean	spawnIronGolemParticle(IronGolemEntity ironGolem, Random entityRandom)	Spawns a single particle for when an iron golem walks on this part.
protected final void	spawnIronGolemParticle(IronGolemEntity ironGolem, Random entityRandom, BlockState state)
protected final void	spawnIronGolemParticle(IronGolemEntity ironGolem, Random entityRandom, BlockState state, Sprite sprite)
protected final void	spawnIronGolemParticle(IronGolemEntity ironGolem, Random entityRandom, BlockState state, Identifier spriteId)
boolean	spawnSprintParticle(Entity sprintingEntity, Random entityRandom)	Spawns a single sprint particle.
protected final void	spawnSprintParticle(Entity sprintingEntity, Random entityRandom, BlockState state)
protected final void	spawnSprintParticle(Entity sprintingEntity, Random entityRandom, BlockState state, Sprite sprite)
protected final void	spawnSprintParticle(Entity sprintingEntity, Random entityRandom, BlockState state, Identifier spriteId)
NbtCompound	toTag()
void	writeCreationData(NetByteBuf buffer, IMsgWriteCtx ctx)	Writes the payload that will be passed into PartDefinition.loadFromBuffer(MultipartHolder, NetByteBuf, IMsgReadCtx) on the client.
void	writeRenderData(NetByteBuf buffer, IMsgWriteCtx ctx)

Methods inherited from class java.lang.Object

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

Field Details

NET_ID

public static final ParentNetIdSingle<AbstractPart> NET_ID

NET_RENDER_DATA

public static final NetIdDataK<AbstractPart> NET_RENDER_DATA

NET_SPAWN_BREAK_PARTICLES

public static final NetIdSignalK<AbstractPart> NET_SPAWN_BREAK_PARTICLES

NET_SPAWN_FALL_PARTICLES

public static final NetIdDataK<AbstractPart> NET_SPAWN_FALL_PARTICLES

definition

public final PartDefinition definition

holder

public final MultipartHolder holder

container

public final MultipartContainer container

Constructor Details

AbstractPart

public AbstractPart(PartDefinition definition,
 MultipartHolder holder)

Method Details

toTag

public NbtCompound toTag()

writeCreationData

public void writeCreationData(NetByteBuf buffer,
 IMsgWriteCtx ctx)

Writes the payload that will be passed into PartDefinition.loadFromBuffer(MultipartHolder, NetByteBuf, IMsgReadCtx) on the client. (This is called on the server and sent to the client). Note that this will be called *instead* of write and read payload.

writeRenderData

public void writeRenderData(NetByteBuf buffer,
 IMsgWriteCtx ctx)

readRenderData

public void readRenderData(NetByteBuf buffer,
 IMsgReadCtx ctx)
                    throws InvalidInputDataException

Throws:

InvalidInputDataException

sendNetworkUpdate

public final <T> void sendNetworkUpdate(T obj,
 NetIdTyped<T> netId)

Sends the given NetIdDataK or NetIdSignalK to every player currently watching this multipart.

sendNetworkUpdate

public final <T> void sendNetworkUpdate(T obj,
 NetIdDataK<T> netId,
 NetIdDataK.IMsgDataWriterK<T> writer)

Sends the given NetIdDataK to every player currently watching this multipart, with a custom NetIdDataK.IMsgDataWriterK.

sendNetworkUpdateExcept

public final <T> void sendNetworkUpdateExcept(@Nullable
 PlayerEntity except,
 T obj,
 NetIdTyped<T> netId)

Sends the given NetIdDataK or NetIdSignalK to every player currently watching this multipart, except for the given player.

sendNetworkUpdateExcept

public final <T> void sendNetworkUpdateExcept(@Nullable
 PlayerEntity except,
 T obj,
 NetIdDataK<T> netId,
 NetIdDataK.IMsgDataWriterK<T> writer)

Sends the given NetIdDataK to every player currently watching this multipart, with a custom NetIdDataK.IMsgDataWriterK, except for the given player.

onAdded

public void onAdded(MultipartEventBus bus)

Called whenever this part was added to the MultipartContainer, either in BlockEntity.cancelRemoval() or when it is manually added by an item.

Register event handlers (as methods) with MultipartEventBus.addListener(Object, Class, EventListener).

Parameters:

bus - The event bus to register with. This is shorthand for holder.getContainer().getEventBus()

onRemoved

public void onRemoved()

onPlacedBy

public void onPlacedBy(PlayerEntity player,
 Hand hand)

Open method, that's designed to be called from the Item that places this part into the world.

(Nothing calls this by default, as all parts are placed from a custom item).

onBreak

public boolean onBreak(PlayerEntity player)

Called instead of Block.onBreak(World, BlockPos, BlockState, PlayerEntity), to play the broken sound, and spawn break particles.

Returns:

True if this should prevent Block.onBreak(World, BlockPos, BlockState, PlayerEntity) from being called afterwards, false otherwise.

getClosestBlockState

protected BlockState getClosestBlockState()

Returns:

The BlockState to use for playBreakSound(), playHitSound(PlayerEntity), spawnBreakParticles(), spawnHitParticle(Direction), and calculateBreakingDelta(PlayerEntity).

playHitSound

@Environment(CLIENT)
public void playHitSound(PlayerEntity player)

Called instead of Block.onBreak(World, BlockPos, BlockState, PlayerEntity), to play the broken sound, and spawn break particles.

playBreakSound

protected void playBreakSound()

Called by default in onBreak(PlayerEntity) to play the breaking sound. The default implementation calls playBreakSound(BlockState) with getClosestBlockState().

playBreakSound

protected final void playBreakSound(BlockState blockState)

playHitSound

@Environment(CLIENT)
protected final void playHitSound(BlockState blockState)

spawnBreakingParticles

@Environment(CLIENT)
@Deprecated
public boolean spawnBreakingParticles(Direction side)

Deprecated.

This was renamed to spawnHitParticle(Direction)

Spawns a single breaking particle.

Parameters:

side - The side that was hit

Returns:

True to cancel the default breaking particle from spawning, false otherwise.

spawnHitParticle

@Environment(CLIENT)
public boolean spawnHitParticle(Direction side)

Spawns a single partial-break (hit) particle.

Parameters:

side - The side that was hit

Returns:

True to cancel the default breaking particle from spawning, false otherwise.

spawnHitParticle

@Environment(CLIENT)
protected final void spawnHitParticle(Direction side,
 BlockState state)

spawnHitParticle

@Environment(CLIENT)
protected final void spawnHitParticle(Direction side,
 BlockState state,
 @Nullable
 Identifier spriteId)

spawnHitParticle

@Environment(CLIENT)
protected final void spawnHitParticle(Direction side,
 BlockState state,
 @Nullable
 Sprite sprite)

spawnHitParticle

@Environment(CLIENT)
protected final void spawnHitParticle(Direction side,
 Box box,
 BlockState state,
 @Nullable
 Sprite sprite)

pos

protected static final double pos(World world,
 Direction side,
 Direction.Axis axis,
 double size)

spawnBreakParticles

@Environment(CLIENT)
protected void spawnBreakParticles()

Called on the client to spawn break particles. This calls spawnBreakParticles(BlockState) with getClosestBlockState() by default.

spawnBreakParticles

@Environment(CLIENT)
protected final void spawnBreakParticles(BlockState state)

spawnBreakParticles

@Environment(CLIENT)
protected final void spawnBreakParticles(BlockState state,
 @Nullable
 Identifier spriteId)

spawnBreakParticles

@Environment(CLIENT)
protected final void spawnBreakParticles(BlockState state,
 @Nullable
 Sprite sprite)

spawnSprintParticle

@Environment(CLIENT)
public boolean spawnSprintParticle(Entity sprintingEntity,
 Random entityRandom)

Spawns a single sprint particle.

Parameters:

sprintingEntity - The entity doing the sprinting.

entityRandom - The entity's random for use in particle position & velocity calculations.

Returns:

True to cancel the default sprinting particle from spawning, false otherwise.

spawnSprintParticle

@Environment(CLIENT)
protected final void spawnSprintParticle(Entity sprintingEntity,
 Random entityRandom,
 BlockState state)

spawnSprintParticle

@Environment(CLIENT)
protected final void spawnSprintParticle(Entity sprintingEntity,
 Random entityRandom,
 BlockState state,
 @Nullable
 Identifier spriteId)

spawnSprintParticle

@Environment(CLIENT)
protected final void spawnSprintParticle(Entity sprintingEntity,
 Random entityRandom,
 BlockState state,
 @Nullable
 Sprite sprite)

spawnIronGolemParticle

@Environment(CLIENT)
public boolean spawnIronGolemParticle(IronGolemEntity ironGolem,
 Random entityRandom)

Spawns a single particle for when an iron golem walks on this part.

Parameters:

ironGolem - The iron golem doing the walking.

entityRandom - The iron golem's random for use in particle position & velocity calculations.

Returns:

True to cancel the default iron golem walking particle from spawning, false otherwise.

spawnIronGolemParticle

@Environment(CLIENT)
protected final void spawnIronGolemParticle(IronGolemEntity ironGolem,
 Random entityRandom,
 BlockState state)

spawnIronGolemParticle

@Environment(CLIENT)
protected final void spawnIronGolemParticle(IronGolemEntity ironGolem,
 Random entityRandom,
 BlockState state,
 @Nullable
 Identifier spriteId)

spawnIronGolemParticle

@Environment(CLIENT)
protected final void spawnIronGolemParticle(IronGolemEntity ironGolem,
 Random entityRandom,
 BlockState state,
 @Nullable
 Sprite sprite)

onSpawnFallParticles

public boolean onSpawnFallParticles(LivingEntity fallenEntity,
 Random entityRandom)

Called on the server when an entity has fallen on this part and is attempting to spawn particles for it. This is to send packets to clients to actually spawn the particles.

Parameters:

fallenEntity - The entity that has just landed on this part.

entityRandom - The entity's random for use in particle position & velocity calculations.

Returns:

True to cancel the default fall particle from spawning, false otherwise.

sendSpawnFallParticles

protected final void sendSpawnFallParticles(Vec3d pos,
 int count)

Actually Sends the packet from the server to the clients that spawns the fall particles.

Parameters:

pos - The position of the particles to spawn.

count - The number of particles to spawn.

spawnFallParticles

@Environment(CLIENT)
protected void spawnFallParticles(Vec3d pos,
 int count)

Called on the client to spawn fall particles. By default, this calls spawnFallParticles(Vec3d, int, BlockState) with getClosestBlockState() as its BlockState parameter.

Parameters:

pos - The position of the particles to spawn.

count - The number of particles to spawn.

spawnFallParticles

@Environment(CLIENT)
protected final void spawnFallParticles(Vec3d pos,
 int count,
 BlockState state)

spawnFallParticles

@Environment(CLIENT)
protected final void spawnFallParticles(Vec3d pos,
 int count,
 BlockState state,
 @Nullable
 Identifier spriteId)

spawnFallParticles

@Environment(CLIENT)
protected final void spawnFallParticles(Vec3d pos,
 int count,
 BlockState state,
 @Nullable
 Sprite sprite)

addRequiredPart

protected final void addRequiredPart(AbstractPart required)

removeRequiredPart

protected final void removeRequiredPart(AbstractPart required)

getShape

public abstract VoxelShape getShape()

Returns:

The VoxelShape to use for calculating if this pluggable overlaps with another pluggable.

canOverlapWith

public boolean canOverlapWith(AbstractPart other)

Checks to see if this AbstractPart can overlap with the other part. Note that this is only called if the getShape() of this part intersects with the getShape() of the other part. However this is never called if the shape of one of the parts is completely contained by the shape of the other part.

This is called once for each part currently contained in a MultipartContainer in MultipartContainer.offerNewPart(MultipartCreator, boolean).

getCollisionShape

public VoxelShape getCollisionShape()

Returns:

The shape to use when solidity logic, collisions with entities, ray tracing, etc. This should always encompass getShape().

getCullingShape

public VoxelShape getCullingShape()

Returns:

The shape to use when calculating lighting and checking for opacity. This may be empty, although it should always be contained by getCollisionShape(). Generally anything that's not opaque should override this and return VoxelShapes.empty().

getOutlineShape

public VoxelShape getOutlineShape()

Returns:

The shape for rendering bounding boxes and ray tracing.

getDynamicShape

@Deprecated
public VoxelShape getDynamicShape(float partialTicks)

Deprecated.

Use (and implement) getDynamicShape(float, Vec3d) instead.

Returns:

The (potentially dynamic) shape for rendering bounding boxes and ray tracing. Unlike getOutlineShape() this is only called when rendering the box for this specific part.

getDynamicShape

public VoxelShape getDynamicShape(float partialTicks,
 Vec3d hitVec)

Parameters:

hitVec - The exact position of the main block where... oh.

Returns:

The (potentially dynamic) shape for rendering bounding boxes and ray tracing. Unlike getOutlineShape() this is only called when rendering the box for this specific part.

isBlocking

public boolean isBlocking(Direction searchDirection)

Returns:

True if this pluggable should be an obstacle for attributes with it's getShape() when searching in this particular direction.

addAllAttributes

public void addAllAttributes(AttributeList<?> list)

Offers every contained attribute to the given attribute list. NOTE: This must always use AttributeList.offer(Object, VoxelShape) with getShape() as the VoxelShape argument!

The default implementation will AttributeList.obstruct(VoxelShape) the getShape() if isBlocking(Direction) returns true, and the search direction is not null.

getPickStack

@Deprecated
public ItemStack getPickStack()

Deprecated.

Use (and implement) getPickStack(BlockHitResult) instead.

Called whenever this part is picked by the player (similar to Block.getPickStack(BlockView, BlockPos, BlockState))

Returns:

The stack that should be picked, or ItemStack.EMPTY if no stack can be picked from this part.

getPickStack

public ItemStack getPickStack(@Nullable
 BlockHitResult hitResult)

Called whenever this part is picked by the player (similar to Block.getPickStack(BlockView, BlockPos, BlockState) but with a BlockHitResult for picking pieces of parts).

Parameters:

hitResult - The hit result on the part being picked or null if being called form addDrops(DefaultedList).

Returns:

The stack that should be picked, or ItemStack.EMPTY if no stack can be picked from this part.

addDrops

public void addDrops(AbstractPart.ItemDropTarget target,
 LootContext context)

addDrops

@Deprecated
public void addDrops(DefaultedList<ItemStack> to)

Deprecated.

Replaced by addDrops(ItemDropTarget, LootContext)

afterBreak

public void afterBreak(PlayerEntity player)

Called instead of Block.afterBreak(World, PlayerEntity, BlockPos, BlockState, BlockEntity, ItemStack), except that this shouldn't drop any items, as that's handled separately.

calculateBreakingDelta

public float calculateBreakingDelta(PlayerEntity player)

Part version of AbstractBlock.calcBlockBreakingDelta(BlockState, PlayerEntity, BlockView, BlockPos).

The default implementation treats parts as equal to getClosestBlockState().

calculateBreakingDelta

public final float calculateBreakingDelta(PlayerEntity player,
 Block block)

Calculates calculateBreakingDelta(PlayerEntity) as if this part was the given block instead.

calculateBreakingDelta

public final float calculateBreakingDelta(PlayerEntity player,
 BlockState state)

Calculates calculateBreakingDelta(PlayerEntity) as if this part was the given block state instead.

calcBreakingDelta

public static float calcBreakingDelta(PlayerEntity player,
 BlockState state,
 float hardness)

Calculates calculateBreakingDelta(PlayerEntity) as if this part was the given block state instead, but using a custom hardness value.

onUse

public ActionResult onUse(PlayerEntity player,
 Hand hand,
 BlockHitResult hit)

Called whenever this part is used via AbstractBlock.onUse(BlockState, World, BlockPos, PlayerEntity, Hand, BlockHitResult).

rotate

@Deprecated
public void rotate(BlockRotation rotation)

Deprecated.

Please use the PartTransformEvent.Rotate event instead.

Called whenever BlockEntity#applyRotation(BlockRotation) or AbstractBlock.AbstractBlockState.rotate(BlockRotation) is called on the containing block.

Note: This is only called when an applied transformation consists solely of a rotate transformation.

Parameters:

rotation - A rotation. LMP never calls this with BlockRotation.NONE

mirror

@Deprecated
public void mirror(BlockMirror mirror)

Deprecated.

Please use the PartTransformEvent.Mirror event instead.

Called whenever BlockEntity#applyMirror(BlockMirror) or AbstractBlock.AbstractBlockState.mirror(BlockMirror) is called on the containing block.

Note: This is only called when an applied transformation consists solely of a mirror transformation.

Parameters:

mirror - A mirror. LMP never calls this with BlockMirror.NONE

getModelKey

@Nullable
public abstract PartModelKey getModelKey()

Called on the client for both rendering, and checking if this needs to re-render in MultipartContainer.redrawIfChanged().

This is no longer called on the server.

Returns:

The PartModelKey for the PartModelBaker to use to emit a static model. Returning null will bake nothing.