BlockPos | Kernel Extension v5.0 API

Extension of Vec3i more frequently used when a vector represents the position of a certain block in the world

since: 5.0

Hierarchy

Vec3i
- BlockPos

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BlockPos(x: number, y: number, z: number): BlockPos
new BlockPos(vec: Vec3d): BlockPos
new BlockPos(vec: Vec3i): BlockPos

Overrides Vec3i.constructor
- Defined in kex.d.ts:7501
Constructs a new BlockPos instance from three given coordinates

since
5.0

Parameters
- x: number
- y: number
- z: number
Returns BlockPos
Overrides Vec3i.constructor
- Defined in kex.d.ts:7507
Constructs a new BlockPos instance from floored coordinates of the given Vec3d

since
5.0

Parameters
- vec: Vec3d
Returns BlockPos
Overrides Vec3i.constructor
- Defined in kex.d.ts:7513
Constructs a new BlockPos instance from coordinates of the given Vec3i

since
5.0

Parameters
- vec: Vec3i
Returns BlockPos

Properties

Readonly x

x: number

Readonly y

y: number

Readonly z

z: number

Static Readonly NULL_VECTOR

NULL_VECTOR: Vec3i

new Vec3i(0, 0, 0);

since: 5.0

Static Readonly ORIGIN

ORIGIN: BlockPos

new BlockPos(0, 0, 0);

since: 5.0

Static class

class: Class<Object>

Methods

add

add(x: number, y: number, z: number): BlockPos
add(vec: Vec3i): BlockPos

- Defined in kex.d.ts:7519
since
5.0

Parameters
- x: number
- y: number
- z: number
Returns BlockPos
new BlockPos instance from the following one with given offsets
- Defined in kex.d.ts:7525
since
5.0

Parameters
- vec: Vec3i
Returns BlockPos
new BlockPos instance from the following one with given offsets as a vector

clone

clone(): any

Inherited from Vec3i.clone
- Defined in android.d.ts:81147
Returns any

compareTo

compareTo(otherVec: Vec3i): number

Inherited from Vec3i.compareTo
- Defined in kex.d.ts:7024
Implementation of java.lang.Comparable's compareTo method

since
5.0

Parameters
- otherVec: Vec3i
Returns number

crossProduct

crossProduct(vec: Vec3i): BlockPos

Overrides Vec3i.crossProduct
- Defined in kex.d.ts:7580
since
5.0

Parameters
- vec: Vec3i
Returns BlockPos

distanceSq

distanceSq(x: number, y: number, z: number): number
distanceSq(to: Vec3i): number

Inherited from Vec3i.distanceSq
- Defined in kex.d.ts:7057
since
5.0

Parameters
- x: number
- y: number
- z: number
Returns number
Inherited from Vec3i.distanceSq
- Defined in kex.d.ts:7067
since
5.0

Parameters
- to: Vec3i
Returns number

distanceSqToCenter

distanceSqToCenter(x: number, y: number, z: number): number

Inherited from Vec3i.distanceSqToCenter
- Defined in kex.d.ts:7062
since
5.0

Parameters
- x: number
- y: number
- z: number
Returns number

down

down(n?: number): BlockPos

- Defined in kex.d.ts:7544
since
5.0

Parameters
- Optional n: number
  
  offset, defaults to 1
Returns BlockPos

east

east(n?: number): BlockPos

- Defined in kex.d.ts:7568
since
5.0

Parameters
- Optional n: number
  
  offset, defaults to 1
Returns BlockPos

equals

equals(param0: any): boolean

Inherited from Vec3i.equals
- Defined in android.d.ts:81145
Parameters
- param0: any
Returns boolean

finalize

finalize(): void

Inherited from Vec3i.finalize
- Defined in android.d.ts:81153
Returns void

getClass

getClass(): Class<any>

Inherited from Vec3i.getClass
- Defined in android.d.ts:81150
Returns Class<any>

getDistance

getDistance(x: number, y: number, z: number): number

Inherited from Vec3i.getDistance
- Defined in kex.d.ts:7052
since
5.0

Parameters
- x: number
- y: number
- z: number
Returns number

getX

getX(): number

Inherited from Vec3i.getX
- Defined in kex.d.ts:7030
since
5.0

Returns number
X coordinate of the following vector

getY

getY(): number

Inherited from Vec3i.getY
- Defined in kex.d.ts:7036
since
5.0

Returns number
Y coordinate of the following vector

getZ

getZ(): number

Inherited from Vec3i.getZ
- Defined in kex.d.ts:7042
since
5.0

Returns number
Z coordinate of the following vector

hashCode

hashCode(): number

Inherited from Vec3i.hashCode
- Defined in android.d.ts:81154
Returns number

north

north(n?: number): BlockPos

- Defined in kex.d.ts:7550
since
5.0

Parameters
- Optional n: number
  
  offset, defaults to 1
Returns BlockPos

notify

notify(): void

Inherited from Vec3i.notify
- Defined in android.d.ts:81149
Returns void

notifyAll

notifyAll(): void

Inherited from Vec3i.notifyAll
- Defined in android.d.ts:81155
Returns void

offset

offset(facing: Direction, n?: number): BlockPos

- Defined in kex.d.ts:7575
since
5.0

Parameters
- facing: Direction
- Optional n: number
  
  offset, defaults to 1
Returns BlockPos
new BlockPos with given offset to given Direction

south

south(n?: number): BlockPos

- Defined in kex.d.ts:7556
since
5.0

Parameters
- Optional n: number
  
  offset, defaults to 1
Returns BlockPos

subtract

subtract(vec: Vec3i): BlockPos

- Defined in kex.d.ts:7532
since
5.0

Parameters
- vec: Vec3i
Returns BlockPos
new BlockPos instance, which as coordinates has differences of corresponding coordinates of the following BlockPos and given Vec3i

toLong

toLong(): number

- Defined in kex.d.ts:7587
since
5.0

Returns number
coordinates of the following BlockPos packed into a signed 64-bit integer

toString

toString(): string

Inherited from Vec3i.toString
- Defined in android.d.ts:81148
Returns string

up

up(n?: number): BlockPos

- Defined in kex.d.ts:7538
since
5.0

Parameters
- Optional n: number
  
  offset, defaults to 1
Returns BlockPos

wait

wait(): void
wait(param0: number): void
wait(param0: number, param1: number): void

Inherited from Vec3i.wait
- Defined in android.d.ts:81144
Returns void
Inherited from Vec3i.wait
- Defined in android.d.ts:81146
Parameters
- param0: number
Returns void
Inherited from Vec3i.wait
- Defined in android.d.ts:81152
Parameters
- param0: number
- param1: number
Returns void

west

west(n?: number): BlockPos

- Defined in kex.d.ts:7562
since
5.0

Parameters
- Optional n: number
  
  offset, defaults to 1
Returns BlockPos

Static fromLong

fromLong(serialized: number): BlockPos

- Defined in kex.d.ts:7593
since
5.0

Parameters
- serialized: number
Returns BlockPos
BlockPos from given 64-bit integer representation

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

x: number

y: number

z: number

Returns BlockPos

Parameters

vec: Vec3d

Returns BlockPos

Parameters

vec: Vec3i

Returns BlockPos

Properties

Readonly x

Readonly y

Readonly z

Static Readonly NULL_VECTOR

Static Readonly ORIGIN

Static class

Methods

add

Parameters

x: number

y: number

z: number

Returns BlockPos

Parameters

vec: Vec3i

Returns BlockPos

clone

Returns any

compareTo

Parameters

otherVec: Vec3i

Returns number

crossProduct

Parameters

vec: Vec3i

Returns BlockPos

distanceSq

Parameters

x: number

y: number

z: number

Returns number

Parameters

to: Vec3i

Returns number

distanceSqToCenter

Parameters

x: number

y: number

z: number

Returns number

down

Parameters

Optional n: number

Returns BlockPos

east

Parameters

Optional n: number

Returns BlockPos

equals

Parameters

param0: any

Returns boolean

finalize

Returns void

getClass

Returns Class<any>

getDistance

Parameters

x: number

y: number