Tile¶
-
class
games.pirates.tile.Tile¶ Bases:
games.pirates.game_object.GameObjectThe class representing the Tile in the Pirates game.
A Tile in the game that makes up the 2D map grid.
-
property
decoration¶ (Visualizer only) Whether this tile is deep sea or grassy. This has no effect on gameplay, but feel free to use it if you want.
- Type
bool
-
directions= ['North', 'East', 'South', 'West']¶ The valid directions that tiles can be in, “North”, “East”, “South”, or “West”
- Type
int
-
property
game_object_name¶ String representing the top level Class that this game object is an instance of. Used for reflection to create new instances on clients, but exposed for convenience should AIs want this data.
- Type
str
-
get_neighbors() → List[games.pirates.tile.Tile]¶ Gets the neighbors of this Tile
- Returns
The list of neighboring Tiles of this Tile.
- Return type
list[games.pirates.tile.Tile]
-
property
gold¶ The amount of gold buried on this tile.
- Type
int
-
has_neighbor(tile: games.pirates.tile.Tile) → bool¶ Checks if this Tile has a specific neighboring Tile.
- Parameters
tile (games.pirates.tile.Tile) – The Tile to check against.
- Returns
True if the tile is a neighbor of this Tile, False otherwise
- Return type
bool
-
property
id¶ A unique id for each instance of a GameObject or a sub class. Used for client and server communication. Should never change value after being set.
- Type
str
-
is_pathable() → bool¶ Checks if a Tile is pathable to units
- Returns
True if pathable, False otherwise.
- Return type
bool
-
log(message: str) → None¶ Adds a message to this GameObject’s logs. Intended for your own debugging purposes, as strings stored here are saved in the gamelog.
- Parameters
message (str) – A string to add to this GameObject’s log. Intended for debugging.
-
property
logs¶ Any strings logged will be stored here. Intended for debugging.
- Type
list[str]
-
property
port¶ The Port on this Tile if present, otherwise None.
- Type
games.pirates.port.Port or None
-
property
tile_east¶ The Tile to the ‘East’ of this one (x+1, y). None if out of bounds of the map.
- Type
games.pirates.tile.Tile or None
-
property
tile_north¶ The Tile to the ‘North’ of this one (x, y-1). None if out of bounds of the map.
- Type
games.pirates.tile.Tile or None
-
property
tile_south¶ The Tile to the ‘South’ of this one (x, y+1). None if out of bounds of the map.
- Type
games.pirates.tile.Tile or None
-
property
tile_west¶ The Tile to the ‘West’ of this one (x-1, y). None if out of bounds of the map.
- Type
games.pirates.tile.Tile or None
-
property
type¶ The type of Tile this is (‘water’ or ‘land’).
- Type
‘water’ or ‘land’
-
property
unit¶ The Unit on this Tile if present, otherwise None.
- Type
games.pirates.unit.Unit or None
-
property
x¶ The x (horizontal) position of this Tile.
- Type
int
-
property
y¶ The y (vertical) position of this Tile.
- Type
int
-
property