Skip to main content

CoordinatesMetatable


Clone(self) → a

Makes a copy of the coordinates.

It has no parameters.

The only return is a copy of the coordinates. It is a Coordinates.


CoordStringWithoutPlanet(self) → a

Returns a string representation of the coordinates without the planet.

It has no parameters.

The only return is a string representation of the coordinates without the planet. It is a string.


GetRandom(self) → a

Returns a Random object seeded with the coordinates.

It has no parameters.

The only return is a Random.


GetSeed(self) → a

Returns the seed for the coordinates, which is used to generate region.

It has no parameters.

The only return is a number.


ToArray(self) → a

Converts the coordinates to an array representation.

local coordinate = require("coordinate")
local coordinates = coordinate.new(0, 0, 0, 0, false)
local array = coordinates:ToArray() -- {0, 0, 0, 0, false}

It has no parameters.

The only return is an array representation of the coordinates. It can be any of the following types:

  • number
  • boolean

__add(self, a) → a

The only parameter is a Coordinates.

The only return is a Coordinates.


__div(self, a) → a

The only parameter is a Coordinates.

The only return is a Coordinates.


__eq(self, a) → a

The only parameter is a Coordinates.

The only return is a boolean.


__index

It is of the type CoordinatesMetatable.


__mul(self, a) → a

The only parameter is a Coordinates.

The only return is a Coordinates.


__tostring(self) → a

It has no parameters.

The only return is a string.


type

It is always the string Coordinates.

Luau Type

This is the luau type for CoordinatesMetatable. It may help clear up mistranslations from the raw data to the wiki page (as it is an automatic process).

type CoordinatesMetatable = {
type: "Coordinates",
__eq: (self: Coordinates, Coordinates) -> (boolean),
__mul: (self: Coordinates, Coordinates) -> (Coordinates),
ToArray: (self: Coordinates) -> ({ number | boolean }),
__add: (self: Coordinates, Coordinates) -> (Coordinates),
__div: (self: Coordinates, Coordinates) -> (Coordinates),
Clone: (self: Coordinates) -> (Coordinates),
GetRandom: (self: Coordinates) -> (Random),
GetSeed: (self: Coordinates) -> (number),
CoordStringWithoutPlanet: (self: Coordinates) -> (string),
__index: CoordinatesMetatable,
__tostring: (self: Coordinates) -> (string),
}