Modding:Coord - Revision history

Epyon at 12:26, 11 August 2025

2025-08-11T12:26:15Z

Game Hunter: drltable used

2012-03-24T22:06:47Z

drltable used

Game Hunter: /* API */ added 0.9.9.5 functions

2012-01-14T22:27:41Z

‎API: added 0.9.9.5 functions

Game Hunter: so you don't have to use huge tags for it

2011-10-19T20:39:38Z

so you don't have to use huge <font-decoration> tags for it

Game Hunter: removed 0994 warning

2011-09-05T01:52:59Z

removed 0994 warning

Tehtmi: Created page

2011-08-16T12:13:31Z

Created page

New page

{{994 modding}}

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.
{|style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=3 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Coord'''
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Integer'''
|style="vertical-align:top; padding-right: 2ex;"|x
|This is the x-coordinate of the coord. In DoomRL, x increases going from left to right, starting at 1 on the left edge of the map.
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Integer'''
|style="vertical-align:top; padding-right: 2ex;"|y
|This is the y-coordinate of the coord. In DoomRL, y increases going from top to bottom, starting at 1 on the upper edge of the map.
|}
== API ==

{|style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=2 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Coord Interface'''
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|coord.[[#coord_new|new]]('''integer''' x, '''integer''' y)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|coord.[[#coord_unm|unm]]([[Modding:Coord|Coord]] c)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|coord.[[#coord_add|add]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]] rhs)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|coord.[[#coord_sub|sub]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]] rhs)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|coord.[[#coord_mul|mul]]([[Modding:Coord|Coord]] or '''integer''' lhs, [[Modding:Coord|Coord]] or '''integer''' rhs)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''boolean'''
|coord.[[#coord_eq|eq]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]], rhs)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|coord.[[#coord_abs|abs]]([[Modding:Coord|Coord]] c)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|coord.[[#coord_sign|sign]]([[Modding:Coord|Coord]] c)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''integer'''
|coord.[[#coord_distance|distance]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''number'''
|coord.[[#coord_real_distance|real_distance]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|coord.[[#coord_random|random]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''integer''', '''integer'''
|[[Modding:Coord|Coord]]:[[#coord_get|get]]()
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string'''
|[[Modding:Coord|Coord]]:[[#coord_tostring|tostring]]()
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|[[Modding:Coord|Coord]]:[[#coord_clone|clone]]()
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
|[[Modding:Coord|Coord]]:[[#coord_random_shift|random_shift]]('''integer''' value)
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
|[[Modding:Coord|Coord]]:[[#coord_random_shifted|random_shifted]]('''integer''' value)
|}

{{Anchor|coord_new}}
;coord.new('''integer''' x, '''integer''' y) → [[Modding:Coord|Coord]]
:This creates a new coord with the given x and y.
----
{{Anchor|coord_unm}}
;coord.unm([[Modding:Coord|Coord]] c) → [[Modding:Coord|Coord]]
;-[[Modding:Coord|Coord]] c → [[Modding:Coord|Coord]]
:This creates a new coord whose coordinates are the inverse (negative) of the original coordinates.
----
{{Anchor|coord_add}}
;coord.add([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]] rhs) → [[Modding:Coord|Coord]]
;[[Modding:Coord|Coord]] lhs + [[Modding:Coord|Coord]] rhs → [[Modding:Coord|Coord]]
:This creates a new coord whose coordinates are the sums of the corresponding coordinates of ''lhs'' and ''rhs''.
----
{{Anchor|coord_sub}}
;coord.sub([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]] rhs) → [[Modding:Coord|Coord]]
;[[Modding:Coord|Coord]] lhs - [[Modding:Coord|Coord]] rhs → [[Modding:Coord|Coord]]
:This creates a new coord whose coordinates are the differences of the corresponding coordinates of ''lhs'' and ''rhs''.
----
{{Anchor|coord_mul}}
;coord.mul([[Modding:Coord|Coord]] or '''integer''' lhs, [[Modding:Coord|Coord]] or '''integer''' rhs) → [[Modding:Coord|Coord]]
;[[Modding:Coord|Coord]] or '''integer''' lhs * [[Modding:Coord|Coord]] or '''integer''' rhs → [[Modding:Coord|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.)
----
{{Anchor|coord_eq}}
;coord.eq([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]], rhs) → '''boolean'''
;[[Modding:Coord|Coord]] lhs == [[Modding:Coord|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.)
----
{{Anchor|coord_abs}}
;coord.abs([[Modding:Coord|Coord]] c) → [[Modding:Coord|Coord]]
:This creates a new coord with coordinates that are the absolute value of the corresponding original coordinates.
----
{{Anchor|coord_sign}}
;coord.sign([[Modding:Coord|Coord]] c) → [[Modding:Coord|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.
----
{{Anchor|coord_distance}}
;coord.distance([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2) → '''integer'''
:Calculates the [[distance]] between the given coords.
----
{{Anchor|coord_real_distance}}
;coord.real_distance([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2) → '''number'''
:Calculates the (approximate) Euclidean distance between the biven coords.
----
{{Anchor|coord_random}}
;coord.random([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2) → [[Modding:Coord|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''.
----
{{Anchor|coord_get}}
;[[Modding:Coord|Coord]]:get() → '''integer''', '''integer'''
:Returns the x and y coordinates of the coord (in order).
----
{{Anchor|coord_tostring}}
;[[Modding:Coord|Coord]]:tostring() → '''string'''
:Returns a string containing the x and y coordinates separated by a comma.
----
{{Anchor|coord_clone}}
;[[Modding:Coord|Coord]]:clone() → [[Modding:Coord|Coord]]
:Returns a copy of the coord.
----
{{Anchor|coord_random_shift}}
;[[Modding: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.
----
{{Anchor|coord_random_shifted}}
;[[Modding:Coord|Coord]]:random_shifted('''integer''' value) → [[Modding:Coord|Coord]]
:As random_shift, except instead of changing the existing coord, a new coord is returned.
=== Constants ===

{|style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
|colspan=3 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Constant Coords'''
|-
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|null
|style="vertical-align:top; padding-right: 2ex;"|coord.UNIT
|This is a coord with 1 in both coordinates. Be careful not to change it.
|-style="background: #333;"
|style="text-align: right; vertical-align:top; padding-right: 2ex;"|null
|style="vertical-align:top; padding-right: 2ex;"|coord.ZERO
|This is a coord with 0 in both coordinates. Be careful not to change it.
|}

@@ Line 9: / Line 9: @@
    |c2=vertical-align:top; padding:0px 2px;
    |c3=padding:0px 2px;
-   |'''Integer'''|x|This is the x-coordinate of the coord. In DoomRL, x increases going from left to right, starting at 1 on the left edge of the map.
+   |'''Integer'''|x|This is the x-coordinate of the coord. In DRL, x increases going from left to right, starting at 1 on the left edge of the map.
-   |'''Integer'''|y|This is the y-coordinate of the coord. In DoomRL, y increases going from top to bottom, starting at 1 on the upper edge of the map.
+   |'''Integer'''|y|This is the y-coordinate of the coord. In DRL, y increases going from top to bottom, starting at 1 on the upper edge of the map.
    |}}
 }}

@@ Line 4: / Line 4: @@
 Although coords are technically userdata, they can be indexed like normal tables.
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
+{{drltable|Coord|3|{{Table3Col
- ! colspan="3" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Coord'''
- {{Table3Col
    |es=background: #333;
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 3px;
@@ Line 14: / Line 12: @@
    |'''Integer'''|y|This is the y-coordinate of the coord. In DoomRL, y increases going from top to bottom, starting at 1 on the upper edge of the map.
    |}}
-|}
+}}
 == API ==
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
+{{drltable|Coord Interface|2|{{Table2Col
- ! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Coord Interface'''
- {{Table2Col
    |es=background: #333;
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
@@ Line 43: / Line 39: @@
    |[[Modding:Coord|CoordIterator]]|[[Modding:Coord|Coord]]&#058;[[#coord_around_coords|around_coords]]()
    |}}
-|}
+}}
 {{Anchor|coord_new}}

@@ Line 40: / Line 40: @@
    |'''void'''|[[Modding:Coord|Coord]]&#058;[[#coord_random_shift|random_shift]]('''integer''' value)
    |[[Modding:Coord|Coord]]|[[Modding:Coord|Coord]]&#058;[[#coord_random_shifted|random_shifted]]('''integer''' value)
    |}}
 |}
@@ Line 111: / Line 113: @@
 ;[[Modding:Coord|Coord]]&#058;random_shifted('''integer''' value) &rarr; [[Modding:Coord|Coord]]
 :As random_shift, except instead of changing the existing coord, a new coord is returned.
-=== Constants ===
+----
+{{Anchor|coord_cross_coords}}
 {|style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
 |colspan=3 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Constant Coords'''

← Older revision		Revision as of 01:52, 5 September 2011
Line 1:		Line 1:
−	~~{{994 modding}}~~
−
	Coords (short for coordinates) are used to describe positions on the map. They are also occassionally used to indicate relative positions.		Coords (short for coordinates) are used to describe positions on the map. They are also occassionally used to indicate relative positions.

@@ Line 2: / Line 2: @@
 == Properties ==
 Although coords are technically userdata, they can be indexed like normal tables.
 {|style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
-|colspan=3 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Coord'''
+{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
-|-
+ ! colspan="3" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Coord'''
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Integer'''
+ {{Table3Col
-|style="vertical-align:top; padding-right: 2ex;"|x
+  |es=background: #333;
-|This is the x-coordinate of the coord. In DoomRL, x increases going from left to right, starting at 1 on the left edge of the map.
+  |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 3px;
-|-style="background: #333;"
+  |c2=vertical-align:top; padding:0px 2px;
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''Integer'''
+  |c3=padding:0px 2px;
-|style="vertical-align:top; padding-right: 2ex;"|y
+  |'''Integer'''|x|This is the x-coordinate of the coord. In DoomRL, x increases going from left to right, starting at 1 on the left edge of the map.
-|This is the y-coordinate of the coord. In DoomRL, y increases going from top to bottom, starting at 1 on the upper edge of the map.
+  |'''Integer'''|y|This is the y-coordinate of the coord. In DoomRL, y increases going from top to bottom, starting at 1 on the upper edge of the map.
 |}
-{|style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
+{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
-|colspan=2 style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Coord Interface'''
+ ! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Coord Interface'''
-|-
+ {{Table2Col
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
+  |es=background: #333;
-|coord.[[#coord_new|new]]('''integer''' x, '''integer''' y)
+  |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
-|-style="background: #333;"
+  |c2=padding:0px 2px;
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
+  |[[Modding:Coord|Coord]]|coord.[[#coord_new|new]]('''integer''' x, '''integer''' y)
-|coord.[[#coord_unm|unm]]([[Modding:Coord|Coord]] c)
+  |[[Modding:Coord|Coord]]|coord.[[#coord_unm|unm]]([[Modding:Coord|Coord]] c)
-|-
+  |[[Modding:Coord|Coord]]|coord.[[#coord_add|add]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]] rhs)
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
+  |[[Modding:Coord|Coord]]|coord.[[#coord_sub|sub]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]] rhs)
-|coord.[[#coord_add|add]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]] rhs)
+  |[[Modding:Coord|Coord]]|coord.[[#coord_mul|mul]]([[Modding:Coord|Coord]] or '''integer''' lhs, [[Modding:Coord|Coord]] or '''integer''' rhs)
-|-style="background: #333;"
+  |'''boolean'''|coord.[[#coord_eq|eq]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]], rhs)
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
+  |[[Modding:Coord|Coord]]|coord.[[#coord_abs|abs]]([[Modding:Coord|Coord]] c)
-|coord.[[#coord_sub|sub]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]] rhs)
+  |[[Modding:Coord|Coord]]|coord.[[#coord_sign|sign]]([[Modding:Coord|Coord]] c)
-|-
+  |'''integer'''|coord.[[#coord_distance|distance]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
+  |'''number'''|coord.[[#coord_real_distance|real_distance]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
-|coord.[[#coord_mul|mul]]([[Modding:Coord|Coord]] or '''integer''' lhs, [[Modding:Coord|Coord]] or '''integer''' rhs)
+  |[[Modding:Coord|Coord]]|coord.[[#coord_random|random]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
-|-style="background: #333;"
+  |'''integer''', '''integer'''|[[Modding:Coord|Coord]]&#058;[[#coord_get|get]]()
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''boolean'''
+  |'''string'''|[[Modding:Coord|Coord]]&#058;[[#coord_tostring|tostring]]()
-|coord.[[#coord_eq|eq]]([[Modding:Coord|Coord]] lhs, [[Modding:Coord|Coord]], rhs)
+  |[[Modding:Coord|Coord]]|[[Modding:Coord|Coord]]&#058;[[#coord_clone|clone]]()
-|-
+  |'''void'''|[[Modding:Coord|Coord]]&#058;[[#coord_random_shift|random_shift]]('''integer''' value)
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
+  |[[Modding:Coord|Coord]]|[[Modding:Coord|Coord]]&#058;[[#coord_random_shifted|random_shifted]]('''integer''' value)
-|coord.[[#coord_abs|abs]]([[Modding:Coord|Coord]] c)
+  |}}
-|-style="background: #333;"
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
 |coord.[[#coord_sign|sign]]([[Modding:Coord|Coord]] c)
-|-
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''integer'''
 |coord.[[#coord_distance|distance]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
-|-style="background: #333;"
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''number'''
 |coord.[[#coord_real_distance|real_distance]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
-|-
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
 |coord.[[#coord_random|random]]([[Modding:Coord|Coord]] c1, [[Modding:Coord|Coord]] c2)
-|-style="background: #333;"
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''integer''', '''integer'''
 |[[Modding:Coord|Coord]]&#058;[[#coord_get|get]]()
-|-
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''string'''
 |[[Modding:Coord|Coord]]&#058;[[#coord_tostring|tostring]]()
-|-style="background: #333;"
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
 |[[Modding:Coord|Coord]]&#058;[[#coord_clone|clone]]()
-|-
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|'''void'''
 |[[Modding:Coord|Coord]]&#058;[[#coord_random_shift|random_shift]]('''integer''' value)
-|-style="background: #333;"
-|style="text-align: right; vertical-align:top; padding-right: 2ex;"|[[Modding:Coord|Coord]]
 |[[Modding:Coord|Coord]]&#058;[[#coord_random_shifted|random_shifted]]('''integer''' value)
 |}