Class WorldPosition

A class that represents a location and rotation in the world, with optional dimension, entity, and block to be linked to it, and an options for where to send errors.

Todo

Add documentation.

Index

Constructors

constructor

new WorldPosition(
    location: Vector3,
    rotation: Vector2,
    dimension?: string | Dimension | DimensionType,
    entity?: Entity | Player,
    block?: Block,
    sendErrorsTo?: any,
): Globals.modules.coords.WorldPosition
Parameters
- location: Vector3
- rotation: Vector2
- Optionaldimension: string | Dimension | DimensionType
- Optionalentity: Entity | Player
- Optionalblock: Block
- OptionalsendErrorsTo: any
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:25

Properties

`Optional`block

block?: Block

`Optional`dimension

dimension?: Dimension

`Optional`entity

entity?: Entity

rotx

rotx: number

roty

roty: number

`Optional`sendErrorsTo

sendErrorsTo?: any

x

x: number

y

y: number

z

z: number

Accessors

directionvector

get directionvector(): Vector3
Returns Vector3
- Defined in modules/coordinates/classes/WorldPosition.ts:53

location

get location(): Vector3
Returns Vector3
- Defined in modules/coordinates/classes/WorldPosition.ts:38
set location(location: Vector3): void
Parameters
- location: Vector3
Returns void
- Defined in modules/coordinates/classes/WorldPosition.ts:56

locationrotation

get locationrotation(): RotationLocation
Returns RotationLocation
- Defined in modules/coordinates/classes/WorldPosition.ts:50

locationstring

get locationstring(): string
Returns string
- Defined in modules/coordinates/classes/WorldPosition.ts:41

rotation

get rotation(): Vector2
Returns Vector2
- Defined in modules/coordinates/classes/WorldPosition.ts:44
set rotation(rotation: Vector2): void
Parameters
- rotation: Vector2
Returns void
- Defined in modules/coordinates/classes/WorldPosition.ts:61

rotationstring

get rotationstring(): string
Returns string
- Defined in modules/coordinates/classes/WorldPosition.ts:47

Methods

align

align(axis: string): Globals.modules.coords.WorldPosition
Parameters
- axis: string
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:222

anchored

anchored(anchor: string): Globals.modules.coords.WorldPosition
Parameters
- anchor: string
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:191

as

as(target: string | Player[] | Entity[]): Globals.modules.coords.WorldPosition[]
Parameters
- target: string | Player[] | Entity[]
Returns Globals.modules.coords.WorldPosition[]
- Defined in modules/coordinates/classes/WorldPosition.ts:123

asblock

asblock(block: DimensionLocation | Block): Globals.modules.coords.WorldPosition
Parameters
- block: DimensionLocation | Block
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:130

at

at(target: string | Player[] | Entity[]): Globals.modules.coords.WorldPosition[]
Parameters
- target: string | Player[] | Entity[]
Returns Globals.modules.coords.WorldPosition[]
- Defined in modules/coordinates/classes/WorldPosition.ts:78

clearSendErrorsTo

clearSendErrorsTo(): Globals.modules.coords.WorldPosition
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:115

facing

facing(location: Vector3): Globals.modules.coords.WorldPosition
Parameters
- location: Vector3
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:199

facingEntity

facingEntity(
target: string | Player[] | Entity[],
): Globals.modules.coords.WorldPosition[]
Parameters
- target: string | Player[] | Entity[]
Returns Globals.modules.coords.WorldPosition[]
- Defined in modules/coordinates/classes/WorldPosition.ts:203

in

in(
dimension?: string | Dimension | DimensionType,
): Globals.modules.coords.WorldPosition
Parameters
- Optionaldimension: string | Dimension | DimensionType
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:69

matchdimension

matchdimension(
target: string | Player[] | Entity[],
): Globals.modules.coords.WorldPosition[]
Parameters
- target: string | Player[] | Entity[]
Returns Globals.modules.coords.WorldPosition[]
- Defined in modules/coordinates/classes/WorldPosition.ts:172

matchlocation

matchlocation(
target: string | Player[] | Entity[],
): Globals.modules.coords.WorldPosition[]
Parameters
- target: string | Player[] | Entity[]
Returns Globals.modules.coords.WorldPosition[]
- Defined in modules/coordinates/classes/WorldPosition.ts:153

matchrotation

matchrotation(
target: string | Player[] | Entity[],
): Globals.modules.coords.WorldPosition[]
Parameters
- target: string | Player[] | Entity[]
Returns Globals.modules.coords.WorldPosition[]
- Defined in modules/coordinates/classes/WorldPosition.ts:134

offset

offset(offset: Vector3): Globals.modules.coords.WorldPosition
Parameters
- offset: Vector3
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:228

positioned

positioned(coordinateText: string): Globals.modules.coords.WorldPosition
Parameters
- coordinateText: string
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:65

resetRotation

resetRotation(): Globals.modules.coords.WorldPosition
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:195

resetSendErrorsTo

resetSendErrorsTo(): Globals.modules.coords.WorldPosition
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:119

rotated

rotated(
x: string | number,
y: string | number,
): Globals.modules.coords.WorldPosition
Parameters
- x: string | number
- y: string | number
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:73

setSendErrorsTo

setSendErrorsTo(
target: string | Player[] | Entity[],
): Globals.modules.coords.WorldPosition
Parameters
- target: string | Player[] | Entity[]
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:97

`Static`fromblock

fromblock(block: Block): Globals.modules.coords.WorldPosition
Parameters
- block: Block
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:235

`Static`fromentity

fromentity(entity: Entity | Player): Globals.modules.coords.WorldPosition
Parameters
- entity: Entity | Player
Returns Globals.modules.coords.WorldPosition
- Defined in modules/coordinates/classes/WorldPosition.ts:232

Class WorldPosition

Todo

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Globals.modules.coords.WorldPosition

Properties

Optionalblock

Optionaldimension

Optionalentity

rotx

roty

OptionalsendErrorsTo

x

y

z

Accessors

directionvector

Returns Vector3

location

Returns Vector3

Parameters

Returns void

locationrotation

Returns RotationLocation

locationstring

Returns string

rotation

Returns Vector2

Parameters

Returns void

rotationstring

Returns string

Methods

align

Parameters

Returns Globals.modules.coords.WorldPosition

anchored

Parameters

Returns Globals.modules.coords.WorldPosition

as

Parameters

Returns Globals.modules.coords.WorldPosition[]

asblock

Parameters

Returns Globals.modules.coords.WorldPosition

at

Parameters

Returns Globals.modules.coords.WorldPosition[]

clearSendErrorsTo

Returns Globals.modules.coords.WorldPosition

facing

Parameters

Returns Globals.modules.coords.WorldPosition

facingEntity

Parameters

Returns Globals.modules.coords.WorldPosition[]

in

Parameters

Returns Globals.modules.coords.WorldPosition

matchdimension

Parameters

Returns Globals.modules.coords.WorldPosition[]

matchlocation

Parameters

Returns Globals.modules.coords.WorldPosition[]

matchrotation

Parameters

Returns Globals.modules.coords.WorldPosition[]

offset

Parameters

Returns Globals.modules.coords.WorldPosition

positioned

Parameters

Returns Globals.modules.coords.WorldPosition

`Optional`block

`Optional`dimension

`Optional`entity

`Optional`sendErrorsTo

`Static`fromblock

`Static`fromentity