Skip to content
On this page

Interface: HexTraversable<T>

Type parameters

NameType
Textends Hex

Hierarchy

Implemented by

Table of contents

Properties

Methods

Properties

size

Readonly size: number

Inherited from

HexStore.size

Defined in

grid/types.ts:45

Methods

createHex

createHex(coordinates?): T

Parameters

NameType
coordinates?HexCoordinates

Returns

T

Defined in

grid/types.ts:69


getHex

getHex(coordinates): undefined | T

Parameters

NameType
coordinatesHexCoordinates

Returns

undefined | T

Inherited from

HexStore.getHex

Defined in

grid/types.ts:46


hasHex

hasHex(hex): boolean

Parameters

NameType
hexT

Returns

boolean

Inherited from

HexStore.hasHex

Defined in

grid/types.ts:47


setHexes

setHexes(hexesOrCoordinates): HexTraversable<T>

Parameters

NameType
hexesOrCoordinatesIterable<HexCoordinates | T>

Returns

HexTraversable<T>

Inherited from

HexStore.setHexes

Defined in

grid/types.ts:48


traverse

traverse(traversers, options?): HexTraversable<T>

Parameters

NameType
traversersTraverser<T, T[]> | Traverser<T, T[]>[]
options?Object
options.bail?boolean

Returns

HexTraversable<T>

Defined in

grid/types.ts:70

traverse(hexes, options?): HexTraversable<T>

Parameters

NameType
hexesIterable<T>
options?Object
options.bail?boolean

Returns

HexTraversable<T>

Defined in

grid/types.ts:71

traverse(grid, options?): HexTraversable<T>

Parameters

NameType
gridHexTraversable<T>
options?Object
options.bail?boolean

Returns

HexTraversable<T>

Defined in

grid/types.ts:72

Released under the MIT License.