BlockPos (Forge 1.11.2 API v13.20.1.2386 mappings snapshot

java.lang.Object
- net.minecraft.util.math.Vec3i
- - net.minecraft.util.math.BlockPos

All Implemented Interfaces:

java.lang.Comparable<Vec3i>

Direct Known Subclasses:

BlockPos.MutableBlockPos, Teleporter.PortalPosition
```
public class BlockPos
extends Vec3i
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BlockPos.MutableBlockPos

static class BlockPos.PooledMutableBlockPos

Nested Classes
Modifier and Type	Class and Description
`static class`	`BlockPos.MutableBlockPos`
`static class`	`BlockPos.PooledMutableBlockPos`

Field Summary

Fields
Modifier and Type Field and Description

static BlockPos ORIGIN
An immutable block pos with zero as all coordinates.
- Fields inherited from class net.minecraft.util.math.Vec3i
  NULL_VECTOR

Fields
Modifier and Type	Field and Description
`static BlockPos`	`ORIGIN` An immutable block pos with zero as all coordinates.

Constructor Summary

Constructors
Constructor and Description
`BlockPos(double x, double y, double z)`
`BlockPos(Entity source)`
`BlockPos(int x, int y, int z)`
`BlockPos(Vec3d vec)`
`BlockPos(Vec3i source)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BlockPos`	`add(double x, double y, double z)` Add the given coordinates to the coordinates of this BlockPos
`BlockPos`	`add(int x, int y, int z)` Add the given coordinates to the coordinates of this BlockPos
`BlockPos`	`add(Vec3i vec)` Add the given Vector to this BlockPos
`BlockPos`	`crossProduct(Vec3i vec)` Calculate the cross product of this and the given Vector
`BlockPos`	`down()` Offset this BlockPos 1 block down
`BlockPos`	`down(int n)` Offset this BlockPos n blocks down
`BlockPos`	`east()` Offset this BlockPos 1 block in eastern direction
`BlockPos`	`east(int n)` Offset this BlockPos n blocks in eastern direction
`static BlockPos`	`fromLong(long serialized)` Create a BlockPos from a serialized long value (created by toLong)
`static java.lang.Iterable<BlockPos.MutableBlockPos>`	`func_191531_b(int p_191531_0_, int p_191531_1_, int p_191531_2_, int p_191531_3_, int p_191531_4_, int p_191531_5_)`
`static java.lang.Iterable<BlockPos>`	`func_191532_a(int p_191532_0_, int p_191532_1_, int p_191532_2_, int p_191532_3_, int p_191532_4_, int p_191532_5_)`
`static java.lang.Iterable<BlockPos>`	`getAllInBox(BlockPos from, BlockPos to)` Create an Iterable that returns all positions in the box specified by the given corners
`static java.lang.Iterable<BlockPos.MutableBlockPos>`	`getAllInBoxMutable(BlockPos from, BlockPos to)` Like getAllInBox but reuses a single MutableBlockPos instead.
`BlockPos`	`north()` Offset this BlockPos 1 block in northern direction
`BlockPos`	`north(int n)` Offset this BlockPos n blocks in northern direction
`BlockPos`	`offset(EnumFacing facing)` Offset this BlockPos 1 block in the given direction
`BlockPos`	`offset(EnumFacing facing, int n)` Offsets this BlockPos n blocks in the given direction
`BlockPos`	`rotate(Rotation rotationIn)`
`BlockPos`	`south()` Offset this BlockPos 1 block in southern direction
`BlockPos`	`south(int n)` Offset this BlockPos n blocks in southern direction
`BlockPos`	`subtract(Vec3i vec)` Subtract the given Vector from this BlockPos
`BlockPos`	`toImmutable()` Returns a version of this BlockPos that is guaranteed to be immutable.
`long`	`toLong()` Serialize this BlockPos into a long value
`BlockPos`	`up()` Offset this BlockPos 1 block up
`BlockPos`	`up(int n)` Offset this BlockPos n blocks up
`BlockPos`	`west()` Offset this BlockPos 1 block in western direction
`BlockPos`	`west(int n)` Offset this BlockPos n blocks in western direction

Methods inherited from class net.minecraft.util.math.Vec3i
compareTo, distanceSq, distanceSq, distanceSqToCenter, equals, getDistance, getX, getY, getZ, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail
- ORIGIN
```
public static final BlockPos ORIGIN
```
  An immutable block pos with zero as all coordinates.

Constructor Detail

BlockPos

public BlockPos(int x,
                int y,
                int z)

BlockPos

public BlockPos(double x,
                double y,
                double z)

BlockPos
```
public BlockPos(Entity source)
```

BlockPos
```
public BlockPos(Vec3d vec)
```

BlockPos
```
public BlockPos(Vec3i source)
```

Method Detail

add

public BlockPos add(double x,
                    double y,
                    double z)

Add the given coordinates to the coordinates of this BlockPos

add

public BlockPos add(int x,
                    int y,
                    int z)

Add the given coordinates to the coordinates of this BlockPos

add
```
public BlockPos add(Vec3i vec)
```
Add the given Vector to this BlockPos

subtract
```
public BlockPos subtract(Vec3i vec)
```
Subtract the given Vector from this BlockPos

up
```
public BlockPos up()
```
Offset this BlockPos 1 block up

up
```
public BlockPos up(int n)
```
Offset this BlockPos n blocks up

down
```
public BlockPos down()
```
Offset this BlockPos 1 block down

down
```
public BlockPos down(int n)
```
Offset this BlockPos n blocks down

north
```
public BlockPos north()
```
Offset this BlockPos 1 block in northern direction

north
```
public BlockPos north(int n)
```
Offset this BlockPos n blocks in northern direction

south
```
public BlockPos south()
```
Offset this BlockPos 1 block in southern direction

south
```
public BlockPos south(int n)
```
Offset this BlockPos n blocks in southern direction

west
```
public BlockPos west()
```
Offset this BlockPos 1 block in western direction

west
```
public BlockPos west(int n)
```
Offset this BlockPos n blocks in western direction

east
```
public BlockPos east()
```
Offset this BlockPos 1 block in eastern direction

east
```
public BlockPos east(int n)
```
Offset this BlockPos n blocks in eastern direction

offset
```
public BlockPos offset(EnumFacing facing)
```
Offset this BlockPos 1 block in the given direction

offset

public BlockPos offset(EnumFacing facing,
                       int n)

Offsets this BlockPos n blocks in the given direction

rotate

public BlockPos rotate(Rotation rotationIn)

crossProduct
```
public BlockPos crossProduct(Vec3i vec)
```
Calculate the cross product of this and the given Vector

Overrides:

crossProduct in class Vec3i

toLong
```
public long toLong()
```
Serialize this BlockPos into a long value

fromLong
```
public static BlockPos fromLong(long serialized)
```
Create a BlockPos from a serialized long value (created by toLong)

getAllInBox

public static java.lang.Iterable<BlockPos> getAllInBox(BlockPos from,
                                                       BlockPos to)

Create an Iterable that returns all positions in the box specified by the given corners

func_191532_a

public static java.lang.Iterable<BlockPos> func_191532_a(int p_191532_0_,
                                                         int p_191532_1_,
                                                         int p_191532_2_,
                                                         int p_191532_3_,
                                                         int p_191532_4_,
                                                         int p_191532_5_)

toImmutable
```
public BlockPos toImmutable()
```
Returns a version of this BlockPos that is guaranteed to be immutable.
When storing a BlockPos given to you for an extended period of time, make sure you use this in case the value is changed internally.

getAllInBoxMutable

public static java.lang.Iterable<BlockPos.MutableBlockPos> getAllInBoxMutable(BlockPos from,
                                                                              BlockPos to)

Like getAllInBox but reuses a single MutableBlockPos instead. If this method is used, the resulting BlockPos instances can only be used inside the iteration loop.

func_191531_b

public static java.lang.Iterable<BlockPos.MutableBlockPos> func_191531_b(int p_191531_0_,
                                                                         int p_191531_1_,
                                                                         int p_191531_2_,
                                                                         int p_191531_3_,
                                                                         int p_191531_4_,
                                                                         int p_191531_5_)

Class BlockPos

Nested Class Summary

Field Summary

Fields inherited from class net.minecraft.util.math.Vec3i

Constructor Summary

Method Summary

Methods inherited from class net.minecraft.util.math.Vec3i

Methods inherited from class java.lang.Object

Field Detail

ORIGIN

Constructor Detail

BlockPos

BlockPos

BlockPos

BlockPos

BlockPos

Method Detail

add

add

add

subtract

up

up

down

down

north

north

south

south

west

west

east

east

offset

offset

rotate

crossProduct

toLong

fromLong

getAllInBox

func_191532_a

toImmutable

getAllInBoxMutable

func_191531_b