com.simibubi.create.foundation.utility.placement.util

Class PoleHelper<T extends java.lang.Comparable<T>>

java.lang.Object

com.simibubi.create.foundation.utility.placement.util.PoleHelper<T>

All Implemented Interfaces:

IPlacementHelper

Direct Known Subclasses:

GantryShaftBlock.PlacementHelper, PistonExtensionPoleBlock.PlacementHelper

@MethodsReturnNonnullByDefault
public abstract class PoleHelper<T extends java.lang.Comparable<T>>
extends java.lang.Object
implements IPlacementHelper

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Function<net.minecraft.block.BlockState,net.minecraft.util.Direction.Axis>	axisFunction
protected net.minecraft.state.Property<T>	property
protected java.util.function.Predicate<net.minecraft.block.BlockState>	statePredicate

Fields inherited from interface com.simibubi.create.foundation.utility.placement.IPlacementHelper

ID

Constructor Summary

Constructors

Constructor and Description
PoleHelper(java.util.function.Predicate<net.minecraft.block.BlockState> statePredicate, java.util.function.Function<net.minecraft.block.BlockState,net.minecraft.util.Direction.Axis> axisFunction, net.minecraft.state.Property<T> property)

Method Summary

Modifier and Type	Method and Description
int	attachedPoles(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.Direction direction)
PlacementOffset	getOffset(net.minecraft.entity.player.PlayerEntity player, net.minecraft.world.World world, net.minecraft.block.BlockState state, net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.BlockRayTraceResult ray)
java.util.function.Predicate<net.minecraft.block.BlockState>	getStatePredicate()
boolean	matchesAxis(net.minecraft.block.BlockState state, net.minecraft.util.Direction.Axis axis)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.simibubi.create.foundation.utility.placement.IPlacementHelper

displayGhost, getItemPredicate, getOffset, matchesItem, matchesState, orderedByDistance, orderedByDistance, orderedByDistanceExceptAxis, orderedByDistanceExceptAxis, orderedByDistanceExceptAxis, orderedByDistanceExceptAxis, orderedByDistanceOnlyAxis, orderedByDistanceOnlyAxis, renderArrow, renderArrow, renderAt

Field Detail

statePredicate

protected final java.util.function.Predicate<net.minecraft.block.BlockState> statePredicate

property

protected final net.minecraft.state.Property<T extends java.lang.Comparable<T>> property

axisFunction

protected final java.util.function.Function<net.minecraft.block.BlockState,net.minecraft.util.Direction.Axis> axisFunction

Constructor Detail

PoleHelper

public PoleHelper(java.util.function.Predicate<net.minecraft.block.BlockState> statePredicate,
                  java.util.function.Function<net.minecraft.block.BlockState,net.minecraft.util.Direction.Axis> axisFunction,
                  net.minecraft.state.Property<T> property)

Method Detail

matchesAxis

public boolean matchesAxis(net.minecraft.block.BlockState state,
                           net.minecraft.util.Direction.Axis axis)

attachedPoles

public int attachedPoles(net.minecraft.world.World world,
                         net.minecraft.util.math.BlockPos pos,
                         net.minecraft.util.Direction direction)

getStatePredicate

public java.util.function.Predicate<net.minecraft.block.BlockState> getStatePredicate()

Specified by:

getStatePredicate in interface IPlacementHelper

Returns:

a predicate that gets tested with the blockstate the player is looking at
should return true if this placement helper is active with the given blockstate

getOffset

public PlacementOffset getOffset(net.minecraft.entity.player.PlayerEntity player,
                                 net.minecraft.world.World world,
                                 net.minecraft.block.BlockState state,
                                 net.minecraft.util.math.BlockPos pos,
                                 net.minecraft.util.math.BlockRayTraceResult ray)

Specified by:

getOffset in interface IPlacementHelper

Parameters:

player - the player that activated the placement helper

world - the world that the placement helper got activated in

state - the Blockstate of the Block that the player is looking at or clicked on

pos - the position of the Block the player is looking at or clicked on

ray - the exact raytrace result

Returns:

the PlacementOffset object describing where to place the new block.
Use PlacementOffset.fail() when no new position could be found.
Use PlacementOffset.success(Vector3i) with the new BlockPos to indicate a success and call PlacementOffset.withTransform(Function) if the blocks default state has to be modified before it is placed