mirror of
https://github.com/OMGeeky/pytiled_parser.git
synced 2025-12-26 17:02:28 +01:00
64 lines
2.4 KiB
Python
64 lines
2.4 KiB
Python
from pathlib import Path
|
|
from typing import Dict, List, Optional
|
|
|
|
import attr
|
|
|
|
from pytiled_parser.common_types import Color, Size
|
|
from pytiled_parser.layer import Layer
|
|
from pytiled_parser.properties import Properties
|
|
from pytiled_parser.tileset import Tileset
|
|
|
|
TilesetDict = Dict[int, Tileset]
|
|
|
|
|
|
@attr.s(auto_attribs=True)
|
|
class TiledMap:
|
|
"""Object for storing a TMX with all associated layers and properties.
|
|
|
|
See: https://doc.mapeditor.org/en/stable/reference/tmx-map-format/#map
|
|
|
|
Attributes:
|
|
infinite: If the map is infinite or not.
|
|
layers: List of layer objects by draw order.
|
|
map_size: The map width in tiles.
|
|
next_layer_id: Stores the next available ID for new layers.
|
|
next_object_id: Stores the next available ID for new objects.
|
|
orientation: Map orientation. Tiled supports "orthogonal", "isometric",
|
|
"staggered" and "hexagonal"
|
|
render_order: The order in which tiles on tile layers are rendered. Valid values
|
|
are right-down, right-up, left-down and left-up. In all cases, the map is
|
|
tiled_version: The Tiled version used to save the file. May be a date (for
|
|
snapshot builds).
|
|
drawn row-by-row. (only supported for orthogonal maps at the moment)
|
|
tile_size: The size of a tile.
|
|
tilesets: Dict of Tileset where Key is the firstgid and the value is the Tileset
|
|
version: The JSON format version.
|
|
background_color: The background color of the map.
|
|
properties: The properties of the Map.
|
|
hex_side_length: Only for hexagonal maps. Determines the width or height
|
|
(depending on the staggered axis) of the tile's edge, in pixels.
|
|
stagger_axis: For staggered and hexagonal maps, determines which axis ("x" or
|
|
"y") is staggered.
|
|
stagger_index: For staggered and hexagonal maps, determines whether the "even"
|
|
or "odd" indexes along the staggered axis are shifted.
|
|
"""
|
|
|
|
infinite: bool
|
|
layers: List[Layer]
|
|
map_size: Size
|
|
next_layer_id: Optional[int]
|
|
next_object_id: int
|
|
orientation: str
|
|
render_order: str
|
|
tiled_version: str
|
|
tile_size: Size
|
|
tilesets: TilesetDict
|
|
version: str
|
|
|
|
map_file: Optional[Path] = None
|
|
background_color: Optional[Color] = None
|
|
properties: Optional[Properties] = None
|
|
hex_side_length: Optional[int] = None
|
|
stagger_axis: Optional[str] = None
|
|
stagger_index: Optional[str] = None
|