com.simibubi.create.foundation.utility.placement

Interface IPlacementHelper

All Known Implementing Classes:

CogwheelBlockItem.DiagonalCogHelper, CogwheelBlockItem.IntegratedLargeCogHelper, CogwheelBlockItem.IntegratedSmallCogHelper, GantryShaftBlock.PlacementHelper, PistonExtensionPoleBlock.PlacementHelper, PoleHelper

@MethodsReturnNonnullByDefault
public interface IPlacementHelper

Field Summary

Fields

Modifier and Type	Field and Description
static net.minecraft.block.BlockState	ID used as an identifier in SuperGlueHandler to skip blocks placed by helpers

Method Summary

Modifier and Type	Method and Description
default void	displayGhost(PlacementOffset offset)
java.util.function.Predicate<net.minecraft.item.ItemStack>	getItemPredicate()
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)
default 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, net.minecraft.item.ItemStack heldItem)
java.util.function.Predicate<net.minecraft.block.BlockState>	getStatePredicate()
default boolean	matchesItem(net.minecraft.item.ItemStack item)
default boolean	matchesState(net.minecraft.block.BlockState state)
static java.util.List<net.minecraft.util.Direction>	orderedByDistance(net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.vector.Vector3d hit)
static java.util.List<net.minecraft.util.Direction>	orderedByDistance(net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.vector.Vector3d hit, java.util.function.Predicate<net.minecraft.util.Direction> includeDirection)
static java.util.List<net.minecraft.util.Direction>	orderedByDistanceExceptAxis(net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.vector.Vector3d hit, net.minecraft.util.Direction.Axis axis)
static java.util.List<net.minecraft.util.Direction>	orderedByDistanceExceptAxis(net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.vector.Vector3d hit, net.minecraft.util.Direction.Axis first, net.minecraft.util.Direction.Axis second)
static java.util.List<net.minecraft.util.Direction>	orderedByDistanceExceptAxis(net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.vector.Vector3d hit, net.minecraft.util.Direction.Axis first, net.minecraft.util.Direction.Axis second, java.util.function.Predicate<net.minecraft.util.Direction> includeDirection)
static java.util.List<net.minecraft.util.Direction>	orderedByDistanceExceptAxis(net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.vector.Vector3d hit, net.minecraft.util.Direction.Axis axis, java.util.function.Predicate<net.minecraft.util.Direction> includeDirection)
static java.util.List<net.minecraft.util.Direction>	orderedByDistanceOnlyAxis(net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.vector.Vector3d hit, net.minecraft.util.Direction.Axis axis)
static java.util.List<net.minecraft.util.Direction>	orderedByDistanceOnlyAxis(net.minecraft.util.math.BlockPos pos, net.minecraft.util.math.vector.Vector3d hit, net.minecraft.util.Direction.Axis axis, java.util.function.Predicate<net.minecraft.util.Direction> includeDirection)
static void	renderArrow(net.minecraft.util.math.vector.Vector3d center, net.minecraft.util.math.vector.Vector3d target, net.minecraft.util.Direction arrowPlane)
static void	renderArrow(net.minecraft.util.math.vector.Vector3d center, net.minecraft.util.math.vector.Vector3d target, net.minecraft.util.Direction arrowPlane, double distanceFromCenter)
default void	renderAt(net.minecraft.util.math.BlockPos pos, net.minecraft.block.BlockState state, net.minecraft.util.math.BlockRayTraceResult ray, PlacementOffset offset) overwrite this method if your placement helper needs a different rendering than the default ghost state

Field Detail

ID

static final net.minecraft.block.BlockState ID

used as an identifier in SuperGlueHandler to skip blocks placed by helpers

Method Detail

getItemPredicate

java.util.function.Predicate<net.minecraft.item.ItemStack> getItemPredicate()

Returns:

a predicate that gets tested with the items held in the players hands
should return true if this placement helper is active with the given item

getStatePredicate

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

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

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)

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

getOffset

default 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,
                                  net.minecraft.item.ItemStack heldItem)

renderAt

default void renderAt(net.minecraft.util.math.BlockPos pos,
                      net.minecraft.block.BlockState state,
                      net.minecraft.util.math.BlockRayTraceResult ray,
                      PlacementOffset offset)

overwrite this method if your placement helper needs a different rendering than the default ghost state

Parameters:

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

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

ray - the exact raytrace result

offset - the PlacementOffset returned by getOffset(PlayerEntity, World, BlockState, BlockPos, BlockRayTraceResult)
the offset will always be successful if this method is called

renderArrow

static void renderArrow(net.minecraft.util.math.vector.Vector3d center,
                        net.minecraft.util.math.vector.Vector3d target,
                        net.minecraft.util.Direction arrowPlane)

renderArrow

static void renderArrow(net.minecraft.util.math.vector.Vector3d center,
                        net.minecraft.util.math.vector.Vector3d target,
                        net.minecraft.util.Direction arrowPlane,
                        double distanceFromCenter)

displayGhost

default void displayGhost(PlacementOffset offset)

orderedByDistanceOnlyAxis

static java.util.List<net.minecraft.util.Direction> orderedByDistanceOnlyAxis(net.minecraft.util.math.BlockPos pos,
                                                                              net.minecraft.util.math.vector.Vector3d hit,
                                                                              net.minecraft.util.Direction.Axis axis)

orderedByDistanceOnlyAxis

static java.util.List<net.minecraft.util.Direction> orderedByDistanceOnlyAxis(net.minecraft.util.math.BlockPos pos,
                                                                              net.minecraft.util.math.vector.Vector3d hit,
                                                                              net.minecraft.util.Direction.Axis axis,
                                                                              java.util.function.Predicate<net.minecraft.util.Direction> includeDirection)

orderedByDistanceExceptAxis

static java.util.List<net.minecraft.util.Direction> orderedByDistanceExceptAxis(net.minecraft.util.math.BlockPos pos,
                                                                                net.minecraft.util.math.vector.Vector3d hit,
                                                                                net.minecraft.util.Direction.Axis axis)

orderedByDistanceExceptAxis

static java.util.List<net.minecraft.util.Direction> orderedByDistanceExceptAxis(net.minecraft.util.math.BlockPos pos,
                                                                                net.minecraft.util.math.vector.Vector3d hit,
                                                                                net.minecraft.util.Direction.Axis axis,
                                                                                java.util.function.Predicate<net.minecraft.util.Direction> includeDirection)

orderedByDistanceExceptAxis

static java.util.List<net.minecraft.util.Direction> orderedByDistanceExceptAxis(net.minecraft.util.math.BlockPos pos,
                                                                                net.minecraft.util.math.vector.Vector3d hit,
                                                                                net.minecraft.util.Direction.Axis first,
                                                                                net.minecraft.util.Direction.Axis second)

orderedByDistanceExceptAxis

static java.util.List<net.minecraft.util.Direction> orderedByDistanceExceptAxis(net.minecraft.util.math.BlockPos pos,
                                                                                net.minecraft.util.math.vector.Vector3d hit,
                                                                                net.minecraft.util.Direction.Axis first,
                                                                                net.minecraft.util.Direction.Axis second,
                                                                                java.util.function.Predicate<net.minecraft.util.Direction> includeDirection)

orderedByDistance

static java.util.List<net.minecraft.util.Direction> orderedByDistance(net.minecraft.util.math.BlockPos pos,
                                                                      net.minecraft.util.math.vector.Vector3d hit)

orderedByDistance

static java.util.List<net.minecraft.util.Direction> orderedByDistance(net.minecraft.util.math.BlockPos pos,
                                                                      net.minecraft.util.math.vector.Vector3d hit,
                                                                      java.util.function.Predicate<net.minecraft.util.Direction> includeDirection)

matchesItem

default boolean matchesItem(net.minecraft.item.ItemStack item)

matchesState

default boolean matchesState(net.minecraft.block.BlockState state)