Files
godot-docs/classes/class_tileset.rst
2018-01-12 08:52:43 +01:00

351 lines
35 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the TileSet.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_TileSet:
TileSet
=======
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Tile library for tilemaps.
Member Functions
----------------
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`_forward_subtile_selection<class_TileSet__forward_subtile_selection>` **(** :ref:`int<class_int>` autotile_id, :ref:`int<class_int>` bitmask, :ref:`Object<class_object>` tilemap, :ref:`Vector2<class_vector2>` tile_location **)** virtual |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_is_tile_bound<class_TileSet__is_tile_bound>` **(** :ref:`int<class_int>` drawn_id, :ref:`int<class_int>` neighbor_id **)** virtual |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`autotile_get_bitmask_mode<class_TileSet_autotile_get_bitmask_mode>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`autotile_set_bitmask_mode<class_TileSet_autotile_set_bitmask_mode>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` mode **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_TileSet_clear>` **(** **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_tile<class_TileSet_create_tile>` **(** :ref:`int<class_int>` id **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_tile_by_name<class_TileSet_find_tile_by_name>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_last_unused_tile_id<class_TileSet_get_last_unused_tile_id>` **(** **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_tiles_ids<class_TileSet_get_tiles_ids>` **(** **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_tile<class_TileSet_remove_tile>` **(** :ref:`int<class_int>` id **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_add_shape<class_TileSet_tile_add_shape>` **(** :ref:`int<class_int>` id, :ref:`Shape2D<class_shape2d>` shape, :ref:`Transform2D<class_transform2d>` shape_transform, :ref:`bool<class_bool>` one_way=false, :ref:`Vector2<class_vector2>` autotile_coord=Vector2( 0, 0 ) **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`OccluderPolygon2D<class_occluderpolygon2d>` | :ref:`tile_get_light_occluder<class_TileSet_tile_get_light_occluder>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ShaderMaterial<class_shadermaterial>` | :ref:`tile_get_material<class_TileSet_tile_get_material>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`tile_get_name<class_TileSet_tile_get_name>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NavigationPolygon<class_navigationpolygon>` | :ref:`tile_get_navigation_polygon<class_TileSet_tile_get_navigation_polygon>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`tile_get_navigation_polygon_offset<class_TileSet_tile_get_navigation_polygon_offset>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`tile_get_normal_map<class_TileSet_tile_get_normal_map>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`tile_get_occluder_offset<class_TileSet_tile_get_occluder_offset>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`tile_get_region<class_TileSet_tile_get_region>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shape2D<class_shape2d>` | :ref:`tile_get_shape<class_TileSet_tile_get_shape>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`tile_get_shape_count<class_TileSet_tile_get_shape_count>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`tile_get_shape_one_way<class_TileSet_tile_get_shape_one_way>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform2D<class_transform2d>` | :ref:`tile_get_shape_transform<class_TileSet_tile_get_shape_transform>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`tile_get_shapes<class_TileSet_tile_get_shapes>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`tile_get_texture<class_TileSet_tile_get_texture>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`tile_get_texture_offset<class_TileSet_tile_get_texture_offset>` **(** :ref:`int<class_int>` id **)** const |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_light_occluder<class_TileSet_tile_set_light_occluder>` **(** :ref:`int<class_int>` id, :ref:`OccluderPolygon2D<class_occluderpolygon2d>` light_occluder **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_material<class_TileSet_tile_set_material>` **(** :ref:`int<class_int>` id, :ref:`ShaderMaterial<class_shadermaterial>` material **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_name<class_TileSet_tile_set_name>` **(** :ref:`int<class_int>` id, :ref:`String<class_string>` name **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_navigation_polygon<class_TileSet_tile_set_navigation_polygon>` **(** :ref:`int<class_int>` id, :ref:`NavigationPolygon<class_navigationpolygon>` navigation_polygon **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_navigation_polygon_offset<class_TileSet_tile_set_navigation_polygon_offset>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` navigation_polygon_offset **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_normal_map<class_TileSet_tile_set_normal_map>` **(** :ref:`int<class_int>` id, :ref:`Texture<class_texture>` normal_map **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_occluder_offset<class_TileSet_tile_set_occluder_offset>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` occluder_offset **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_region<class_TileSet_tile_set_region>` **(** :ref:`int<class_int>` id, :ref:`Rect2<class_rect2>` region **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_shape<class_TileSet_tile_set_shape>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id, :ref:`Shape2D<class_shape2d>` shape **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_shape_one_way<class_TileSet_tile_set_shape_one_way>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id, :ref:`bool<class_bool>` one_way **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_shape_transform<class_TileSet_tile_set_shape_transform>` **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id, :ref:`Transform2D<class_transform2d>` shape_transform **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_shapes<class_TileSet_tile_set_shapes>` **(** :ref:`int<class_int>` id, :ref:`Array<class_array>` shapes **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_texture<class_TileSet_tile_set_texture>` **(** :ref:`int<class_int>` id, :ref:`Texture<class_texture>` texture **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`tile_set_texture_offset<class_TileSet_tile_set_texture_offset>` **(** :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` texture_offset **)** |
+----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Enums
-----
.. _enum_TileSet_BitmaskMode:
enum **BitmaskMode**
- **BITMASK_2X2** = **0**
- **BITMASK_3X3** = **1**
.. _enum_TileSet_AutotileBindings:
enum **AutotileBindings**
- **BIND_TOPLEFT** = **1**
- **BIND_TOP** = **2**
- **BIND_TOPRIGHT** = **4**
- **BIND_LEFT** = **8**
- **BIND_RIGHT** = **32**
- **BIND_BOTTOMLEFT** = **64**
- **BIND_BOTTOM** = **128**
- **BIND_BOTTOMRIGHT** = **256**
Description
-----------
A TileSet is a library of tiles for a :ref:`TileMap<class_tilemap>`. It contains a list of tiles, each consisting of a sprite and optional collision shapes.
Tiles are referenced by a unique integer ID.
Member Function Description
---------------------------
.. _class_TileSet__forward_subtile_selection:
- :ref:`Vector2<class_vector2>` **_forward_subtile_selection** **(** :ref:`int<class_int>` autotile_id, :ref:`int<class_int>` bitmask, :ref:`Object<class_object>` tilemap, :ref:`Vector2<class_vector2>` tile_location **)** virtual
.. _class_TileSet__is_tile_bound:
- :ref:`bool<class_bool>` **_is_tile_bound** **(** :ref:`int<class_int>` drawn_id, :ref:`int<class_int>` neighbor_id **)** virtual
.. _class_TileSet_autotile_get_bitmask_mode:
- :ref:`int<class_int>` **autotile_get_bitmask_mode** **(** :ref:`int<class_int>` id **)** const
.. _class_TileSet_autotile_set_bitmask_mode:
- void **autotile_set_bitmask_mode** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` mode **)**
.. _class_TileSet_clear:
- void **clear** **(** **)**
Clear all tiles.
.. _class_TileSet_create_tile:
- void **create_tile** **(** :ref:`int<class_int>` id **)**
Create a new tile which will be referenced by the given ID.
.. _class_TileSet_find_tile_by_name:
- :ref:`int<class_int>` **find_tile_by_name** **(** :ref:`String<class_string>` name **)** const
Find the first tile matching the given name.
.. _class_TileSet_get_last_unused_tile_id:
- :ref:`int<class_int>` **get_last_unused_tile_id** **(** **)** const
Return the ID following the last currently used ID, useful when creating a new tile.
.. _class_TileSet_get_tiles_ids:
- :ref:`Array<class_array>` **get_tiles_ids** **(** **)** const
Return an array of all currently used tile IDs.
.. _class_TileSet_remove_tile:
- void **remove_tile** **(** :ref:`int<class_int>` id **)**
Remove the tile referenced by the given ID.
.. _class_TileSet_tile_add_shape:
- void **tile_add_shape** **(** :ref:`int<class_int>` id, :ref:`Shape2D<class_shape2d>` shape, :ref:`Transform2D<class_transform2d>` shape_transform, :ref:`bool<class_bool>` one_way=false, :ref:`Vector2<class_vector2>` autotile_coord=Vector2( 0, 0 ) **)**
.. _class_TileSet_tile_get_light_occluder:
- :ref:`OccluderPolygon2D<class_occluderpolygon2d>` **tile_get_light_occluder** **(** :ref:`int<class_int>` id **)** const
Return the light occluder of the tile.
.. _class_TileSet_tile_get_material:
- :ref:`ShaderMaterial<class_shadermaterial>` **tile_get_material** **(** :ref:`int<class_int>` id **)** const
Return the material of the tile.
.. _class_TileSet_tile_get_name:
- :ref:`String<class_string>` **tile_get_name** **(** :ref:`int<class_int>` id **)** const
Return the name of the tile.
.. _class_TileSet_tile_get_navigation_polygon:
- :ref:`NavigationPolygon<class_navigationpolygon>` **tile_get_navigation_polygon** **(** :ref:`int<class_int>` id **)** const
Return the navigation polygon of the tile.
.. _class_TileSet_tile_get_navigation_polygon_offset:
- :ref:`Vector2<class_vector2>` **tile_get_navigation_polygon_offset** **(** :ref:`int<class_int>` id **)** const
Return the offset of the tile's navigation polygon.
.. _class_TileSet_tile_get_normal_map:
- :ref:`Texture<class_texture>` **tile_get_normal_map** **(** :ref:`int<class_int>` id **)** const
.. _class_TileSet_tile_get_occluder_offset:
- :ref:`Vector2<class_vector2>` **tile_get_occluder_offset** **(** :ref:`int<class_int>` id **)** const
Return the offset of the tile's light occluder.
.. _class_TileSet_tile_get_region:
- :ref:`Rect2<class_rect2>` **tile_get_region** **(** :ref:`int<class_int>` id **)** const
Return the tile sub-region in the texture.
.. _class_TileSet_tile_get_shape:
- :ref:`Shape2D<class_shape2d>` **tile_get_shape** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id **)** const
.. _class_TileSet_tile_get_shape_count:
- :ref:`int<class_int>` **tile_get_shape_count** **(** :ref:`int<class_int>` id **)** const
.. _class_TileSet_tile_get_shape_one_way:
- :ref:`bool<class_bool>` **tile_get_shape_one_way** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id **)** const
.. _class_TileSet_tile_get_shape_transform:
- :ref:`Transform2D<class_transform2d>` **tile_get_shape_transform** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id **)** const
.. _class_TileSet_tile_get_shapes:
- :ref:`Array<class_array>` **tile_get_shapes** **(** :ref:`int<class_int>` id **)** const
Return the array of shapes of the tile.
.. _class_TileSet_tile_get_texture:
- :ref:`Texture<class_texture>` **tile_get_texture** **(** :ref:`int<class_int>` id **)** const
Return the texture of the tile.
.. _class_TileSet_tile_get_texture_offset:
- :ref:`Vector2<class_vector2>` **tile_get_texture_offset** **(** :ref:`int<class_int>` id **)** const
Return the texture offset of the tile.
.. _class_TileSet_tile_set_light_occluder:
- void **tile_set_light_occluder** **(** :ref:`int<class_int>` id, :ref:`OccluderPolygon2D<class_occluderpolygon2d>` light_occluder **)**
Set a light occluder for the tile.
.. _class_TileSet_tile_set_material:
- void **tile_set_material** **(** :ref:`int<class_int>` id, :ref:`ShaderMaterial<class_shadermaterial>` material **)**
Set the material of the tile.
.. _class_TileSet_tile_set_name:
- void **tile_set_name** **(** :ref:`int<class_int>` id, :ref:`String<class_string>` name **)**
Set the name of the tile, for descriptive purposes.
.. _class_TileSet_tile_set_navigation_polygon:
- void **tile_set_navigation_polygon** **(** :ref:`int<class_int>` id, :ref:`NavigationPolygon<class_navigationpolygon>` navigation_polygon **)**
Set a navigation polygon for the tile.
.. _class_TileSet_tile_set_navigation_polygon_offset:
- void **tile_set_navigation_polygon_offset** **(** :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` navigation_polygon_offset **)**
Set an offset for the tile's navigation polygon.
.. _class_TileSet_tile_set_normal_map:
- void **tile_set_normal_map** **(** :ref:`int<class_int>` id, :ref:`Texture<class_texture>` normal_map **)**
.. _class_TileSet_tile_set_occluder_offset:
- void **tile_set_occluder_offset** **(** :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` occluder_offset **)**
Set an offset for the tile's light occluder.
.. _class_TileSet_tile_set_region:
- void **tile_set_region** **(** :ref:`int<class_int>` id, :ref:`Rect2<class_rect2>` region **)**
Set the tile sub-region in the texture. This is common in texture atlases.
.. _class_TileSet_tile_set_shape:
- void **tile_set_shape** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id, :ref:`Shape2D<class_shape2d>` shape **)**
.. _class_TileSet_tile_set_shape_one_way:
- void **tile_set_shape_one_way** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id, :ref:`bool<class_bool>` one_way **)**
.. _class_TileSet_tile_set_shape_transform:
- void **tile_set_shape_transform** **(** :ref:`int<class_int>` id, :ref:`int<class_int>` shape_id, :ref:`Transform2D<class_transform2d>` shape_transform **)**
.. _class_TileSet_tile_set_shapes:
- void **tile_set_shapes** **(** :ref:`int<class_int>` id, :ref:`Array<class_array>` shapes **)**
Set an array of shapes for the tile, enabling physics to collide with it.
.. _class_TileSet_tile_set_texture:
- void **tile_set_texture** **(** :ref:`int<class_int>` id, :ref:`Texture<class_texture>` texture **)**
Set the texture of the tile.
.. _class_TileSet_tile_set_texture_offset:
- void **tile_set_texture_offset** **(** :ref:`int<class_int>` id, :ref:`Vector2<class_vector2>` texture_offset **)**
Set the texture offset of the tile.