Lua API
On this page

Position

Inherits from

A position represents a specific place in the game world. This includes a landblock, plus a Frame to determine its offset.

Fields:

C number

static

Frame Frame

read only

The frame position

Landcell number

The landcell

MaxCoord number

static

Constructors:

New() :

Methods:

DistanceTo2D(position: Position) : number

Get the 2D distance between two positions

Parameters:
NameTypeDefaultSummary
positionPosition

The position to get the distance to from this one

Returns:number

DistanceTo3D(position: Position) : number

Get the 3D distance between two positions

Parameters:
NameTypeDefaultSummary
positionPosition

The position to get the distance to from this one

Returns:number

EWToLandblock(landcell: number, ew: number) : number

static
Parameters:
NameTypeDefaultSummary
landcellnumber
ewnumber
Returns:number

GetLandblockFromCoordinates(EW: number, NS: number) : number

static
Parameters:
NameTypeDefaultSummary
EWnumber
NSnumber
Returns:number

GetLandblockFromCoordinates(EW: number, NS: number) : number

static
Parameters:
NameTypeDefaultSummary
EWnumber
NSnumber
Returns:number

GetPropertyKeys(source)

LandblockToEW(landcell,xOffset) landcell number , xOffset number

LandblockToNS(landcell,yOffset) landcell number , yOffset number

LandblockXDifference(originLandblock,landblock) originLandblock number , landblock number

LandblockYDifference(originLandblock,landblock) originLandblock number , landblock number

NSToLandblock(landcell,ns) landcell number , ns number

ToString()