Package com.hammy275.immersivemc.client.immersive

Class ImmersiveLever

java.lang.Object

com.hammy275.immersivemc.client.immersive.AbstractDragImmersive

com.hammy275.immersivemc.client.immersive.ImmersiveLever

All Implemented Interfaces:

Immersive<DragImmersiveInfo,NullStorage>

public class ImmersiveLever
extends AbstractDragImmersive

Nested Class Summary

Nested classes/interfaces inherited from class com.hammy275.immersivemc.client.immersive.AbstractDragImmersive

AbstractDragImmersive.AutoDragSettings

Field Summary

Fields inherited from class com.hammy275.immersivemc.client.immersive.AbstractDragImmersive

trackedObjects

Constructor Summary

Constructors

Constructor	Description
ImmersiveLever()

Method Summary

Modifier and Type	Method	Description
protected AbstractDragImmersive.AutoDragSettings	autoDragSettings()	Configures auto-dragging.
DragImmersiveInfo	buildInfo(net.minecraft.core.BlockPos pos, net.minecraft.world.level.Level level)	Constructs a new ImmersiveInfo based on the provided block position.
@Nullable ImmersiveConfigScreenInfo	configScreenInfo()	The info needed to build a config screen button for this Immersive.
ImmersiveHandler<NullStorage>	getHandler()
protected void	hitboxDragged(DragImmersiveInfo info, int controller, int oldIndex, int newIndex)	Called whenever a drag occurs from some old hitbox index to a new one.
void	tick(DragImmersiveInfo info)	This method is called once per game tick.

Methods inherited from class com.hammy275.immersivemc.client.immersive.AbstractDragImmersive

getDragHitbox, getTrackedObjects, handleHitboxInteract, isInputHitbox, isVROnly, makeHitboxes, processStorageFromNetwork, render, shouldDisableRightClicksWhenVanillaInteractionsDisabled, shouldRender

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hammy275.immersivemc.api.client.immersive.Immersive

globalTick

Constructor Details

ImmersiveLever

public ImmersiveLever()

Method Details

hitboxDragged

protected void hitboxDragged(DragImmersiveInfo info,
 int controller,
 int oldIndex,
 int newIndex)

Description copied from class: AbstractDragImmersive

Called whenever a drag occurs from some old hitbox index to a new one. This is an ideal spot to update DragImmersiveInfo.startingHitboxIndex if not auto-dragging.

Specified by:

hitboxDragged in class AbstractDragImmersive

Parameters:

info - Info with dragging happening.

controller - Controller number that is dragging.

oldIndex - Old hitbox index. This will be -1 if starting a drag from "anywhere".

newIndex - New hitbox index. This will never be -1.

autoDragSettings

protected AbstractDragImmersive.AutoDragSettings autoDragSettings()

Description copied from class: AbstractDragImmersive

Configures auto-dragging.

• All integers in nonInteractable represent indexes into DragImmersiveInfo.hitboxes which will count for dragging but will never be passed to AbstractDragImmersive.hitboxDragged(DragImmersiveInfo, int, int, int) as either the old or new index. This is mainly intended for when you want to allow dragging between some hitboxes, but need an outer hitbox that keeps the dragging going; this function should return the index for that outer hitbox.
• makeHitboxesEveryTick determines whether AbstractDragImmersive.makeHitboxes(DragImmersiveInfo, Level) is called every tick.

Specified by:

autoDragSettings in class AbstractDragImmersive

Returns:

Whether to use auto-dragging.

tick

public void tick(DragImmersiveInfo info)

Description copied from interface: Immersive

This method is called once per game tick. This is where you should, for example, recalculate hitboxes if needed.

Specified by:

tick in interface Immersive<DragImmersiveInfo,NullStorage>

Overrides:

tick in class AbstractDragImmersive

Parameters:

info - The info being ticked.

buildInfo

public DragImmersiveInfo buildInfo(net.minecraft.core.BlockPos pos,
 net.minecraft.world.level.Level level)

Description copied from interface: Immersive

Constructs a new ImmersiveInfo based on the provided block position. It's best to calculate initial hitboxes, etc. in this method to make the Immersive available for interaction as soon as possible.

Parameters:

pos - The position of a block that matches this Immersive.

level - The level in which this info is being built.

Returns:

An instance of an ImmersiveInfo implementation with the same position as provided.

getHandler

public ImmersiveHandler<NullStorage> getHandler()

Returns:

The ImmersiveHandler this Immersive uses.

configScreenInfo

@Nullable
public @Nullable ImmersiveConfigScreenInfo configScreenInfo()

Description copied from interface: Immersive

The info needed to build a config screen button for this Immersive. If this method returns null, ImmersiveMC will not add a setting for this Immersive to its in-game configuration. Reasons to possibly return null from this method include, but are not limited to:

• This Immersive cannot be controlled via a config.
• Another mod already handles configuring this Immersive.

Returns:

An ImmersiveConfigScreenInfo instance used for ImmersiveMC to add this Immersive to its in-game configuration screens, or null if ImmersiveMC should not do so.