Class catan.logic.EdgeMap
An associative array with hexagonal grid edges as keys.
Methods
| catan.logic.edgemap:new () | Create an empty edge map. |
| catan.logic.edgemap:get (edge) | Get the object associated with edge. |
| catan.logic.edgemap:set (edge, o) | Associate edge with some object. |
| catan.logic.edgemap:iter (f) | Iterate through all the associations. |
Methods
- catan.logic.edgemap:new ()
-
Create an empty edge map.
Returns:
-
catan.logic.EdgeMap
an empty edge map
- catan.logic.edgemap:get (edge)
-
Get the object associated with
edge.Parameters:
- edge {q=number,r=number,e='NW', 'W' or 'NE'}
Returns:
-
the object associated with
edgeUsage:
local edgemap = EdgeMap:new() local edge = {q=1, r=0, e='W'} print(edgemap:get(edge)) --> nil edgemap:set(edge, 'hah') print(edgemap:get(edge)) --> hah
- catan.logic.edgemap:set (edge, o)
-
Associate
edgewith some object. You can also remove any association withedgeby passing the valuenilas parametero.Parameters:
- edge {q=number,r=number,e='NW', 'W' or 'NE'}
- o
the object to associate
edgewith
Usage:
local edgemap = EdgeMap:new() local edge = {q=1, r=0, e='W'} print(edgemap:get(edge)) --> nil edgemap:set(edge, 'hah') print(edgemap:get(edge)) --> hah
- catan.logic.edgemap:iter (f)
-
Iterate through all the associations.
Parameters:
- f
function
the iterator that will be called
for each association, receiving as parameter the
values
q,r,eando, whereq,randeuniquely identify the edge andois the value associated with such edge. If this function returns a value different fromnilorfalse, iteration is interrupted and this value is returned immediately.
Usage:
local haystack = EdgeMap:new() -- ... local edge = haystack:iter(function (q, r, e, o) if o == 'needle' then return {q = q, r = r, e = e} end end) if edge ~= nil then print(haystack:get(edge)) --> needle end
- f
function
the iterator that will be called
for each association, receiving as parameter the
values