namespaceGrid Algorithms5 functions
2D integer grids with pathfinding, FOV, flood-fill, cellular automata, and procedural fills.
datumhue.grid.new(width: integer, height: integer) -> GridCreate a zeroed width x height grid (each dimension 1..=4096).
local map = datumhue.grid.new(40, 30)
print(map.width, map.height) --> 40 30
-- Every cell starts at 0. Cells count from 0, so x runs 0..39;
-- outside the grid reads nil.
print(map:get(0, 0), map:get(39, 29), map:get(40, 0)) --> 0 0 nildatumhue.grid.light_field(width: integer, height: integer) -> LightFieldCreate a zeroed width x height light field (each dimension 1..=4096).
datumhue.grid.voronoi(width: integer, height: integer, num_cells: integer, opts?: grid.VoronoiOptions) -> grid.VoronoiCell[]Generate Voronoi hives.
-- 4 hives over a 16 x 12 grid; the seed places them the same each run.
local hives = datumhue.grid.voronoi(16, 12, 4, {
seed = 7,
distance = "manhattan",
})
local owned = 0
for _, hive in ipairs(hives) do
owned = owned + #hive.cells
end
-- Every cell belongs to exactly one hive.
print(#hives, owned) --> 4 192opts grid.VoronoiOptions options 3 keys
| Key | Type | Default | Description |
|---|---|---|---|
| distance | "euclidean" | "manhattan" | "chebyshev" | "euclidean" | Metric used to assign cells to the nearest hive. |
| seed | integer | placement draws from rng, or without it from a source that random.new streams do not affect | Seed for deterministic hive placement. |
| rng | Rng | placement follows seed, if given | Draw hive placement from this stream (advancing it). Mutually exclusive with seed. |
returns grid.VoronoiCell record 2 keys
datumhue.grid.line(x1: integer, y1: integer, x2: integer, y2: integer) -> grid.Cell[]The rasterized cells of a straight line from (x1,y1) to (x2,y2).
-- Both ends are included.
local cells = datumhue.grid.line(0, 0, 4, 2)
print(#cells) --> 5
print(cells[5].x, cells[5].y) --> 4 2returns grid.Cell record 2 keys
| Key | Type | Description |
|---|---|---|
| x | integer | Cell column. |
| y | integer | Cell row. |
datumhue.grid.distance(x1: integer, y1: integer, x2: integer, y2: integer, opts?: grid.DistanceOptions) -> numberDistance between two cells.
local distance = datumhue.grid.distance
print(distance(0, 0, 3, 4)) --> 5.0
-- Steps along rows and columns only.
print(distance(0, 0, 3, 4, { type = "manhattan" })) --> 7.0
-- A diagonal step counts as one, as a king moves in chess.
print(distance(0, 0, 3, 4, { type = "chebyshev" })) --> 4.0opts grid.DistanceOptions options 1 key
| Key | Type | Default | Description |
|---|---|---|---|
| type | "euclidean" | "manhattan" | "chebyshev" | "euclidean" | Metric used to measure the distance. |
record 5 keys
| Key | Type | Description |
|---|---|---|
| x | number | position after the step, in cells |
| y | number | position after the step, in cells |
| arrived | boolean | the target cell has been reached |
| blocked | boolean | a target is set but no path to it exists |
| stopped? | grid.AgentStop | when the walk halted before a stop_before cell: the cell and its value |
Used by: PathAgent:advance, PathAgent:drive
record 3 keys
| Key | Type | Description |
|---|---|---|
| x | integer | the halting cell |
| y | integer | the halting cell |
| value | integer | the cell's value at the halt |
Nested in: grid.AgentStep
record 2 keys
| Key | Type | Description |
|---|---|---|
| x | integer | Cell column. |
| y | integer | Cell row. |
Used by: datumhue.grid.line, Grid:find_path, Grid:field_of_view, Grid:flood_fill
Nested in: grid.VoronoiCell
options 3 keys
| Key | Type | Default | Description |
|---|---|---|---|
| x required | integer | no default | Source cell x coordinate. |
| y required | integer | no default | Source cell y coordinate. |
| score | number | 0 | Starting distance score. |
Nested in: grid.DijkstraOptions
| Value | Description |
|---|---|
"euclidean" | |
"manhattan" | |
"chebyshev" |
Nested in: grid.DistanceOptions, grid.VoronoiOptions