oskikiboy / jscoord

A coordinates library for Javascript.

JSCoord

JSCoord is a simple coordinate and map system for JS. It provides a simple API for manipulating coordinates and setting maps(limits).

JSCoord's Website. Also contains documentation :)

Basic Usage

Install JSCoord using NPM:

npm i jscoord --save

Once its installed, you can import it into your application by adding this to the top of the script:

const { JSCoord } = require("jscoord")

Or if you use Typescript/Webpack:

import JSCoord from "jscoord";

Then, to create a new JSCoord instance, use:

let coords = new JSCoord(x, y, z)

And there you have it! coords will be a new JSCoords instance. You can now mutate it using the provided methods.

Properties

.x, .y, .z

Get X, Y or Z value. Do NOT modify these variables, they can break your coordinate set.

coords.x

Methods

JSCoord provides some basic mutation methods. They can be used to modify the coordinate set in different ways.

.incrX(amount), .incrY(amount), .incrZ(amount)

Increments the specified axis by amount. If amount parameter is not provided, increments by 1.

coords.incrX(10)

.decrX(amount), .decrY(amount), .decrZ(amount)

Decrements the specified axis by amount. If amount parameter is not provided, decrements by 1.

coords.decrX(10)

.setX(val), .setY(val), .setZ(val)

Sets the axis value to val.

coords.setX(20)

.invX(), .invY(), .invZ()

"Inverts" the number, so it becomes its negative/positive version. 3 becomes -3, -3 becomes 3 and so on.

coords.invX()

.setMap(x, y, z)

Sets the maximum range for each axis. It sets the maximum to the provided number and the minimum to the negative of the provided number. Other methods will fail if they are out of range. This will fail if axis is above limit already.

coords.setMap(100, 100, 100)

.getMapJSON()

Get Map as Object.

coords.getMapJSON() // {x: 20, y: 0, z: 0}

.getMapArray()

Get Map as Array.

coords.getMapArray() // [x, y, z]

.getJSON()

Returns the X, Y and Z axis values as an object.

coords.getJSON() // {x: 20, y: 0, z: 0}

.getArray()

Returns the X, Y and Z axis values as an array. .getArray()[0] contains the X axis, .getArray()[1] the Y axis and .getArray()[2] the Z axis.

coords.getArray() // [x, y, z]

.reset()

Resets all of the X, Y and Z values to 0.

coords.reset()

.rlt(x, y, z)

Set the relativity of the current coordinates from the provided coordinate set perpective.

coords.rlt(10, 20, 30)

.getRltJSON()

Get the relativity set as an object.

coords.getRltJSON() // {x: 1, y: 2, z: 3}

.getRltArray()

Get the relativity set as an array.

coords.getRltArray() // [x, y, z]

CoordChunk

CoordChunk is another feature of JSCoord. Its basically an Array of Sets with some extra functions. When creating a CoordChunk instance, you can pass a parameter to set the maximum size of the set.

const { CoordChunk } = require("jscoord")

Or if you use Typescript/Webpack:

import { CoordChunk } from "jscoord";

Then, to create a new instance:

let chunk = new CoordChunk(10)

Properties

.limit

Maximum length of chunk. Do NOT modify this variable, it can break your coordinate set.

chunk.limit

.sets

Array in which Sets are stored. Do NOT modify this variable, it can break your coordinate set.

chunk.sets

Methods

.addSet(coords)

Add a Set to the Chunk. coords can be an Array with coordinate values ([x, y, z]) or a JSCoord instance. You can not have 2 of the same coordinate sets in the same chunk.

chunk.addSet(new JSCoord(100, 100, 100))

.getSet(coords)

Find a Set by coordinates. Throws if Set could not be found.

chunk.getSet([100, 100, 100])

.delSet(coords)

Delete a Set from the Chunk. coords can be an Array with coordinate values or a JSCoord instance. Throws if Set could not be found.

chunk.delSet([100, 100, 100])