# {py:mod}`simvx.core.tilemap`

```{py:module} simvx.core.tilemap
```

```{autodoc2-docstring} simvx.core.tilemap
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`TileData <simvx.core.tilemap.TileData>`
  - ```{autodoc2-docstring} simvx.core.tilemap.TileData
    :summary:
    ```
* - {py:obj}`TileSet <simvx.core.tilemap.TileSet>`
  - ```{autodoc2-docstring} simvx.core.tilemap.TileSet
    :summary:
    ```
* - {py:obj}`TileMapLayer <simvx.core.tilemap.TileMapLayer>`
  - ```{autodoc2-docstring} simvx.core.tilemap.TileMapLayer
    :summary:
    ```
* - {py:obj}`TileMap <simvx.core.tilemap.TileMap>`
  - ```{autodoc2-docstring} simvx.core.tilemap.TileMap
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`__all__ <simvx.core.tilemap.__all__>`
  - ```{autodoc2-docstring} simvx.core.tilemap.__all__
    :summary:
    ```
* - {py:obj}`CHUNK_SIZE <simvx.core.tilemap.CHUNK_SIZE>`
  - ```{autodoc2-docstring} simvx.core.tilemap.CHUNK_SIZE
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.tilemap.__all__
:value: >
   ['TileData', 'TileSet', 'TileMapLayer', 'TileMap']

```{autodoc2-docstring} simvx.core.tilemap.__all__
```

````

`````{py:class} TileData
:canonical: simvx.core.tilemap.TileData

```{autodoc2-docstring} simvx.core.tilemap.TileData
```

````{py:attribute} texture_region
:canonical: simvx.core.tilemap.TileData.texture_region
:type: tuple[int, int, int, int]
:value: >
   (0, 0, 0, 0)

```{autodoc2-docstring} simvx.core.tilemap.TileData.texture_region
```

````

````{py:attribute} collision_shapes
:canonical: simvx.core.tilemap.TileData.collision_shapes
:type: list
:value: >
   'field(...)'

```{autodoc2-docstring} simvx.core.tilemap.TileData.collision_shapes
```

````

````{py:attribute} navigation_polygon
:canonical: simvx.core.tilemap.TileData.navigation_polygon
:type: list | None
:value: >
   None

```{autodoc2-docstring} simvx.core.tilemap.TileData.navigation_polygon
```

````

````{py:attribute} custom_data
:canonical: simvx.core.tilemap.TileData.custom_data
:type: dict
:value: >
   'field(...)'

```{autodoc2-docstring} simvx.core.tilemap.TileData.custom_data
```

````

````{py:attribute} animation_frames
:canonical: simvx.core.tilemap.TileData.animation_frames
:type: list[int] | None
:value: >
   None

```{autodoc2-docstring} simvx.core.tilemap.TileData.animation_frames
```

````

````{py:attribute} animation_speed
:canonical: simvx.core.tilemap.TileData.animation_speed
:type: float
:value: >
   5.0

```{autodoc2-docstring} simvx.core.tilemap.TileData.animation_speed
```

````

````{py:attribute} terrain_type
:canonical: simvx.core.tilemap.TileData.terrain_type
:type: str
:value: <Multiline-String>

```{autodoc2-docstring} simvx.core.tilemap.TileData.terrain_type
```

````

````{py:attribute} terrain_set
:canonical: simvx.core.tilemap.TileData.terrain_set
:type: int
:value: >
   0

```{autodoc2-docstring} simvx.core.tilemap.TileData.terrain_set
```

````

````{py:attribute} terrain_bits
:canonical: simvx.core.tilemap.TileData.terrain_bits
:type: int
:value: >
   0

```{autodoc2-docstring} simvx.core.tilemap.TileData.terrain_bits
```

````

`````

`````{py:class} TileSet(tile_size: tuple[int, int] = (16, 16))
:canonical: simvx.core.tilemap.TileSet

```{autodoc2-docstring} simvx.core.tilemap.TileSet
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.tilemap.TileSet.__init__
```

````{py:method} add_tile(tile_data: simvx.core.tilemap.TileData | None = None) -> int
:canonical: simvx.core.tilemap.TileSet.add_tile

```{autodoc2-docstring} simvx.core.tilemap.TileSet.add_tile
```

````

````{py:method} get_tile(tile_id: int) -> simvx.core.tilemap.TileData | None
:canonical: simvx.core.tilemap.TileSet.get_tile

```{autodoc2-docstring} simvx.core.tilemap.TileSet.get_tile
```

````

````{py:method} remove_tile(tile_id: int)
:canonical: simvx.core.tilemap.TileSet.remove_tile

```{autodoc2-docstring} simvx.core.tilemap.TileSet.remove_tile
```

````

````{py:property} tile_count
:canonical: simvx.core.tilemap.TileSet.tile_count
:type: int

```{autodoc2-docstring} simvx.core.tilemap.TileSet.tile_count
```

````

````{py:method} create_from_grid(atlas_width: int, atlas_height: int) -> list[int]
:canonical: simvx.core.tilemap.TileSet.create_from_grid

```{autodoc2-docstring} simvx.core.tilemap.TileSet.create_from_grid
```

````

````{py:method} add_terrain_set(set_id: int = 0)
:canonical: simvx.core.tilemap.TileSet.add_terrain_set

```{autodoc2-docstring} simvx.core.tilemap.TileSet.add_terrain_set
```

````

````{py:method} set_terrain_tile(set_id: int, bitmask: int, tile_id: int)
:canonical: simvx.core.tilemap.TileSet.set_terrain_tile

```{autodoc2-docstring} simvx.core.tilemap.TileSet.set_terrain_tile
```

````

````{py:method} get_terrain_tile(set_id: int, bitmask: int) -> int | None
:canonical: simvx.core.tilemap.TileSet.get_terrain_tile

```{autodoc2-docstring} simvx.core.tilemap.TileSet.get_terrain_tile
```

````

`````

````{py:data} CHUNK_SIZE
:canonical: simvx.core.tilemap.CHUNK_SIZE
:value: >
   32

```{autodoc2-docstring} simvx.core.tilemap.CHUNK_SIZE
```

````

`````{py:class} TileMapLayer(name: str = 'Layer 0')
:canonical: simvx.core.tilemap.TileMapLayer

```{autodoc2-docstring} simvx.core.tilemap.TileMapLayer
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.tilemap.TileMapLayer.__init__
```

````{py:method} set_cell(x: int, y: int, tile_id: int)
:canonical: simvx.core.tilemap.TileMapLayer.set_cell

```{autodoc2-docstring} simvx.core.tilemap.TileMapLayer.set_cell
```

````

````{py:method} get_cell(x: int, y: int) -> int
:canonical: simvx.core.tilemap.TileMapLayer.get_cell

```{autodoc2-docstring} simvx.core.tilemap.TileMapLayer.get_cell
```

````

````{py:method} erase_cell(x: int, y: int)
:canonical: simvx.core.tilemap.TileMapLayer.erase_cell

```{autodoc2-docstring} simvx.core.tilemap.TileMapLayer.erase_cell
```

````

````{py:method} get_used_cells() -> list[tuple[int, int]]
:canonical: simvx.core.tilemap.TileMapLayer.get_used_cells

```{autodoc2-docstring} simvx.core.tilemap.TileMapLayer.get_used_cells
```

````

````{py:method} get_used_rect() -> tuple[int, int, int, int]
:canonical: simvx.core.tilemap.TileMapLayer.get_used_rect

```{autodoc2-docstring} simvx.core.tilemap.TileMapLayer.get_used_rect
```

````

`````

`````{py:class} TileMap(name='TileMap', **kwargs)
:canonical: simvx.core.tilemap.TileMap

Bases: {py:obj}`simvx.core.engine.Node2D`

```{autodoc2-docstring} simvx.core.tilemap.TileMap
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.tilemap.TileMap.__init__
```

````{py:attribute} tile_set
:canonical: simvx.core.tilemap.TileMap.tile_set
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.tilemap.TileMap.tile_set
```

````

````{py:attribute} cell_size
:canonical: simvx.core.tilemap.TileMap.cell_size
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.tilemap.TileMap.cell_size
```

````

````{py:method} add_layer(name: str = '') -> int
:canonical: simvx.core.tilemap.TileMap.add_layer

```{autodoc2-docstring} simvx.core.tilemap.TileMap.add_layer
```

````

````{py:method} get_layer(index: int) -> simvx.core.tilemap.TileMapLayer
:canonical: simvx.core.tilemap.TileMap.get_layer

```{autodoc2-docstring} simvx.core.tilemap.TileMap.get_layer
```

````

````{py:property} layer_count
:canonical: simvx.core.tilemap.TileMap.layer_count
:type: int

```{autodoc2-docstring} simvx.core.tilemap.TileMap.layer_count
```

````

````{py:method} set_cell(layer: int, x: int, y: int, tile_id: int)
:canonical: simvx.core.tilemap.TileMap.set_cell

```{autodoc2-docstring} simvx.core.tilemap.TileMap.set_cell
```

````

````{py:method} get_cell(layer: int, x: int, y: int) -> int
:canonical: simvx.core.tilemap.TileMap.get_cell

```{autodoc2-docstring} simvx.core.tilemap.TileMap.get_cell
```

````

````{py:method} erase_cell(layer: int, x: int, y: int)
:canonical: simvx.core.tilemap.TileMap.erase_cell

```{autodoc2-docstring} simvx.core.tilemap.TileMap.erase_cell
```

````

````{py:method} world_to_map(world_pos: tuple[float, float]) -> tuple[int, int]
:canonical: simvx.core.tilemap.TileMap.world_to_map

```{autodoc2-docstring} simvx.core.tilemap.TileMap.world_to_map
```

````

````{py:method} map_to_world(map_pos: tuple[int, int]) -> tuple[float, float]
:canonical: simvx.core.tilemap.TileMap.map_to_world

```{autodoc2-docstring} simvx.core.tilemap.TileMap.map_to_world
```

````

````{py:method} get_neighbor_bitmask(layer: int, x: int, y: int) -> int
:canonical: simvx.core.tilemap.TileMap.get_neighbor_bitmask

```{autodoc2-docstring} simvx.core.tilemap.TileMap.get_neighbor_bitmask
```

````

````{py:method} auto_tile(layer: int, x: int, y: int, terrain_set: int = 0)
:canonical: simvx.core.tilemap.TileMap.auto_tile

```{autodoc2-docstring} simvx.core.tilemap.TileMap.auto_tile
```

````

````{py:attribute} z_index
:canonical: simvx.core.tilemap.TileMap.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.tilemap.TileMap.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.tilemap.TileMap.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.tilemap.TileMap.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.tilemap.TileMap.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.tilemap.TileMap.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.tilemap.TileMap.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.tilemap.TileMap.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.tilemap.TileMap.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.tilemap.TileMap.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.tilemap.TileMap.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.tilemap.TileMap.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.tilemap.TileMap.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.tilemap.TileMap.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.tilemap.TileMap.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.tilemap.TileMap.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.tilemap.TileMap.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.tilemap.TileMap.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.tilemap.TileMap.wrap_screen

````

````{py:attribute} script_error_raised
:canonical: simvx.core.tilemap.TileMap.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.tilemap.TileMap.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.tilemap.TileMap.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.tilemap.TileMap.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.tilemap.TileMap.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.tilemap.TileMap.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.tilemap.TileMap.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.tilemap.TileMap.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.tilemap.TileMap.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.tilemap.TileMap.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.tilemap.TileMap.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.tilemap.TileMap.find_all

````

````{py:property} path
:canonical: simvx.core.tilemap.TileMap.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.tilemap.TileMap.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.tilemap.TileMap.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.tilemap.TileMap.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.tilemap.TileMap.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.tilemap.TileMap.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.tilemap.TileMap.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.tilemap.TileMap.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.tilemap.TileMap.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.tilemap.TileMap.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.tilemap.TileMap.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.tilemap.TileMap.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.tilemap.TileMap.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.tilemap.TileMap.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.tilemap.TileMap.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.tilemap.TileMap.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.tilemap.TileMap.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.tilemap.TileMap.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.tilemap.TileMap.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.tilemap.TileMap.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.tilemap.TileMap.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.tilemap.TileMap.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.tilemap.TileMap.__repr__

````

`````