Returns the block box outline of the block at the position. If the block is air, it will return an empty box. Outline Box should be used for rendering purposes only.

outlineShape

val BlockPos.outlineShape: VoxelShape

state

val BlockPos.state: BlockState?

stateOrEmpty

val BlockPos.stateOrEmpty: BlockState

targetBlockPos

val BlockHitResult.targetBlockPos: BlockPos

Functions

anotherBedPartDirection

fun BlockState?.anotherBedPartDirection(): Direction?

anotherChestPartDirection

fun BlockState?.anotherChestPartDirection(): Direction?

aStarShortestPath

fun <T> aStarShortestPath(start: T, isGoal: Predicate<T>, neighbors: Function<T, Iterable<WeightedEdge<T>>>, heuristic: ToDoubleFunction<T>, maxIterations: Int = Int.MAX_VALUE, maxCost: Double = Double.POSITIVE_INFINITY): ShortestPath<T>?

Finds the shortest path using A* search.

canStandOn

fun BlockPos.canStandOn(): Boolean

collideBlockIntersects

inline fun AABB.collideBlockIntersects(checkCollisionShape: Boolean = true, isCorrectBlock: (Block) -> Boolean): Boolean

Check if box intersects with bounding box of specified blocks

dijkstraShortestPath

fun <T> dijkstraShortestPath(start: T, isGoal: Predicate<T>, neighbors: Function<T, Iterable<WeightedEdge<T>>>, maxIterations: Int = Int.MAX_VALUE, maxCost: Double = Double.POSITIVE_INFINITY): ShortestPath<T>?

Returns the shortest path from start to the first node where isGoal returns true.

doBreak

@JvmOverloads

fun doBreak(pos: BlockPos, immediate: Boolean = false, swingMode: SwingMode = SwingMode.DO_NOT_HIDE): Boolean

Starts breaking pos, rotating silently towards it. immediate sends start and stop at once, which only works in creative or on blocks that break instantly.

@JvmOverloads

fun doBreak(rayTraceResult: BlockHitResult, immediate: Boolean = false, swingMode: SwingMode = SwingMode.DO_NOT_HIDE)

Breaks the block

doPlacement

@JvmOverloads

fun doPlacement(pos: BlockPos, hand: InteractionHand = InteractionHand.MAIN_HAND, swingMode: SwingMode = SwingMode.DO_NOT_HIDE): Boolean

Places the item in hand at pos against a neighbouring block, rotating silently towards it.

@JvmOverloads

fun doPlacement(hitResult: BlockHitResult, rotation: Rotation, hand: InteractionHand = InteractionHand.MAIN_HAND, onPlacementSuccess: () -> Boolean = { true }, onItemUseSuccess: () -> Boolean = { true }, swingMode: SwingMode = SwingMode.DO_NOT_HIDE)

Simulated net.minecraft.world.phys.HitResult.Type.BLOCK branch in vanilla

fallDamageMultiplier

fun BlockPos?.fallDamageMultiplier(entity: Entity): Float

fun Block?.fallDamageMultiplier(entity: Entity): Float

getBlock

fun BlockPos.getBlock(): Block?

getBlockingEntities

fun BlockPos.getBlockingEntities(except: Entity? = null, box: AABB = FULL_BOX, predicate: Predicate<Entity> = Predicates.alwaysTrue()): List<Entity>

getCenterDistanceSquared

fun BlockPos.getCenterDistanceSquared(): Double

getCenterDistanceSquaredEyes

fun BlockPos.getCenterDistanceSquaredEyes(): Double

getPotentialSecondBedBlock

fun AbstractBedBlock.getPotentialSecondBedBlock(state: BlockState, pos: BlockPos): BlockPos

Returns the second bed block position that might not exist (normally beds are two blocks long tho).

getSortedSphere

fun BlockPos.getSortedSphere(radius: Float): Array<BlockPos>

hasAnySolidPlacementNeighbor

fun BlockPos.hasAnySolidPlacementNeighbor(): Boolean

isBlastResistant

fun BlockPos.isBlastResistant(): Boolean

isBlockAtPosition

inline fun AABB.isBlockAtPosition(isCorrectBlock: (Block?) -> Boolean): Boolean

Check if box is reaching of specified blocks

isBlockedByEntitiesReturnCrystal

fun BlockPos.isBlockedByEntitiesReturnCrystal(except: Entity? = null, box: AABB = FULL_BOX, excludeIds: IntCollection? = null, buildingOnly: Boolean = true): BooleanObjectPair<EndCrystal?>

Checks whether the position is blocked for placing a block and returns a blocking end crystal if present.

isBreakable

fun BlockState.isBreakable(pos: BlockPos): Boolean

isCharged

fun RespawnAnchorBlock.isCharged(state: BlockState): Boolean

isInteractable

fun Block?.isInteractable(blockState: BlockState?): Boolean

Checks if the block can be interacted with, null will be returned as not interactable. The blockState is optional but can make the result more accurate, if not provided it will just assume the block is interactable.

isNotBreakable

fun BlockState.isNotBreakable(pos: BlockPos): Boolean

isUnobstructed

fun BlockPos.isUnobstructed(except: Entity? = null, box: AABB = FULL_BOX, predicate: Predicate<Entity> = Predicates.alwaysTrue()): Boolean

Checks whether the position is unobstructed for placing a block.

outlineBox

fun BlockState.outlineBox(blockPos: BlockPos): AABB

outlineShape

fun BlockPos.outlineShape(collisionContext: CollisionContext): VoxelShape

raycast

fun BlockGetter.raycast(context: ClipContext, exclude: Collection<BlockPos>?, include: BlockPos?, maxBlastResistance: Float?): BlockHitResult

Basically BlockGetter.raycast but this method allows us to exclude blocks using exclude.

searchBedLayer

fun BlockPos.searchBedLayer(state: BlockState, layers: Int): Sequence<IntLongPair>

Scan blocks outwards from a bed

searchBlocksInCuboid

fun Vec3.searchBlocksInCuboid(radius: Float, filter: BiPredicate<BlockPos, BlockState>): List<Pair<BlockPos, BlockState>>

Scan blocks around the position in a cuboid with filtering.

searchBlocksInRangeSorted

fun Vec3.searchBlocksInRangeSorted(range: Float, shapeGetter: ClipContext.ShapeGetter = ClipContext.Block.OUTLINE, collisionContext: CollisionContext = CollisionContext.of(player), filter: BiPredicate<BlockPos, BlockState>): List<Pair<BlockPos, BlockState>>

Scan blocks around the position in a cuboid, filtered and sorted by shape distance from this Vec3. Distance calculation is based on outline shape: shapeGetter.get(state, level, pos, collisionContext).move(pos).distanceToSqr(eyesPos).

searchLayer

fun BlockPos.searchLayer(layers: Int, vararg directions: Direction): Sequence<IntLongPair>

Scan blocks outwards from center along given directions, up to layers

toBlockPos

fun Vec3i.toBlockPos(): BlockPos