Package alexiil.mc.lib.multipart.api

Interface MultipartContainer

public interface MultipartContainer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MultipartContainer.MultipartCreator
static interface	MultipartContainer.PartOffer

Field Summary

Fields

Modifier and Type	Field	Description
static Attribute<MultipartContainer>	ATTRIBUTE

Method Summary

Modifier and Type	Method	Description
default MultipartHolder	addNewPart(MultipartContainer.MultipartCreator creator)	Shorter form of offerNewPart(MultipartCreator, boolean) followed by adding the offer if it was allowed.
default MultipartHolder	addNewPart(MultipartContainer.MultipartCreator creator, boolean respectEntityBBs)	Shorter form of offerNewPart(MultipartCreator, boolean) followed by adding the offer if it was allowed.
boolean	canPlayerInteract(PlayerEntity player)
default boolean	fireEvent(MultipartEvent event)	Fires the given event on the getEventBus() via MultipartEventBus.fireEvent(MultipartEvent).
List<AbstractPart>	getAllParts()
default List<AbstractPart>	getAllParts(Predicate<AbstractPart> filter)
VoxelShape	getCollisionShape()
VoxelShape	getCurrentShape()
default DimensionType	getDimension()
MultipartEventBus	getEventBus()
default <P> P	getFirstPart(Class<P> clazz)
default <P> P	getFirstPart(Class<P> clazz, Predicate<P> filter)
default AbstractPart	getFirstPart(Predicate<AbstractPart> filter)
BlockEntity	getMultipartBlockEntity()
BlockPos	getMultipartPos()
World	getMultipartWorld()
BlockEntity	getNeighbourBlockEntity(Direction dir)
VoxelShape	getOutlineShape()
AbstractPart	getPart(long uniqueId)
default <P> List<P>	getParts(Class<P> clazz)
default <P> List<P>	getParts(Class<P> clazz, Predicate<P> filter)
MultipartPropertyContainer	getProperties()
boolean	hasTicked()
default boolean	isClientWorld()
default MultipartContainer.PartOffer	offerNewPart(MultipartContainer.MultipartCreator creator)	Offers a new part to this container, respecting nearby entities' bounding boxes.
MultipartContainer.PartOffer	offerNewPart(MultipartContainer.MultipartCreator creator, boolean respectEntityBBs)	Offers a new part to this container.
void	recalculateShape()	Recalculates getCurrentShape() and getCollisionShape().
void	redrawIfChanged()	Redraws this multipart, if any of it's parts return different AbstractPart.getModelKey().
boolean	removePart(AbstractPart part)
default <T> void	sendNetworkUpdate(T obj, NetIdDataK<T> netId, NetIdDataK.IMsgDataWriterK<T> writer)	Sends the given NetIdDataK to every player currently watching this getMultipartBlockEntity(), with a custom NetIdDataK.IMsgDataWriterK.
default <T> void	sendNetworkUpdate(T obj, NetIdTyped<T> netId)	Sends the given NetIdDataK or NetIdSignalK to every player currently watching this getMultipartBlockEntity().
<T> void	sendNetworkUpdateExcept(PlayerEntity except, T obj, NetIdDataK<T> netId, NetIdDataK.IMsgDataWriterK<T> writer)	Sends the given NetIdDataK to every player currently watching this getMultipartBlockEntity(), with a custom NetIdDataK.IMsgDataWriterK, except for the given player.
<T> void	sendNetworkUpdateExcept(PlayerEntity except, T obj, NetIdTyped<T> netId)	Sends the given NetIdDataK or NetIdSignalK to every player currently watching this getMultipartBlockEntity(), except for the given player.
default boolean	testNewPart(MultipartContainer.MultipartCreator creator)
default boolean	testNewPart(MultipartContainer.MultipartCreator creator, boolean respectEntityBBs)

Field Details

ATTRIBUTE

static final Attribute<MultipartContainer> ATTRIBUTE

Method Details

getMultipartWorld

World getMultipartWorld()

getMultipartPos

BlockPos getMultipartPos()

getMultipartBlockEntity

BlockEntity getMultipartBlockEntity()

getDimension

default DimensionType getDimension()

isClientWorld

default boolean isClientWorld()

canPlayerInteract

boolean canPlayerInteract(PlayerEntity player)

Returns:

true if the player should be able to interact with this container in GUI form. Implementors should generally check to ensure they are still present in-world.

getNeighbourBlockEntity

@Nullable
BlockEntity getNeighbourBlockEntity(Direction dir)

getAllParts

List<AbstractPart> getAllParts()

getAllParts

default List<AbstractPart> getAllParts(Predicate<AbstractPart> filter)

getParts

default <P> List<P> getParts(Class<P> clazz)

getParts

default <P> List<P> getParts(Class<P> clazz,
 Predicate<P> filter)

getFirstPart

@Nullable
default AbstractPart getFirstPart(Predicate<AbstractPart> filter)

getFirstPart

@Nullable
default <P> P getFirstPart(Class<P> clazz)

getFirstPart

@Nullable
default <P> P getFirstPart(Class<P> clazz,
 Predicate<P> filter)

getPart

@Nullable
AbstractPart getPart(long uniqueId)

Returns:

The part that has the given container-only unique ID, or null if no parts have that unique id.

offerNewPart

@Nullable
MultipartContainer.PartOffer offerNewPart(MultipartContainer.MultipartCreator creator,
 boolean respectEntityBBs)

Offers a new part to this container. Note that this can be called on the client as well as the server, however the client cannot add the resulting part offer to this container.

Parameters:

creator - The creator which can create the actual part.

respectEntityBBs - whether to respect nearby entities bounding boxes, or not

Returns:

either null (if the offered part was refused) or an offer object which lets you either add it via MultipartContainer.PartOffer.apply(), or do nothing

offerNewPart

@Nullable
default MultipartContainer.PartOffer offerNewPart(MultipartContainer.MultipartCreator creator)

Offers a new part to this container, respecting nearby entities' bounding boxes. Note that this can be called on the client as well as the server, however the client cannot add the resulting part offer to this container.

Parameters:

creator - The creator which can create the actual part.

Returns:

either null (if the offered part was refused) or an offer object which lets you either add it via MultipartContainer.PartOffer.apply(), or do nothing

addNewPart

@Nullable
default MultipartHolder addNewPart(MultipartContainer.MultipartCreator creator,
 boolean respectEntityBBs)

Shorter form of offerNewPart(MultipartCreator, boolean) followed by adding the offer if it was allowed.

Returns:

The holder for the part if it was added, or null if it was not.

addNewPart

default MultipartHolder addNewPart(MultipartContainer.MultipartCreator creator)

Shorter form of offerNewPart(MultipartCreator, boolean) followed by adding the offer if it was allowed.

Returns:

The holder for the part if it was added, or null if it was not.

testNewPart

default boolean testNewPart(MultipartContainer.MultipartCreator creator,
 boolean respectEntityBBs)

Returns:

True if the part could have been added to the container, false otherwise.

Note that this will never actually add a part to the container, so it is safe to be called on the client side.

testNewPart

default boolean testNewPart(MultipartContainer.MultipartCreator creator)

Returns:

True if the part could have been added to the container, false otherwise.

Note that this will never actually add a part to the container, so it is safe to be called on the client side.

removePart

boolean removePart(AbstractPart part)

Parameters:

part - The part to remove

Returns:

True if the part used to be contained by this container, false otherwise.

getCurrentShape

VoxelShape getCurrentShape()

Returns:

The current VoxelShape of every contained AbstractPart.getShape().

getCollisionShape

VoxelShape getCollisionShape()

Returns:

The current VoxelShape of every contained AbstractPart.getCollisionShape().

getOutlineShape

VoxelShape getOutlineShape()

Returns:

A complete VoxelShape of every contained AbstractPart.getOutlineShape()

recalculateShape

void recalculateShape()

Recalculates getCurrentShape() and getCollisionShape(). AbstractPart's should call this when their own shape changes.

sendNetworkUpdate

default <T> void sendNetworkUpdate(T obj,
 NetIdTyped<T> netId)

Sends the given NetIdDataK or NetIdSignalK to every player currently watching this getMultipartBlockEntity().

sendNetworkUpdate

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

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

sendNetworkUpdateExcept

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

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

sendNetworkUpdateExcept

<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 getMultipartBlockEntity(), with a custom NetIdDataK.IMsgDataWriterK, except for the given player.

getEventBus

MultipartEventBus getEventBus()

fireEvent

default boolean fireEvent(MultipartEvent event)

Fires the given event on the getEventBus() via MultipartEventBus.fireEvent(MultipartEvent).

Returns:

True if any listeners received the given event, false if none did. This may be useful for optimisation purposes.

See Also:

MultipartEventBus.fireEvent(MultipartEvent)

hasTicked

boolean hasTicked()

Returns:

True if PartTickEvent has been fired yet, or false if it hasn't. This is useful in cases where a part might need to do world-dependent calculations in AbstractPart.onAdded(MultipartEventBus)

getProperties

MultipartPropertyContainer getProperties()

redrawIfChanged

void redrawIfChanged()

Redraws this multipart, if any of it's parts return different AbstractPart.getModelKey().

On the server this just sends a message to inform the client to check.