pyhexlib package

class pyhexlib.AxialCoordinate(r, q)

Bases: tuple

q

Alias for field number 1

r

Alias for field number 0

class pyhexlib.Direction(value)[source]

Bases: Enum

An enumeration.

EAST = 'East'
NORTH = 'North'
NORTHEAST = 'Northeast'
NORTHWEST = 'Northwest'
SOUTH = 'South'
SOUTHEAST = 'Southeast'
SOUTHWEST = 'Southwest'
WEST = 'West'
class pyhexlib.Orientation(value)[source]

Bases: Enum

An enumeration.

FLAT = 'Flat Top'
POINTY = 'Pointy Top'
pyhexlib.get_config()[source]
Return type:

Dict[str, Any]

pyhexlib.init(settings=None, *, orientation=Orientation.FLAT, scale=(1.0, 1.0), log_level=None)[source]
Parameters:
  • settings (Dict[str, Any] | None)

  • orientation (Orientation)

  • scale (Tuple[float, float])

  • log_level (int | None)

Return type:

Dict[str, Any]

pyhexlib.is_initialized()[source]
Return type:

bool

Submodules