Interface: HexTraversable<T>
Type parameters
| Name | Type |
|---|---|
T | extends Hex |
Hierarchy
HexStore<T>↳
HexTraversable
Implemented by
Table of contents
Properties
Methods
Properties
size
Readonly size: number
Inherited from
Defined in
Methods
createHex
createHex(coordinates?): T
Parameters
| Name | Type |
|---|---|
coordinates? | HexCoordinates |
Returns
T
Defined in
getHex
getHex(coordinates): undefined | T
Parameters
| Name | Type |
|---|---|
coordinates | HexCoordinates |
Returns
undefined | T
Inherited from
Defined in
hasHex
hasHex(hex): boolean
Parameters
| Name | Type |
|---|---|
hex | T |
Returns
boolean
Inherited from
Defined in
setHexes
setHexes(hexesOrCoordinates): HexTraversable<T>
Parameters
| Name | Type |
|---|---|
hexesOrCoordinates | Iterable<HexCoordinates | T> |
Returns
Inherited from
Defined in
traverse
traverse(traversers, options?): HexTraversable<T>
Parameters
| Name | Type |
|---|---|
traversers | Traverser<T, T[]> | Traverser<T, T[]>[] |
options? | Object |
options.bail? | boolean |
Returns
Defined in
traverse(hexes, options?): HexTraversable<T>
Parameters
| Name | Type |
|---|---|
hexes | Iterable<T> |
options? | Object |
options.bail? | boolean |
Returns
Defined in
traverse(grid, options?): HexTraversable<T>
Parameters
| Name | Type |
|---|---|
grid | HexTraversable<T> |
options? | Object |
options.bail? | boolean |