Class BlockBasedImmersiveBuilderImpl<E, ER, S extends NetworkStorage>

java.lang.Object

com.hammy275.immersivemc.client.immersive.BlockBasedImmersiveBuilderImpl<E,ER,S>

All Implemented Interfaces:

BlockBasedImmersiveBuilder<E,ER,S>

public class BlockBasedImmersiveBuilderImpl<E, ER, S extends NetworkStorage>
extends Object
implements BlockBasedImmersiveBuilder<E,ER,S>

Constructor Summary

Constructors

Constructor	Description
BlockBasedImmersiveBuilderImpl(BlockBasedImmersiveHandler<S> handler, @Nullable Class<E> extraInfoDataClazz, @Nullable Class<ER> extraInfoDataRenderStateClazz, @Nullable BiConsumer<BuiltBlockBasedImmersiveInfo<E>, ER> extraInfoDataRenderStateExtractor)

Method Summary

Modifier and Type	Method	Description
BlockBasedImmersiveBuilder<E,ER,S>	add3x3Grid(RelativeHitboxInfo relativeHitboxInfo, double distBetweenBoxes)	Adds a 3x3 grid of hitboxes, such as for the crafting table.
BlockBasedImmersiveBuilder<E,ER,S>	addHitbox(RelativeHitboxInfo relativeHitboxInfo)	Adds a hitbox.
BuiltBlockBasedImmersiveImpl<E,ER,S>	build()	Builds this Immersive.
<T extends NetworkStorage> BlockBasedImmersiveBuilderImpl<E,ER,T>	copy(BlockBasedImmersiveHandler<T> newHandler)	Create a copy of this ImmersiveBuilder, setting the extra storage consumer to null.
<F, FR, T extends NetworkStorage> BlockBasedImmersiveBuilderImpl<F,FR,T>	copy(BlockBasedImmersiveHandler<T> newHandler, Class<F> newExtraInfoDataClass, Class<FR> newExtraInfoDataRenderStateClass, BiConsumer<BuiltBlockBasedImmersiveInfo<F>, FR> newExtraInfoDataRenderStateExtractor)	Create a copy of this ImmersiveBuilder, setting the extra storage consumer, the extra render ready, the slot active function, the on remove function, the slot renders item guide function, the right click handler, and the Immersive config info to null/no-op on the copy.
BlockBasedImmersiveBuilder<E,ER,S>	modifyHitbox(int index, Function<RelativeHitboxInfoBuilder, RelativeHitboxInfo> modifier)	Modify a hitbox.
BlockBasedImmersiveBuilder<E,ER,S>	modifyHitboxes(int startIndex, int endIndex, Function<RelativeHitboxInfoBuilder, RelativeHitboxInfo> modifier)	Modify a range of hitboxes, inclusive for both ends.
BlockBasedImmersiveBuilder<E,ER,S>	overwriteHitbox(int index, RelativeHitboxInfo relativeHitboxInfo)	Overwrites hitbox at index with a new hitbox.
BlockBasedImmersiveBuilder<E,ER,S>	setConfigScreenInfo(ImmersiveConfigScreenInfo info)	Set the config screen info associated with this Immersive.
BlockBasedImmersiveBuilder<E,ER,S>	setDragHitboxCreator(@Nullable Function<BuiltBlockBasedImmersiveInfo<E>, net.minecraft.world.phys.AABB> dragHitboxCreator)	Sets the function used to generate the drag hitbox.
BlockBasedImmersiveBuilder<E,ER,S>	setExtraRenderer(ExtraRenderer<ER> renderer)	Set an extra function to run when rendering.
BlockBasedImmersiveBuilder<E,ER,S>	setExtraStorageConsumer(BiConsumer<S, BuiltBlockBasedImmersiveInfo<E>> storageConsumer)	Sets a consumer that acts after an incoming NetworkStorage is parsed.
BlockBasedImmersiveBuilder<E,ER,S>	setHitboxInteractHandler(HitboxInteractHandler<E> handler)	Sets what should happen when a hitbox is interacted with.
BlockBasedImmersiveBuilder<E,ER,S>	setOnRemove(Consumer<BuiltBlockBasedImmersiveInfo<E>> onRemove)	Set function to run on an info before it's removed.
BlockBasedImmersiveBuilder<E,ER,S>	setPositioningMode(HitboxPositioningMode newMode)	Sets the way hitboxes are positioned on the block.
BlockBasedImmersiveBuilder<E,ER,S>	setRenderSize(float size)	Sets the size for items rendered by this immersive.
BlockBasedImmersiveBuilder<E,ER,S>	setShouldRenderItemGuideFunction(BiFunction<BuiltBlockBasedImmersiveRenderState<ER>, Integer, Boolean> itemGuideActive)	Set whether the item guide for this slot should be active.
BlockBasedImmersiveBuilder<E,ER,S>	setSlotActiveFunction(BiFunction<BuiltBlockBasedImmersiveInfo<E>, Integer, Boolean> slotActive)	Sets a function that determines whether a given slot should be active (rendered, reacts to interactions, etc.).
BlockBasedImmersiveBuilder<E,ER,S>	setVROnly(boolean vrOnly)	Sets whether this immersive is only for VR users.
BlockBasedImmersiveBuilder<E,ER,S>	shouldDisableRightClicksWhenInteractionsDisabled(boolean doDisable)	Set whether to disable right-click interactions on this immersive when the option to disable said interactions is enabled.

Methods inherited from class Object

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

Methods inherited from interface BlockBasedImmersiveBuilder

setNoDragHitbox

Constructor Details

BlockBasedImmersiveBuilderImpl

public BlockBasedImmersiveBuilderImpl(BlockBasedImmersiveHandler<S> handler,
 @Nullable
 @Nullable Class<E> extraInfoDataClazz,
 @Nullable
 @Nullable Class<ER> extraInfoDataRenderStateClazz,
 @Nullable
 @Nullable BiConsumer<BuiltBlockBasedImmersiveInfo<E>, ER> extraInfoDataRenderStateExtractor)

Method Details

setRenderSize

public BlockBasedImmersiveBuilder<E,ER,S> setRenderSize(float size)

Sets the size for items rendered by this immersive.

Specified by:

setRenderSize in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

size - The size of the item when rendering.

Returns:

Builder object.

addHitbox

public BlockBasedImmersiveBuilder<E,ER,S> addHitbox(RelativeHitboxInfo relativeHitboxInfo)

Adds a hitbox. Note that item hitboxes MUST be added in slot-order. Aka, the underlying block's slot 0 should be added before its slot 1, etc.

Specified by:

addHitbox in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

relativeHitboxInfo - HitboxInfo to add. Can use HitboxInfoBuilder to make it easier to create.

Returns:

Builder object.

add3x3Grid

public BlockBasedImmersiveBuilder<E,ER,S> add3x3Grid(RelativeHitboxInfo relativeHitboxInfo,
 double distBetweenBoxes)

Adds a 3x3 grid of hitboxes, such as for the crafting table. Adds the top row from left to right, then the middle row from left to right, then the bottom row from left to right.

Specified by:

add3x3Grid in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

relativeHitboxInfo - HitboxInfo for center box. Can use HitboxInfoBuilder to make it easier to create.

distBetweenBoxes - Distance between boxes.

Returns:

Builder object.

setPositioningMode

public BlockBasedImmersiveBuilder<E,ER,S> setPositioningMode(HitboxPositioningMode newMode)

Sets the way hitboxes are positioned on the block.

Specified by:

setPositioningMode in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

newMode - New mode for positioning.

Returns:

Builder object.

setHitboxInteractHandler

public BlockBasedImmersiveBuilder<E,ER,S> setHitboxInteractHandler(HitboxInteractHandler<E> handler)

Sets what should happen when a hitbox is interacted with.

Specified by:

setHitboxInteractHandler in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

handler - Function that takes an info instance, a player doing the interaction, the slot being interacted with, and the hand being interacted with. This function should return a number denoting the cooldown until the user can interact with Immersives again, or a negative number to denote that no interaction took place.

Returns:

Builder object.

setVROnly

public BlockBasedImmersiveBuilder<E,ER,S> setVROnly(boolean vrOnly)

Sets whether this immersive is only for VR users.

Specified by:

setVROnly in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

vrOnly - Whether this immersive should now be VR only.

Returns:

Builder object.

setExtraStorageConsumer

public BlockBasedImmersiveBuilder<E,ER,S> setExtraStorageConsumer(BiConsumer<S, BuiltBlockBasedImmersiveInfo<E>> storageConsumer)

Sets a consumer that acts after an incoming NetworkStorage is parsed. For example, this is used for the anvil to retrieve the level amount and store it in extra data.

Specified by:

setExtraStorageConsumer in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

storageConsumer - New storage consumer.

Returns:

Builder object.

setSlotActiveFunction

public BlockBasedImmersiveBuilder<E,ER,S> setSlotActiveFunction(BiFunction<BuiltBlockBasedImmersiveInfo<E>, Integer, Boolean> slotActive)

Sets a function that determines whether a given slot should be active (rendered, reacts to interactions, etc.).

Specified by:

setSlotActiveFunction in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

slotActive - Function that takes an info instance and a slot number and returns whether the slot is active.

Returns:

Builder object.

setOnRemove

public BlockBasedImmersiveBuilder<E,ER,S> setOnRemove(Consumer<BuiltBlockBasedImmersiveInfo<E>> onRemove)

Set function to run on an info before it's removed.

Specified by:

setOnRemove in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

onRemove - Function to run on info just before removal.

Returns:

Builder object.

shouldDisableRightClicksWhenInteractionsDisabled

public BlockBasedImmersiveBuilder<E,ER,S> shouldDisableRightClicksWhenInteractionsDisabled(boolean doDisable)

Set whether to disable right-click interactions on this immersive when the option to disable said interactions is enabled.

Specified by:

shouldDisableRightClicksWhenInteractionsDisabled in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

doDisable - Whether to disable as described above.

Returns:

Builder object.

setShouldRenderItemGuideFunction

public BlockBasedImmersiveBuilder<E,ER,S> setShouldRenderItemGuideFunction(BiFunction<BuiltBlockBasedImmersiveRenderState<ER>, Integer, Boolean> itemGuideActive)

Set whether the item guide for this slot should be active. This result is AND'd with the built-in checker, which is simply if the slot holds items but currently isn't holding one.

Specified by:

setShouldRenderItemGuideFunction in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

itemGuideActive - Function that returns whether the given slot is active given the info.

Returns:

Builder object.

setConfigScreenInfo

public BlockBasedImmersiveBuilder<E,ER,S> setConfigScreenInfo(ImmersiveConfigScreenInfo info)

Description copied from interface: BlockBasedImmersiveBuilder

Set the config screen info associated with this Immersive.

Specified by:

setConfigScreenInfo in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

info - The config screen info to associate with this Immersive.

Returns:

Builder object.

setExtraRenderer

public BlockBasedImmersiveBuilder<E,ER,S> setExtraRenderer(ExtraRenderer<ER> renderer)

Description copied from interface: BlockBasedImmersiveBuilder

Set an extra function to run when rendering.

Specified by:

setExtraRenderer in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

renderer - Extra function to run when rendering, taking the info and the light for the Immersive.

Returns:

Builder object.

overwriteHitbox

public BlockBasedImmersiveBuilder<E,ER,S> overwriteHitbox(int index,
 RelativeHitboxInfo relativeHitboxInfo)

Overwrites hitbox at index with a new hitbox. Useful when cloning.

Specified by:

overwriteHitbox in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

index - Index to overwrite.

relativeHitboxInfo - New hitbox information.

Returns:

Builder object.

modifyHitbox

public BlockBasedImmersiveBuilder<E,ER,S> modifyHitbox(int index,
 Function<RelativeHitboxInfoBuilder, RelativeHitboxInfo> modifier)

Modify a hitbox.

Specified by:

modifyHitbox in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

index - Index of hitbox to modify.

modifier - A function that takes the old hitbox as a builder and returns new hitbox info.

Returns:

Builder object.

modifyHitboxes

public BlockBasedImmersiveBuilder<E,ER,S> modifyHitboxes(int startIndex,
 int endIndex,
 Function<RelativeHitboxInfoBuilder, RelativeHitboxInfo> modifier)

Modify a range of hitboxes, inclusive for both ends.

Specified by:

modifyHitboxes in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

startIndex - Starting index of range of hitboxes to modify inclusive.

endIndex - Ending index of range of hitboxes to modify inclusive.

modifier - A function that takes the old hitbox as a builder and returns new hitbox info.

Returns:

Builder object.

setDragHitboxCreator

public BlockBasedImmersiveBuilder<E,ER,S> setDragHitboxCreator(@Nullable
 @Nullable Function<BuiltBlockBasedImmersiveInfo<E>, net.minecraft.world.phys.AABB> dragHitboxCreator)

Description copied from interface: BlockBasedImmersiveBuilder

Sets the function used to generate the drag hitbox. See Immersive.getDragHitbox(ImmersiveInfo) for info about what the drag hitbox is.

Specified by:

setDragHitboxCreator in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Parameters:

dragHitboxCreator - The drag hitbox creator or null (the default) to let ImmersiveMC generate one for you.

Returns:

Builder object.

build

public BuiltBlockBasedImmersiveImpl<E,ER,S> build()

Description copied from interface: BlockBasedImmersiveBuilder

Builds this Immersive.

Specified by:

build in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Returns:

The built Immersive from this builder.

copy

public <T extends NetworkStorage>
BlockBasedImmersiveBuilderImpl<E,ER,T> copy(BlockBasedImmersiveHandler<T> newHandler)

Create a copy of this ImmersiveBuilder, setting the extra storage consumer to null.

Specified by:

copy in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Returns:

A best-effort copy of this ImmersiveBuilder.

copy

public <F, FR, T extends NetworkStorage>
BlockBasedImmersiveBuilderImpl<F,FR,T> copy(BlockBasedImmersiveHandler<T> newHandler,
 Class<F> newExtraInfoDataClass,
 Class<FR> newExtraInfoDataRenderStateClass,
 BiConsumer<BuiltBlockBasedImmersiveInfo<F>, FR> newExtraInfoDataRenderStateExtractor)

Description copied from interface: BlockBasedImmersiveBuilder

Create a copy of this ImmersiveBuilder, setting the extra storage consumer, the extra render ready, the slot active function, the on remove function, the slot renders item guide function, the right click handler, and the Immersive config info to null/no-op on the copy.

Specified by:

copy in interface BlockBasedImmersiveBuilder<E, ER, S extends NetworkStorage>

Returns:

A best-effort copy of this ImmersiveBuilder.