Difference between revisions of "Modding:Coord"

Revision as of 22:27, 14 January 2012

Coords (short for coordinates) are used to describe positions on the map. They are also occassionally used to indicate relative positions.

Properties

Although coords are technically userdata, they can be indexed like normal tables.

API

coord.new(integer x, integer y) → Coord

This creates a new coord with the given x and y.

coord.unm(Coord c) → Coord

-Coord c → Coord

This creates a new coord whose coordinates are the inverse (negative) of the original coordinates.

coord.add(Coord lhs, Coord rhs) → Coord

Coord lhs + Coord rhs → Coord

This creates a new coord whose coordinates are the sums of the corresponding coordinates of lhs and rhs.

coord.sub(Coord lhs, Coord rhs) → Coord

Coord lhs - Coord rhs → Coord

This creates a new coord whose coordinates are the differences of the corresponding coordinates of lhs and rhs.

coord.mul(Coord or integer lhs, Coord or integer rhs) → Coord

Coord or integer lhs * Coord or integer rhs → Coord

With two coords, this creates a new coord whose coordinates are the products of the corresponding coordinates of lhs and rhs. With an integer, a new coord is returned with the coordinates of the original coord scaled by the integer. (This doesn't apply to two integers.)

coord.eq(Coord lhs, Coord, rhs) → boolean

Coord lhs == Coord rhs → boolean

This determines if the given coords are coordinate-wise equal. (They might still be different objects! Beware using coords as table keys.)

coord.abs(Coord c) → Coord

This creates a new coord with coordinates that are the absolute value of the corresponding original coordinates.

coord.sign(Coord c) → Coord

This creates a new coord by applying the sign function (1 for positive, 0 for zero, -1 for negative) to each coordinate of the original coord.

coord.distance(Coord c1, Coord c2) → integer

Calculates the distance between the given coords.

coord.real_distance(Coord c1, Coord c2) → number

Calculates the (approximate) Euclidean distance between the biven coords.

coord.random(Coord c1, Coord c2) → Coord

Returns a new coord uniformly at random whose x is between the x coordinates of c1 and c2 (inclusive) and whose y is between the y coordinates of c1 and c2. The coordinates of c1 should be less than or equal to the corresponding coordinates of c2.

Coord:get() → integer, integer

Returns the x and y coordinates of the coord (in order).

Coord:tostring() → string

Returns a string containing the x and y coordinates separated by a comma.

Coord:clone() → Coord

Returns a copy of the coord.

Coord:random_shift(integer value)

Changes the coord uniformly at random to a different coord (or possibly the same coord) whose x and y are within value of the originals. value is optional; it defaults to 1.

Coord:random_shifted(integer value) → Coord

As random_shift, except instead of changing the existing coord, a new coord is returned.

Coord:cross_coords() → Coord iterator

Gives an iterator over all coords that are orthogonally adjacent to the given coord (i.e., not diagonals). This is ordered as follows: west, east, north, then south.

Coord:around_coords() → Coord iterator

Gives an iterator over all coords adjacent to the given coord. It begins at the coord above and to the left of the given coord, then follows clockwise around the given coord.

Constants