Welt > HexWorld#
API-Referenz#
- class miniworlds.worlds.hex_world.hex_world.HexWorld(x=20, y=16, tile_size=40, empty=False)[Quellcode]#
Eine Welt, die aus sechseckigen Kacheln besteht.
Hexfelder werden mit Offset-Koordinaten
(Spalte, Zeile)angesprochen, wie Kacheln in einer TiledWorld. Ungerade Zeilen sind um ein halbes Hexfeld nach rechts verschoben (Pointy-Top-Layout). Actors können auch auf Ecken (von bis zu drei Hexfeldern geteilt) oder Kanten (von zwei Hexfeldern geteilt) platziert werden.Die sechs Nachbarn eines Hexfelds erreichst du mit den Richtungen
"o","so","sw","w","nw","no". Weil ungerade Zeilen verschoben sind, hängen die diagonalen Nachbarn von der Zeilenparität ab:Ungerade Zeilen:
"no"und"so"zeigen auf(Spalte + 1, Zeile - 1)und(Spalte + 1, Zeile + 1), während"nw"und"sw"auf(Spalte, Zeile - 1)und(Spalte, Zeile + 1)zeigen.Gerade Zeilen:
"no"und"so"zeigen auf(Spalte, Zeile - 1)und(Spalte, Zeile + 1), während"nw"und"sw"auf(Spalte - 1, Zeile - 1)und(Spalte - 1, Zeile + 1)zeigen.
"o"und"w"zeigen immer auf(Spalte + 1, Zeile)und(Spalte - 1, Zeile).Beispiele
from miniworlds import HexWorld, Actor world = HexWorld(7, 7, tile_size=40) actor = Actor((3, 3)) actor.fill_color = (255, 0, 0) world.run()
- __init__(x=20, y=16, tile_size=40, empty=False)[Quellcode]#
Erstellt eine Hex-Welt.
- Parameter:
x – Anzahl der Spalten.
y – Anzahl der Zeilen.
tile_size – Die Größe eines Hexfelds in Pixeln (Umkreisradius des Hexfelds).
empty – Wenn
True, werden Kacheln, Kanten und Ecken nicht automatisch erstellt.
- clear_highlights(tiles=None)[Quellcode]#
Entfernt Hervorhebungen.
- Rückgabetyp:
- Parameter:
tiles – Kacheln oder Hex-Positionen, deren Hervorhebung entfernt wird. Ohne Angabe werden alle Hervorhebungen entfernt.
Beispiele
world.clear_highlights()
- dialog#
- find_nearest(start, is_target, blocked=None, cost=None, max_cost=None, include_start=False)[Quellcode]#
Gibt den Weg zum nächstgelegenen Hexfeld zurück, das
is_targeterfüllt.Das nächstgelegene Hexfeld ist das günstigste zu erreichende, nicht das mit dem kleinsten Hex-Abstand. Ein Ziel darf blockiert sein (zum Beispiel ein Gegner, der sein Hexfeld blockiert): Der Weg endet dort.
- Rückgabetyp:
- Parameter:
start – Startfeld als Position, Kachel oder Actor.
is_target – Funktion
is_target(tile) -> bool.blocked – Optionales
blocked(tile) -> bool, siehefind_path.cost – Optionales
cost(tile) -> float, siehefind_path.max_cost – Optionales Budget; teurere Ziele werden ignoriert.
include_start – Wenn
True, kann das Startfeld selbst das Ziel sein.
- Rückgabe:
Die Kacheln vom Start bis zum nächstgelegenen Ziel, beide eingeschlossen, oder eine leere Liste, wenn kein Ziel erreichbar ist.
Beispiele
path = world.find_nearest(robot, lambda tile: tile.terrain == "forest") if path: robot.position = path[1].position
- find_path(start, goal, blocked=None, cost=None, max_cost=None, min_cost=None)[Quellcode]#
Gibt den günstigsten Weg zwischen zwei Hexfeldern zurück.
Ein Hexfeld zu betreten kostet
tile.cost(Standard:1). Eine Kachel ist nicht passierbar, wenntile.is_blockinggesetzt ist oder ein Actor mitis_blocking = Truedarauf steht. Das Ziel muss passierbar sein.- Rückgabetyp:
- Parameter:
start – Startfeld als Position, Kachel oder Actor.
goal – Zielfeld als Position, Kachel oder Actor.
blocked – Optionale Funktion
blocked(tile) -> bool, die die Standardregel für blockierte Kacheln ersetzt.cost – Optionale Funktion
cost(tile) -> float, dietile.costersetzt. Kosten dürfen nicht negativ sein.max_cost – Optionales Budget; teurere Wege werden nicht zurückgegeben.
min_cost – Günstigste Schrittkosten einer eigenen
cost-Funktion; beschleunigt die Suche. Zu große Werte können einen nicht optimalen Weg liefern.
- Rückgabe:
Die Kacheln vom Start bis zum Ziel, beide eingeschlossen, oder eine leere Liste, wenn es keinen Weg gibt.
- Verursacht:
TileNotFoundError – Wenn Start oder Ziel keine Kachel der Welt ist.
Beispiele
world.get_tile((2, 2)).is_blocking = True # water path = world.find_path((0, 0), (5, 4)) for tile in path: tile.highlight()
- get_actors_from_pixel(position)[Quellcode]#
Gibt alle Actor unter einem Bildschirmpixel zurück.
Zurückgegeben werden Actors auf der Hex-Kachel unter dem Pixel sowie Actors auf Ecken oder Kanten, deren Mittelpunkt innerhalb des Erkennungsradius (
tile_size / 3, wie beiactor.detect_pixel) um den Pixel liegt.Der Pixel wird zuerst in Weltpixel umgerechnet, daher funktioniert die Abfrage auch bei gescrollter Kamera oder wenn die Welt neben anderen Welten angedockt ist. Actors auf Ecken und Kanten werden auch ohne Kachel unter dem Pixel erkannt, daher bleiben Straßen und Siedlungen am Rand der Welt anklickbar.
- Parameter:
position – Pixelposition als
(x, y).- Rückgabe:
Actors unter dem Pixel. Eine leere Liste, wenn kein Actor unter dem Pixel liegt.
Beispiele
actors = world.get_actors_from_pixel(mouse_pos)
- get_center_points()[Quellcode]#
Gibt eine Zuordnung von Hex-Positionen zu ihren Mittelpunkt-Pixeln zurück.
- get_corner(position, direction=None)[Quellcode]#
Gibt eine Ecke über die Eckenposition oder über Hex-Position plus Richtung zurück.
- Parameter:
position – Eckenposition oder Hex-Position, wenn
directiongesetzt ist.direction – Optionale Eckenrichtung, z. B.
"no".
- Rückgabe:
Die passende Ecke.
- Verursacht:
CornerNotFoundError – Wenn an der aufgelösten Position keine Ecke existiert.
Beispiele
corner = world.get_corner((3, 3), "no")
- get_corner_from_pixel(position)[Quellcode]#
Gibt die Ecke zurück, die einem Bildschirmpixel am nächsten liegt.
Der Pixel wird zuerst in Weltpixel umgerechnet, daher funktioniert die Abfrage auch bei gescrollter Kamera oder wenn die Welt neben anderen Welten angedockt ist. Pixel am Rand der Welt wählen unter den Randfeldern aus, daher bleiben Ecken am Rand (Siedlungspositionen auf einem Catan-Brett) anklickbar.
- Parameter:
position – Pixelposition als
(x, y).- Rückgabe:
Die nächstgelegene Ecke oder
None, wenn der Pixel außerhalb der Kamerasicht oder außerhalb der Welt liegt.
Beispiele
corner = world.get_corner_from_pixel(mouse_pos)
- get_distance(first, second)[Quellcode]#
Gibt den Hex-Abstand (Anzahl der Schritte) zwischen zwei Hexfeldern zurück.
Der Abstand hängt nicht von der Zeilenparität ab und ignoriert blockierte Kacheln; mit
find_pathzählst du die Schritte um Hindernisse herum.- Rückgabetyp:
- Parameter:
first – Hex-Position, Kachel oder Actor.
second – Hex-Position, Kachel oder Actor.
- Rückgabe:
Die Anzahl der Hexfelder, die du von
firstnachsecondgehen musst.
Beispiele
if world.get_distance(robot, goal) <= 2: print("Goal in reach")
- get_edge(position, direction=None)[Quellcode]#
Gibt eine Kante über die Kantenposition oder über Hex-Position plus Richtung zurück.
- Parameter:
position – Kantenposition oder Hex-Position, wenn
directiongesetzt ist.direction – Optionale Kantenrichtung, z. B.
"o".
- Rückgabe:
Die passende Kante.
- Verursacht:
EdgeNotFoundError – Wenn an der aufgelösten Position keine Kante existiert.
Beispiele
edge = world.get_edge((3, 3), "o")
- get_edge_from_pixel(position)[Quellcode]#
Gibt die Kante zurück, die einem Bildschirmpixel am nächsten liegt.
Der Pixel wird zuerst in Weltpixel umgerechnet, daher funktioniert die Abfrage auch bei gescrollter Kamera oder wenn die Welt neben anderen Welten angedockt ist. Pixel am Rand der Welt wählen unter den Randfeldern aus, daher bleiben Kanten am Rand (Straßenpositionen auf einem Catan-Brett) anklickbar.
- Parameter:
position – Pixelposition als
(x, y).- Rückgabe:
Die nächstgelegene Kante oder
None, wenn der Pixel außerhalb der Kamerasicht oder außerhalb der Welt liegt.
Beispiele
edge = world.get_edge_from_pixel(mouse_pos)
- get_from_pixel(position)[Quellcode]#
Gibt die Hex-Position für einen Bildschirmpixel zurück.
Der Pixel wird zuerst in Weltpixel umgerechnet, daher funktioniert die Abfrage auch bei gescrollter Kamera oder wenn die Welt neben anderen Welten angedockt ist.
- Parameter:
position – Pixelposition als
(x, y).- Rückgabe:
Hex-Position als
(Spalte, Zeile)oderNone, wenn der Pixel außerhalb der Kamerasicht oder außerhalb der Welt liegt.
Beispiele
hex_position = world.get_from_pixel((80, 120))
- get_path_cost(path, cost=None)[Quellcode]#
Gibt die Kosten eines Wegs zurück (das erste Hexfeld wird nicht mitgezählt).
- Rückgabetyp:
- Parameter:
path – Eine Liste von Kacheln, zum Beispiel das Ergebnis von
find_path.cost – Optionales
cost(tile) -> float, siehefind_path.
Beispiele
path = world.find_path((0, 0), (5, 3)) print(world.get_path_cost(path))
- get_reachable_tiles(start, max_cost, blocked=None, cost=None)[Quellcode]#
Gibt alle Hexfelder zurück, die innerhalb eines Bewegungsbudgets erreichbar sind.
Mit Standardkosten ist
max_costdie Anzahl der Schritte; blockierte Kacheln werden umlaufen, daher kann das Ergebnis kleiner sein als beiget_tiles_in_radius.- Rückgabetyp:
- Parameter:
start – Startfeld als Position, Kachel oder Actor.
max_cost – Bewegungsbudget.
blocked – Optionales
blocked(tile) -> bool, siehefind_path.cost – Optionales
cost(tile) -> float, siehefind_path.
- Rückgabe:
Die erreichbaren Kacheln einschließlich der Startkachel, von der günstigsten zur teuersten sortiert.
Beispiele
for tile in world.get_reachable_tiles(robot.position, 3): tile.highlight((0, 200, 0, 80))
- get_tile_from_pixel(position)[Quellcode]#
Gibt die Hex-Kachel unter einem Bildschirmpixel zurück.
Der Pixel wird zuerst in Weltpixel umgerechnet, daher funktioniert die Abfrage auch bei gescrollter Kamera oder wenn die Welt neben anderen Welten angedockt ist.
- Parameter:
position – Pixelposition als
(x, y).- Rückgabe:
Die registrierte Hex-Kachel unter dem Pixel (dasselbe Objekt wie
world.get_tile(...)) oderNone, wenn der Pixel außerhalb der Welt liegt (an der gerundeten Hex-Position existiert keine Kachel).
Beispiele
tile = world.get_tile_from_pixel((80, 120)) if tile is not None: tile.fill_color = (255, 0, 0)
- get_tiles_in_line(start, end)[Quellcode]#
Gibt die Kacheln auf der geraden Linie zwischen zwei Hexfeldern zurück.
Beide Enden sind enthalten. Positionen der Linie außerhalb der Welt werden übersprungen. Zusammen mit
tile.is_blockingbeantwortet das Sichtlinien-Fragen.- Rückgabetyp:
- Parameter:
start – Hex-Position, Kachel oder Actor.
end – Hex-Position, Kachel oder Actor.
- Rückgabe:
Die Kacheln von
startbisend.
Beispiele
visible = all( not tile.is_blocking for tile in world.get_tiles_in_line(archer, target) )
- get_tiles_in_radius(position, radius, include_center=True)[Quellcode]#
Gibt alle Kacheln innerhalb eines Hex-Abstands von
radiuszurück.Das Ergebnis ist unabhängig von der Zeilenparität, die in der
HexWorld-Beschreibung erklärt ist. Die Offsets eines Rings werden nur einmal pro Zeilenparität und Radius berechnet, daher sind wiederholte Abfragen günstig.- Rückgabetyp:
- Parameter:
position – Hex-Position
(column, row), eine Kachel oder ein Actor.radius – Maximaler Hex-Abstand (0 enthält nur die Kachel selbst).
include_center – Bei
Falsewird die Kachel anpositionweggelassen.
- Rückgabe:
Liste der Kacheln im Radius, vom Zentrum nach außen in Ring-Reihenfolge sortiert. Positionen außerhalb der Welt werden übersprungen.
- Verursacht:
TypeError – Wenn
radiusoderpositionden falschen Typ hat.
Beispiele
neighbours = world.get_tiles_in_radius((3, 3), 1) around = world.get_tiles_in_radius((3, 3), 2, include_center=False)
- get_tiles_in_ring(position, radius)[Quellcode]#
Gibt alle Kacheln mit genau
radiusHex-Abstand zurück.Das Ergebnis ist unabhängig von der Zeilenparität, die in der
HexWorld-Beschreibung erklärt ist.- Rückgabetyp:
- Parameter:
position – Hex-Position
(column, row), eine Kachel oder ein Actor.radius – Hex-Abstand.
- Rückgabe:
Liste der Kacheln im angegebenen Abstand, in Ring-Reihenfolge, beginnend beim westlichsten Hexfeld des Rings. Positionen außerhalb der Welt werden übersprungen.
- Verursacht:
TypeError – Wenn
radiusoderpositionden falschen Typ hat.
Beispiele
ring = world.get_tiles_in_ring((3, 3), 2)
- has_line_of_sight(start, goal, blocked=None)[Quellcode]#
Gibt zurück, ob zwischen zwei Hexfeldern kein blockiertes Hexfeld auf der Linie liegt.
Die Linie ist die von
get_tiles_in_line. Es zählen nur die Hexfelder echt zwischen Start und Ziel; ein blockiertes Ziel kann trotzdem gesehen werden.- Rückgabetyp:
- Parameter:
start – Startfeld als Position, Kachel oder Actor.
goal – Zielfeld als Position, Kachel oder Actor.
blocked – Optionales
blocked(tile) -> bool, siehefind_path.
Beispiele
if world.has_line_of_sight(guard, player): print("spotted")
- highlight_tiles(tiles, color=(255, 255, 0, 90))[Quellcode]#
Hebt Hexfelder mit einer durchscheinenden Farbe hervor.
Die Hervorhebungen werden im Hintergrund unter den Actors gezeichnet und bleiben bestehen, bis
clear_highlightsaufgerufen wird.- Rückgabetyp:
- Parameter:
tiles – Kacheln oder Hex-Positionen.
color – RGB- oder RGBA-Farbe; bei RGB wird eine Standard-Transparenz verwendet.
Beispiele
world.highlight_tiles(world.get_tiles_in_radius((3, 3), 1))
- property hovered_tile#
Das Hexfeld unter der Maus oder
None.Der Wert wird aktuell gehalten, solange die Welt einen
on_tile_enter- oderon_tile_leave-Handler (oderon_mouse_motion) hat.Beispiele
@world.register def on_mouse_left(self, mouse_pos): if world.hovered_tile is not None: print(world.hovered_tile.position)
- is_hex = True#
- to_pixel(position, size=(0, 0), origin=(0, 0))[Quellcode]#
Rechnet eine Hex-Position in die Pixelposition ihres Mittelpunkts um.
- Parameter:
position – Hex-Position als
(Spalte, Zeile).size – Für Kompatibilität reserviert.
origin – Pixelversatz, der zur umgerechneten Position addiert wird.
- Rückgabe:
Pixelposition als
(x, y).
Beispiele
pixel = world.to_pixel((2, 3))
- view_position_ranges(camera_rect)[Quellcode]#
Gibt Positionsbereiche zurück, die
camera_rectfür Indexabfragen abdecken.Positionen in einer Hex-Welt liegen in drei verschiedenen Koordinatenräumen: Kacheln in Offset-Koordinaten
(Spalte, Zeile), Ecken in verdreifachten Würfelkoordinaten und Kanten in verdoppelten Würfelkoordinaten. Der Chunk-Schlüssel des Tiled-Spatial-Index wird aus der Rohposition abgeleitet, daher wird ein Bereich pro Raum zurückgegeben. Jeder Actor, dessen Pixelrechteck das Kamerarechteck schneiden kann, wird von einem der Bereiche abgedeckt, während jeder Bereich auf das sichtbare Fenster begrenzt bleibt.- Parameter:
camera_rect – Kamerarechteck in Weltpixeln.
- Rückgabe:
Eine Liste von Positionsbereichen
((min_x, min_y), (max_x, max_y)), die Kachel-, Ecken- und Kantenpositionen abdecken.
Beispiele
ranges = world.view_position_ranges(world.camera.rect)
- class miniworlds.worlds.hex_world.hex_tile.HexTile(position, world=None)[Quellcode]#
Eine sechseckige Kachel in einer HexWorld.
Kacheln werden mit Offset-Koordinaten
(Spalte, Zeile)angesprochen, wie Kacheln in einer TiledWorld. Ungerade Zeilen sind um ein halbes Hexfeld nach rechts verschoben; wegen dieser Verschiebung hängen die diagonalen Nachbarn eines Hexfelds von der Zeilenparität ab (die vollständige Konvention steht in derHexWorld-Docstring).- clear_highlight()[Quellcode]#
Entfernt die Hervorhebung dieses Hexfelds.
- Rückgabetyp:
- corner_vectors: OrderedDict[str, Tuple[float, float]] = {'n': (1, -2, 1), 'no': (2, -1, -1), 'nw': (-1, -1, 2), 's': (-1, 2, -1), 'so': (1, 1, -2), 'sw': (-2, 1, 1)}#
- distance_to(other)[Quellcode]#
Gibt den Hex-Abstand zu einer anderen Kachel zurück (wie
get_distance_to).Die rechteckige
Tile.distance_tomisst den euklidischen Abstand der Offset-Koordinaten. Das ist auf einem Hex-Gitter wegen der verschobenen Zeilen falsch.- Rückgabetyp:
- edge_vectors: dict[str, Tuple[float, float]] = {'no': (1, -1, 0), 'nw': (0, -1, 1), 'o': (1, 0, -1), 'so': (0, 1, -1), 'sw': (-1, 1, 0), 'w': (-1, 0, 1)}#
- classmethod from_pixel(pixel_position, world=None)[Quellcode]#
Gibt die Hex-Kachel zurück, die eine Pixelposition enthält.
Die Umrechnung ist exakt: Der Pixel wird in gebrochene Würfelkoordinaten umgerechnet und auf den nächsten Hex-Mittelpunkt gerundet. Die Position wird nicht gegen die Weltgrenzen geprüft; verwende
world.get_tile_from_pixelfür eine Abfrage mit Grenzprüfung, die außerhalb der WeltNonezurückgibt.- Rückgabetyp:
- classmethod from_position(position, world)[Quellcode]#
Erstellt eine Kachel aus einer weltrelativen Position.
- Rückgabetyp:
- get_corner(direction)[Quellcode]#
Gibt die Ecke dieses Hexfelds in der angegebenen Richtung zurück.
- Rückgabetyp:
- Parameter:
direction – Eckenrichtung, z. B.
"no".
Beispiele
corner = world.get_tile((2, 2)).get_corner("no")
- get_distance_to(other)[Quellcode]#
Gibt den Hex-Abstand (Anzahl der Schritte) zu einer Kachel, Position oder einem Actor zurück.
- Rückgabetyp:
Beispiele
steps = tile.get_distance_to(goal_tile)
- get_edge(direction)[Quellcode]#
Gibt die Kante dieses Hexfelds in der angegebenen Richtung zurück.
- Rückgabetyp:
- Parameter:
direction – Kantenrichtung, z. B.
"o".
Beispiele
edge = world.get_tile((2, 2)).get_edge("o")
- static get_local_center_coordinate(world)[Quellcode]#
Gibt den Mittelpunkt-Versatz einer Kachel in lokalen Pixelkoordinaten zurück.
- get_local_corner_points()[Quellcode]#
Gibt die sechs Eckpixel relativ zur oberen linken Ecke des Hex-Begrenzungsrechtecks zurück.
- get_neighbour(direction)[Quellcode]#
Gibt das benachbarte Hexfeld in einer Richtung zurück, oder
Noneam Rand.- Rückgabetyp:
- Parameter:
direction – Eine von
"o","so","sw","w","nw","no".- Verursacht:
DirectionNotFoundError – Wenn
directionkeine Hex-Richtung ist.
Beispiele
east = world.get_tile((3, 3)).get_neighbour("o") if east is not None: east.highlight()
- get_neighbour_corners()[Quellcode]#
Gibt die sechs Ecken dieses Hexfelds zurück, im Uhrzeigersinn ab der oberen Spitze.
Beispiele
for corner in world.get_tile((2, 2)).get_neighbour_corners(): print(corner.position)
- get_neighbour_edges()[Quellcode]#
Gibt die sechs Kanten dieses Hexfelds zurück, im Uhrzeigersinn ab der Nordost-Kante.
Beispiele
for edge in world.get_tile((2, 2)).get_neighbour_edges(): print(edge.position)
- get_neighbour_tiles()[Quellcode]#
Gibt die bis zu sechs benachbarten Hex-Kacheln zurück.
Die Liste ist eine Kopie; Änderungen daran wirken sich nicht auf die Welt aus.
- static get_position_pixel_dict(world)[Quellcode]#
Gibt eine Zuordnung von Kachelpositionen zu Pixelkoordinaten zurück.
- Rückgabetyp:
- get_tiles_in_radius(radius, include_center=False)[Quellcode]#
Gibt die Kacheln im Umkreis von
radiusSchritten um dieses Hexfeld zurück.Anders als
world.get_tiles_in_radiusist die Kachel selbst standardmäßig nicht enthalten, daher liefertget_tiles_in_radius(1)dieselben Kacheln wieget_neighbour_tiles()(in Ring- statt Richtungsreihenfolge).- Rückgabetyp:
- Parameter:
radius – Maximaler Hex-Abstand.
include_center – Bei
Trueist diese Kachel das erste Ergebnis.
Beispiele
for tile in world.get_tile((3, 3)).get_tiles_in_radius(2): tile.highlight()
- get_tiles_in_ring(radius)[Quellcode]#
Gibt die Kacheln zurück, die genau
radiusSchritte von diesem Hexfeld entfernt sind.Beispiele
ring = world.get_tile((3, 3)).get_tiles_in_ring(2)
- highlight(color=(255, 255, 0, 90))[Quellcode]#
Hebt dieses Hexfeld mit einer durchscheinenden Farbe hervor.
Die Hervorhebung wird im Hintergrund der Welt unter den Actors gezeichnet und bleibt bestehen, bis
clear_highlightaufgerufen wird.- Rückgabetyp:
- Parameter:
color – RGB- oder RGBA-Farbe; bei RGB wird eine Standard-Transparenz verwendet.
Beispiele
@world.register def on_tile_enter(self, tile): tile.highlight((255, 255, 255, 80)) @world.register def on_tile_leave(self, tile): tile.clear_highlight()
- tile_vectors: dict[str, Tuple[int, int]] = {'no': (1, -1, 0), 'nw': (0, -1, 1), 'o': (1, 0, -1), 'so': (0, 1, -1), 'sw': (-1, 1, 0), 'w': (-1, 0, 1)}#
- to_center()[Quellcode]#
Gibt den Mittelpunkt-Pixel des Hexfelds zurück.
- to_pixel()[Quellcode]#
Gibt den Pixel der oberen linken Ecke des Hex-Begrenzungsrechtecks zurück.
- class miniworlds.worlds.hex_world.hex_corner.HexCorner(position, direction, world=None)[Quellcode]#
Eine Ecke eines Hexfelds, die von bis zu drei Hexfeldern geteilt wird.
Die Eckenposition ist ein eindeutiger Schlüssel in verdreifachten Würfelkoordinaten: Alle Hexfelder, die sich die Ecke teilen, berechnen denselben Schlüssel, daher werden Ecken beim Aufbau der Welt zusammengeführt.
- angles: Dict[str, int] = {'n': 0, 'no': 1, 'nw': 5, 's': 3, 'so': 2, 'sw': 4}#
- direction_angles: Dict[str, int] = {'n': 0, 'no': 0, 'nw': 0, 's': 0, 'so': 0, 'sw': 0}#
- static direction_vectors()[Quellcode]#
Gibt die verfügbaren Richtungen zurück.
- classmethod from_position(position, world)[Quellcode]#
Erstellt einen Kachel-Begrenzer (Überschreiben erwartet).
- Rückgabetyp:
- get_neighbour_corners()[Quellcode]#
Gibt die Ecken zurück, die eine Hexfeld-Seite entfernt sind (bis zu drei).
Das ist die „Abstandsregel“ von Catan: Eine Siedlung darf nur gebaut werden, wenn keine Nachbarecke bereits eine Siedlung trägt. Ecken außerhalb der Welt werden übersprungen.
Beispiele
for corner in world.get_corner((3, 3), "n").get_neighbour_corners(): print(corner.position)
- get_neighbour_edges()[Quellcode]#
Gibt die Kanten zurück, die an dieser Ecke zusammentreffen (bis zu drei).
Kanten außerhalb der Welt werden übersprungen.
Beispiele
roads = corner.get_neighbour_edges()
- get_neighbour_tiles()[Quellcode]#
Gibt die bis zu drei Hexfelder zurück, die sich diese Ecke teilen.
Die Hexfelder werden aus den zusammengeführten Eckenreferenzen abgeleitet, daher muss nicht für jede Referenz eine Kachel existieren: Referenzen auf Positionen außerhalb der Welt werden übersprungen.
- start_angle()[Quellcode]#
Überschreiben: Start-Winkelversatz für das Layout (z. B. Hex-Rotation).
- Rückgabetyp:
- to_pixel()[Quellcode]#
Gibt die Pixelposition der Ecke zurück.
- class miniworlds.worlds.hex_world.hex_edge.HexEdge(position, direction, world=None)[Quellcode]#
Eine Kante eines Hexfelds, die von genau zwei Hexfeldern geteilt wird.
Die Kantenposition ist ein eindeutiger Schlüssel in verdoppelten Würfelkoordinaten: Beide Hexfelder, die sich die Kante teilen, berechnen denselben Schlüssel, daher werden Kanten beim Aufbau der Welt zusammengeführt.
- angles: Dict[str, int] = {'no': 5, 'nw': 4, 'o': 0, 'so': 1, 'sw': 2, 'w': 3}#
- direction_angles: Dict[str, int] = {'no': 300, 'nw': 240, 'o': 0, 'so': 60, 'sw': 120, 'w': 180}#
- static direction_vectors()[Quellcode]#
Gibt die verfügbaren Richtungen zurück.
- classmethod from_position(position, world)[Quellcode]#
Erstellt einen Kachel-Begrenzer (Überschreiben erwartet).
- Rückgabetyp:
- get_neighbour_corners()[Quellcode]#
Gibt die beiden Ecken an den Enden dieser Kante zurück.
Beispiele
first, second = edge.get_neighbour_corners()
- get_neighbour_edges()[Quellcode]#
Gibt die Kanten zurück, die diese Kante an einer Ecke berühren (bis zu vier).
Das ist die Anschlussregel für Catan-Straßen: Eine Straße muss an eine Siedlung oder eine andere Straße anschließen.
Beispiele
connected_roads = edge.get_neighbour_edges()
- get_neighbour_tiles()[Quellcode]#
Gibt die bis zu zwei Hexfelder zurück, die sich diese Kante teilen.
Die Hexfelder werden aus den zusammengeführten Kantenreferenzen abgeleitet, daher muss nicht für jede Referenz eine Kachel existieren: Referenzen auf Positionen außerhalb der Welt werden übersprungen.
- start_angle()[Quellcode]#
Überschreiben: Start-Winkelversatz für das Layout (z. B. Hex-Rotation).
- Rückgabetyp:
- to_pixel()[Quellcode]#
Gibt die Pixelposition des Kantenmittelpunkts zurück.
- class miniworlds.worlds.hex_world.hex_world_sensor_manager.HexWorldSensorManager(actor, world)[Quellcode]#
Sensor-Manager für Hex-Welten.
Klick- und Pixelerkennung für Actors auf Hexfeldern nutzt das exakte Hex-Picking, das vom Tiled-Sensor-Manager geerbt wird. Actors auf Ecken oder Kanten werden erkannt, wenn der Pixel nahe am Mittelpunkt der Ecke oder Kante liegt, daher lassen sich Siedlungen und Straßen anklicken.
Abstände zwischen Actors auf Hexfeldern sind Hex-Abstände (Anzahl der Hexfelder zwischen den Positionen), keine euklidischen Offset-Abstände.
Bewegung entlang der sechs Hex-Achsen (die Richtungen
"no","o","so","sw","w","nw"und ihre Scratch-Grad-Werte) geht in Würfelkoordinaten von Hexfeld zu Hexfeld, daher ist jeder Schritt genau ein Hexfeld, unabhängig von der Zeilenparität. Winkel, die keine Hex-Achsen sind, werden auf die nächste Achse gerundet (hex_coords.nearest_axis_degrees), daher springt ein einzelner Schritt nie mehr als ein Hexfeld weit.- DETECTION_RADIUS_FACTOR = 0.3333333333333333#
- detect_pixel(position)[Quellcode]#
- Rückgabetyp:
- static get_destination(start, direction, distance)[Quellcode]#
Berechnet eine neue Position (x, y) ab
start, indemdistanceEinheiten in Richtungdirection(Grad) gegangen wird.
- get_distance_to(obj)[Quellcode]#
Gibt den Abstand zu einem anderen Actor oder einer Position zurück.
Für Actors und Positionen auf Hex-Kacheln wird der Hex-Abstand (die Anzahl der Hexfelder zwischen den Positionen) zurückgegeben. Ist eine Ecke oder Kante beteiligt, wird der Pixelabstand zwischen den Mittelpunkten der Ecke, Kante oder Hexfelder zurückgegeben.
- Rückgabetyp:
- class miniworlds.worlds.hex_world.hex_world_position_manager.HexWorldPositionManager(actor, world, position)[Quellcode]#
Positions-Manager für Actors in Hex-Welten.
Actor-Größen werden aus dem Hex-Begrenzungsrechteck statt aus der quadratischen Kachelgröße abgeleitet. Die sechs Hex-Richtungen (
"no","o","so","sw","w","nw") werden als Richtungen akzeptiert und auf ihre Scratch-Grad-Werte abgebildet.- get_size()[Quellcode]#
- validate_direction(value)[Quellcode]#
Wandelt einen String-Wert (“top”, “left”, “right”, „bottom) in eine Position um
- Parameter:
value – Der String-Wert (“top”, “left”, “right” oder „bottom)
- Rückgabe:
Die Position als Scratch-Grad-Wert
- class miniworlds.worlds.hex_world.hex_camera_manager.HexCameraManager(view_x, view_y, world)[Quellcode]#
Kamera-Manager für Hex-Welten.
Sicht- und Weltgrößen werden in Hexfeldern (Spalten, Zeilen) gemessen; Pixelgrößen werden aus der Pointy-Top-Hex-Geometrie abgeleitet.
- get_world_rect()[Quellcode]#
Gibt das vollständige Weltrechteck ab dem aktuellen Ursprung der Kamera zurück.
- Rückgabetyp:
Rect- Rückgabe:
Ein pygame.Rect, das den sichtbaren und gescrollten Weltbereich beschreibt.
Beispiele
>>> world.camera.get_world_rect()
- class miniworlds.worlds.hex_world.hex_costume.HexCostume(*args, **kwargs)[Quellcode]#
Kostüm für Actors in Hex-Welten.
Actors auf einer Hex-Kachel werden als Sechsecke statt als Rechtecke gezeichnet. Actors auf Ecken oder Kanten behalten die rechteckige Form.
- animation_length#
- draw_images#
- draw_shapes#
- font_manager#
- id#
- image_manager: image_manager.ImageManager#
- initialized#
- last_image#
- loop#
- parent#
Das übergeordnete Element eines Kostüms ist der zugehörige Actor.
- surface_loaded#
- transformations_manager#
Koordinatenmathematik für hexagonale Welten.
HexWorld nutzt ein Pointy-Top-Layout mit Odd-r-Offset-Koordinaten: Schüler sprechen Hexfelder mit (Spalte, Zeile)-Tupeln an, genau wie Kacheln in einer TiledWorld. Ungerade Zeilen sind um ein halbes Hexfeld nach rechts verschoben.
Intern werden Würfelkoordinaten (q, r, s) mit q + r + s = 0 für Nachbar- und Abstandsberechnungen verwendet, weil sie über alle Zeilen hinweg einheitlich sind.
Alle Funktionen sind rein und frei von Abhängigkeiten zu pygame oder zur Welt.
- miniworlds.worlds.hex_world.hex_coords.corner_edge_keys(corner_key)[Quellcode]#
Gibt die Schlüssel der drei Kanten zurück, die an einer Ecke zusammentreffen.
- miniworlds.worlds.hex_world.hex_coords.corner_neighbour_corner_keys(corner_key)[Quellcode]#
Gibt die Schlüssel der drei Ecken zurück, die eine Hexfeld-Seite von einer Ecke entfernt sind.
Die Schlüssel werden ohne Welt berechnet, daher können sie außerhalb des Bretts liegen; Aufrufer filtern nach den Ecken, die existieren.
- miniworlds.worlds.hex_world.hex_coords.corner_pixel_offset(direction, tile_size)[Quellcode]#
Gibt den Pixelversatz einer Hex-Ecke relativ zum Hex-Mittelpunkt zurück.
- miniworlds.worlds.hex_world.hex_coords.corner_pixel_offsets(tile_size)[Quellcode]#
Gibt die Pixelversätze der sechs Hex-Ecken (relativ zum Mittelpunkt) zurück.
- miniworlds.worlds.hex_world.hex_coords.corner_pixel_points(position, tile_size)[Quellcode]#
Gibt die sechs Eckpixel eines Hexfelds zurück, im Uhrzeigersinn ab der oberen Spitze.
- miniworlds.worlds.hex_world.hex_coords.corner_position(tile_position, direction)[Quellcode]#
Gibt den eindeutigen Positionsschlüssel einer Ecke zurück.
Der Schlüssel wird in verdreifachten Würfelkoordinaten ausgedrückt, damit alle Hexfelder, die sich die Ecke teilen, denselben ganzzahligen Schlüssel erzeugen.
- miniworlds.worlds.hex_world.hex_coords.corner_tile_references(corner_key)[Quellcode]#
Gibt
(Kachel-Würfel, Eckenrichtung)für jedes Hexfeld zurück, das sich eine Ecke teilt.Ein Eckenschlüssel ist
3 * cube + vector. Zieht man jeden Eckenvektor ab und prüft die Teilbarkeit durch drei, findet man die (bis zu) drei Hexfelder, die die Ecke erreichen, unabhängig von den Weltgrenzen.
- miniworlds.worlds.hex_world.hex_coords.cube_destination(start, direction, distance)[Quellcode]#
Gibt die Hex-Position zurück, die von
startaus entlang einer Hex-Achse erreicht wird.
- miniworlds.worlds.hex_world.hex_coords.cube_distance(a, b)[Quellcode]#
Gibt den Hex-Abstand (Anzahl der Hexfelder) zwischen zwei Würfelpositionen zurück.
- Rückgabetyp:
- miniworlds.worlds.hex_world.hex_coords.cube_line(start, end)[Quellcode]#
Gibt die Cube-Koordinaten der geraden Linie von
startnachendzurück.Beide Enden sind enthalten; die Linie hat
distance + 1Hexfelder. Ein winziger Versatz macht das Ergebnis eindeutig, wenn die Linie genau entlang der Grenze zweier Hexfelder verläuft.
- miniworlds.worlds.hex_world.hex_coords.cube_ring(center, radius)[Quellcode]#
Gibt alle Würfelpositionen mit genau
radiusHex-Abstand zurück.Die Positionen werden in Ring-Reihenfolge zurückgegeben, beginnend beim westlichsten Hexfeld des Rings und im Uhrzeigersinn. Für
radius0 wird nur die Mitte zurückgegeben; für negativenradiusnichts.
- miniworlds.worlds.hex_world.hex_coords.cube_round(cube)[Quellcode]#
Rundet gebrochene Würfelkoordinaten auf den nächsten Hex-Mittelpunkt.
- miniworlds.worlds.hex_world.hex_coords.cube_to_offset(cube)[Quellcode]#
Wandelt Würfelkoordinaten
(q, r, s)in Odd-r-Offset-Koordinaten um.
- miniworlds.worlds.hex_world.hex_coords.direction_vector(direction, vectors)[Quellcode]#
Gibt den Vektor für einen Richtungsnamen zurück, mit einer hilfreichen Fehlermeldung.
- miniworlds.worlds.hex_world.hex_coords.disc_offset_deltas(row_parity, radius)[Quellcode]#
Gibt die Offset-Deltas aller Hexfelder im Abstand von höchstens
radiuszurück.Das Zentrum steht zuerst, danach folgen die Ringe von innen nach außen, jeweils in
cube_ring-Reihenfolge.
- miniworlds.worlds.hex_world.hex_coords.edge_corner_keys(edge_key)[Quellcode]#
Gibt die Schlüssel der beiden Ecken an den Enden einer Kante zurück.
- miniworlds.worlds.hex_world.hex_coords.edge_neighbour_edge_keys(edge_key)[Quellcode]#
Gibt die Schlüssel der (bis zu vier) Kanten zurück, die eine Kante an einer Ecke berühren.
- miniworlds.worlds.hex_world.hex_coords.edge_pixel_offset(direction, tile_size)[Quellcode]#
Gibt den Pixelversatz eines Kantenmittelpunkts relativ zum Hex-Mittelpunkt zurück.
- miniworlds.worlds.hex_world.hex_coords.edge_pixel_offsets(tile_size)[Quellcode]#
Gibt die Pixelversätze der sechs Kantenmittelpunkte (relativ zum Mittelpunkt) zurück.
- miniworlds.worlds.hex_world.hex_coords.edge_position(tile_position, direction)[Quellcode]#
Gibt den eindeutigen Positionsschlüssel einer Kante zurück.
Der Schlüssel wird in verdoppelten Würfelkoordinaten ausgedrückt, damit beide Hexfelder, die sich die Kante teilen, denselben ganzzahligen Schlüssel erzeugen.
- miniworlds.worlds.hex_world.hex_coords.edge_tile_references(edge_key)[Quellcode]#
Gibt
(Kachel-Würfel, Kantenrichtung)für beide Hexfelder zurück, die sich eine Kante teilen.Ein Kantenschlüssel ist
2 * cube + vector; siehecorner_tile_references.
- miniworlds.worlds.hex_world.hex_coords.hex_center(position, tile_size)[Quellcode]#
Gibt den Mittelpunkt-Pixel des Hexfelds an der Offset-Position
(Spalte, Zeile)zurück.Das Layout lässt oben und links einen halben Hexfeld-Rand, damit die obere Spitze der ersten Zeile und die linke Kante der ersten Spalte vollständig sichtbar sind.
- miniworlds.worlds.hex_world.hex_coords.hex_distance(first, second)[Quellcode]#
Gibt den Hex-Abstand zwischen zwei Offset-Positionen
(column, row)zurück.Der Abstand ist die Anzahl der Hex-Schritte zwischen den Positionen; er hängt nicht von der Zeilenparität ab.
- Rückgabetyp:
- miniworlds.worlds.hex_world.hex_coords.hex_height(tile_size)[Quellcode]#
Gibt die Pixelhöhe eines Hexfelds zurück (Höhe des Begrenzungsrechtecks).
- Rückgabetyp:
- miniworlds.worlds.hex_world.hex_coords.hex_width(tile_size)[Quellcode]#
Gibt die Pixelbreite eines Hexfelds zurück (Breite des Begrenzungsrechtecks).
- Rückgabetyp:
- miniworlds.worlds.hex_world.hex_coords.nearest_axis_degrees(direction)[Quellcode]#
Gibt die Hex-Achse (in Scratch-Grad) zurück, die
directionam nächsten liegt.Die sechs Hex-Achsen sind 30, 90, 150, 210, 270 und 330 Grad (0 = oben, im Uhrzeigersinn). Jeder andere Winkel wird auf die nächste Achse gerundet, daher ist ein Bewegungsschritt immer genau ein Hexfeld. Bei Gleichstand wird zur nächsthöheren Achse gerundet.
- Rückgabetyp:
- miniworlds.worlds.hex_world.hex_coords.neighbour_offset_deltas(row_parity)[Quellcode]#
Gibt die Offset-Deltas der sechs Nachbarn für eine Zeilenparität zurück.
Die Deltas folgen der Reihenfolge von
CUBE_DIRECTIONS:"o","so","sw","w","nw","no". Es kann jede ganzzahlige Zeile übergeben werden; nur ihre Parität zählt.
- miniworlds.worlds.hex_world.hex_coords.offset_to_cube(position)[Quellcode]#
Wandelt Odd-r-Offset-Koordinaten
(Spalte, Zeile)in Würfelkoordinaten um.
- miniworlds.worlds.hex_world.hex_coords.pixel_to_cube(pixel, tile_size)[Quellcode]#
Gibt die Würfelkoordinaten des Hexfelds zurück, das eine Pixelposition enthält.
- miniworlds.worlds.hex_world.hex_coords.ring_offset_deltas(row_parity, radius)[Quellcode]#
Gibt die Offset-Deltas aller Hexfelder im Abstand von genau
radiuszurück.Die Reihenfolge ist die Ring-Reihenfolge von
cube_ring. Beiradius0 ist(0, 0)das einzige Delta; bei negativemradiusist das Ergebnis leer. Es kann jede ganzzahlige Zeile übergeben werden; nur ihre Parität zählt.
- miniworlds.worlds.hex_world.hex_coords.to_offset(value)[Quellcode]#
Gibt die Offset-Position eines Positions-Tupels, einer Kachel oder eines Actors zurück.
- miniworlds.worlds.hex_world.hex_coords.world_pixel_size(columns, rows, tile_size)[Quellcode]#
Gibt die Pixelgröße einer Hex-Welt mit
columnsxrowsHexfeldern zurück.
Wegfindung in hexagonalen Welten.
Die Funktionen arbeiten mit den Kacheln einer HexWorld. Eine Kachel zu betreten kostet tile.cost (Standard: 1); Kacheln sind nicht passierbar, wenn ihr is_blocking-Flag gesetzt ist oder ein blockierender Actor (actor.is_blocking) darauf steht. Beide Regeln lassen sich mit den Callbacks blocked und cost ersetzen.
Die Wegfindung läuft in reinem Python über den Nachbar-Cache der Kacheln. Sie ist für Abfragen auf Anforderung gedacht (ein Klick, ein Zug), nicht dafür, in jedem Frame für Hunderte Actors aufgerufen zu werden.
- miniworlds.worlds.hex_world.hex_pathfinding.find_nearest(world, start, is_target, blocked=None, cost=None, max_cost=None, include_start=False)[Quellcode]#
Gibt den günstigsten Weg zum nächstgelegenen Hexfeld zurück, das
is_targeterfüllt.Ein Ziel darf blockiert sein, zum Beispiel ein Gegner, der sein eigenes Hexfeld blockiert: Der Weg endet auf dem Ziel. Nur die Hexfelder auf dem Weg müssen passierbar sein.
- Rückgabetyp:
- Parameter:
world – Die Hex-Welt.
start – Startfeld (Position, Kachel oder Actor).
is_target – Funktion
is_target(tile) -> bool.blocked – Optionales
blocked(tile) -> bool, siehefind_path.cost – Optionales
cost(tile) -> float, siehefind_path.max_cost – Optionales Budget; Ziele, die mehr kosten, werden ignoriert.
include_start – Wenn
True, kann das Startfeld selbst das Ziel sein.
- Rückgabe:
Die Kacheln vom Start bis zum nächstgelegenen Ziel, beide eingeschlossen, oder eine leere Liste, wenn kein Ziel erreichbar ist.
- miniworlds.worlds.hex_world.hex_pathfinding.find_path(world, start, goal, blocked=None, cost=None, max_cost=None, min_cost=None)[Quellcode]#
Gibt den günstigsten Weg zwischen zwei Hexfeldern zurück (A*).
- Rückgabetyp:
- Parameter:
world – Die Hex-Welt.
start – Startfeld (Position, Kachel oder Actor).
goal – Zielfeld (Position, Kachel oder Actor).
blocked – Optionales
blocked(tile) -> bool; ersetzt die Standardregel (Kachel-Flag oder blockierender Actor).cost – Optionales
cost(tile) -> floatfür das Betreten einer Kachel; ersetzttile.cost. Kosten dürfen nicht negativ sein.max_cost – Optionales Budget; Wege, die mehr kosten, werden nicht zurückgegeben.
min_cost – Günstigste Schrittkosten, zur Beschleunigung der Suche. Nur zusammen mit einer eigenen
cost-Funktion nötig; ein zu großer Wert kann einen Weg liefern, der nicht der günstigste ist.
- Rückgabe:
Die Kacheln vom Start bis zum Ziel, beide eingeschlossen, oder eine leere Liste, wenn das Ziel blockiert, unerreichbar oder zu teuer ist.
- miniworlds.worlds.hex_world.hex_pathfinding.get_path_cost(path, cost=None)[Quellcode]#
Gibt die Kosten eines Wegs zurück: die Summe der Kosten aller Hexfelder außer dem ersten.
- Rückgabetyp:
- Parameter:
path – Eine Liste von Kacheln, zum Beispiel das Ergebnis von
find_path.cost – Optionales
cost(tile) -> float, siehefind_path.
- miniworlds.worlds.hex_world.hex_pathfinding.get_reachable_tiles(world, start, max_cost, blocked=None, cost=None)[Quellcode]#
Gibt alle Hexfelder zurück, die innerhalb eines Bewegungsbudgets erreichbar sind (Dijkstra).
- Rückgabetyp:
- Parameter:
world – Die Hex-Welt.
start – Startfeld (Position, Kachel oder Actor).
max_cost – Bewegungsbudget; mit Standardkosten ist das die Anzahl der Schritte.
blocked – Optionales
blocked(tile) -> bool, siehefind_path.cost – Optionales
cost(tile) -> float, siehefind_path.
- Rückgabe:
Die erreichbaren Kacheln einschließlich der Startkachel, von der günstigsten zur teuersten sortiert.
- miniworlds.worlds.hex_world.hex_pathfinding.has_line_of_sight(world, start, goal, blocked=None)[Quellcode]#
Gibt zurück, ob zwischen zwei Hexfeldern kein blockiertes Hexfeld liegt.
Es zählen nur die Hexfelder echt zwischen Start und Ziel, daher kann ein blockiertes Ziel (zum Beispiel ein Gegner, der sein eigenes Hexfeld blockiert) gesehen werden.
- Rückgabetyp: