:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/TileData.xml. .. _class_TileData: TileData ======== **Inherits:** :ref:`Object` Properties ---------- +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`flip_h` | ``false`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`flip_v` | ``false`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`Material` | :ref:`material` | | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`modulate` | ``Color(1, 1, 1, 1)`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`probability` | ``1.0`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`terrain` | ``-1`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`terrain_set` | ``-1`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`Vector2i` | :ref:`texture_offset` | ``Vector2i(0, 0)`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`transpose` | ``false`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`y_sort_origin` | ``0`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`z_index` | ``0`` | +---------------------------------+---------------------------------------------------------------+-----------------------+ Methods ------- +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_collision_polygon` **(** :ref:`int` layer_id **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_collision_polygon_one_way_margin` **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`get_collision_polygon_points` **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_polygons_count` **(** :ref:`int` layer_id **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_constant_angular_velocity` **(** :ref:`int` layer_id **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_constant_linear_velocity` **(** :ref:`int` layer_id **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_custom_data` **(** :ref:`String` layer_name **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_custom_data_by_layer_id` **(** :ref:`int` layer_id **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NavigationPolygon` | :ref:`get_navigation_polygon` **(** :ref:`int` layer_id **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`OccluderPolygon2D` | :ref:`get_occluder` **(** :ref:`int` layer_id **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_terrain_peering_bit` **(** :ref:`CellNeighbor` peering_bit **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_collision_polygon_one_way` **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_collision_polygon` **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_polygon_one_way` **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`bool` one_way **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_polygon_one_way_margin` **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`float` one_way_margin **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_polygon_points` **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`PackedVector2Array` polygon **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_polygons_count` **(** :ref:`int` layer_id, :ref:`int` polygons_count **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_constant_angular_velocity` **(** :ref:`int` layer_id, :ref:`float` velocity **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_constant_linear_velocity` **(** :ref:`int` layer_id, :ref:`Vector2` velocity **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_data` **(** :ref:`String` layer_name, :ref:`Variant` value **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_data_by_layer_id` **(** :ref:`int` layer_id, :ref:`Variant` value **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_polygon` **(** :ref:`int` layer_id, :ref:`NavigationPolygon` navigation_polygon **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_occluder` **(** :ref:`int` layer_id, :ref:`OccluderPolygon2D` occluder_polygon **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_terrain_peering_bit` **(** :ref:`CellNeighbor` peering_bit, :ref:`int` terrain **)** | +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- .. _class_TileData_signal_changed: - **changed** **(** **)** Property Descriptions --------------------- .. _class_TileData_property_flip_h: - :ref:`bool` **flip_h** +-----------+-------------------+ | *Default* | ``false`` | +-----------+-------------------+ | *Setter* | set_flip_h(value) | +-----------+-------------------+ | *Getter* | get_flip_h() | +-----------+-------------------+ ---- .. _class_TileData_property_flip_v: - :ref:`bool` **flip_v** +-----------+-------------------+ | *Default* | ``false`` | +-----------+-------------------+ | *Setter* | set_flip_v(value) | +-----------+-------------------+ | *Getter* | get_flip_v() | +-----------+-------------------+ ---- .. _class_TileData_property_material: - :ref:`Material` **material** +----------+---------------------+ | *Setter* | set_material(value) | +----------+---------------------+ | *Getter* | get_material() | +----------+---------------------+ The :ref:`Material` to use for this ``TileData``. This can be a :ref:`CanvasItemMaterial` to use the default shader, or a :ref:`ShaderMaterial` to use a custom shader. ---- .. _class_TileData_property_modulate: - :ref:`Color` **modulate** +-----------+-----------------------+ | *Default* | ``Color(1, 1, 1, 1)`` | +-----------+-----------------------+ | *Setter* | set_modulate(value) | +-----------+-----------------------+ | *Getter* | get_modulate() | +-----------+-----------------------+ ---- .. _class_TileData_property_probability: - :ref:`float` **probability** +-----------+------------------------+ | *Default* | ``1.0`` | +-----------+------------------------+ | *Setter* | set_probability(value) | +-----------+------------------------+ | *Getter* | get_probability() | +-----------+------------------------+ ---- .. _class_TileData_property_terrain: - :ref:`int` **terrain** +-----------+--------------------+ | *Default* | ``-1`` | +-----------+--------------------+ | *Setter* | set_terrain(value) | +-----------+--------------------+ | *Getter* | get_terrain() | +-----------+--------------------+ ---- .. _class_TileData_property_terrain_set: - :ref:`int` **terrain_set** +-----------+------------------------+ | *Default* | ``-1`` | +-----------+------------------------+ | *Setter* | set_terrain_set(value) | +-----------+------------------------+ | *Getter* | get_terrain_set() | +-----------+------------------------+ ---- .. _class_TileData_property_texture_offset: - :ref:`Vector2i` **texture_offset** +-----------+---------------------------+ | *Default* | ``Vector2i(0, 0)`` | +-----------+---------------------------+ | *Setter* | set_texture_offset(value) | +-----------+---------------------------+ | *Getter* | get_texture_offset() | +-----------+---------------------------+ ---- .. _class_TileData_property_transpose: - :ref:`bool` **transpose** +-----------+----------------------+ | *Default* | ``false`` | +-----------+----------------------+ | *Setter* | set_transpose(value) | +-----------+----------------------+ | *Getter* | get_transpose() | +-----------+----------------------+ ---- .. _class_TileData_property_y_sort_origin: - :ref:`int` **y_sort_origin** +-----------+--------------------------+ | *Default* | ``0`` | +-----------+--------------------------+ | *Setter* | set_y_sort_origin(value) | +-----------+--------------------------+ | *Getter* | get_y_sort_origin() | +-----------+--------------------------+ ---- .. _class_TileData_property_z_index: - :ref:`int` **z_index** +-----------+--------------------+ | *Default* | ``0`` | +-----------+--------------------+ | *Setter* | set_z_index(value) | +-----------+--------------------+ | *Getter* | get_z_index() | +-----------+--------------------+ Method Descriptions ------------------- .. _class_TileData_method_add_collision_polygon: - void **add_collision_polygon** **(** :ref:`int` layer_id **)** Adds a collision polygon to the tile on the given TileSet physics layer. ---- .. _class_TileData_method_get_collision_polygon_one_way_margin: - :ref:`float` **get_collision_polygon_one_way_margin** **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| Returns the one-way margin (for one-way platforms) of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_get_collision_polygon_points: - :ref:`PackedVector2Array` **get_collision_polygon_points** **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| Returns the points of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_get_collision_polygons_count: - :ref:`int` **get_collision_polygons_count** **(** :ref:`int` layer_id **)** |const| Returns how many polygons the tile has for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_get_constant_angular_velocity: - :ref:`float` **get_constant_angular_velocity** **(** :ref:`int` layer_id **)** |const| Returns the constant angular velocity applied to objects colliding with this tile. ---- .. _class_TileData_method_get_constant_linear_velocity: - :ref:`Vector2` **get_constant_linear_velocity** **(** :ref:`int` layer_id **)** |const| Returns the constant linear velocity applied to objects colliding with this tile. ---- .. _class_TileData_method_get_custom_data: - :ref:`Variant` **get_custom_data** **(** :ref:`String` layer_name **)** |const| Returns the custom data value for custom data layer named ``layer_name``. ---- .. _class_TileData_method_get_custom_data_by_layer_id: - :ref:`Variant` **get_custom_data_by_layer_id** **(** :ref:`int` layer_id **)** |const| Returns the custom data value for custom data layer with index ``layer_id``. ---- .. _class_TileData_method_get_navigation_polygon: - :ref:`NavigationPolygon` **get_navigation_polygon** **(** :ref:`int` layer_id **)** |const| Returns the navigation polygon of the tile for the TileSet navigation layer with index ``layer_id``. ---- .. _class_TileData_method_get_occluder: - :ref:`OccluderPolygon2D` **get_occluder** **(** :ref:`int` layer_id **)** |const| Returns the occluder polygon of the tile for the TileSet occlusion layer with index ``layer_id``. ---- .. _class_TileData_method_get_terrain_peering_bit: - :ref:`int` **get_terrain_peering_bit** **(** :ref:`CellNeighbor` peering_bit **)** |const| Returns the tile's terrain bit for the given ``peering_bit`` direction. ---- .. _class_TileData_method_is_collision_polygon_one_way: - :ref:`bool` **is_collision_polygon_one_way** **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** |const| Returns whether one-way collisions are enabled for the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_remove_collision_polygon: - void **remove_collision_polygon** **(** :ref:`int` layer_id, :ref:`int` polygon_index **)** Removes the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_set_collision_polygon_one_way: - void **set_collision_polygon_one_way** **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`bool` one_way **)** Enables/disables one-way collisions on the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_set_collision_polygon_one_way_margin: - void **set_collision_polygon_one_way_margin** **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`float` one_way_margin **)** Enables/disables one-way collisions on the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_set_collision_polygon_points: - void **set_collision_polygon_points** **(** :ref:`int` layer_id, :ref:`int` polygon_index, :ref:`PackedVector2Array` polygon **)** Sets the points of the polygon at index ``polygon_index`` for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_set_collision_polygons_count: - void **set_collision_polygons_count** **(** :ref:`int` layer_id, :ref:`int` polygons_count **)** Sets the polygons count for TileSet physics layer with index ``layer_id``. ---- .. _class_TileData_method_set_constant_angular_velocity: - void **set_constant_angular_velocity** **(** :ref:`int` layer_id, :ref:`float` velocity **)** Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile. ---- .. _class_TileData_method_set_constant_linear_velocity: - void **set_constant_linear_velocity** **(** :ref:`int` layer_id, :ref:`Vector2` velocity **)** Sets the constant linear velocity. This does not move the tile. This linear velocity is applied to objects colliding with this tile. This is useful to create conveyor belts. ---- .. _class_TileData_method_set_custom_data: - void **set_custom_data** **(** :ref:`String` layer_name, :ref:`Variant` value **)** Sets the tile's custom data value for the TileSet custom data layer with name ``layer_name``. ---- .. _class_TileData_method_set_custom_data_by_layer_id: - void **set_custom_data_by_layer_id** **(** :ref:`int` layer_id, :ref:`Variant` value **)** Sets the tile's custom data value for the TileSet custom data layer with index ``layer_id``. ---- .. _class_TileData_method_set_navigation_polygon: - void **set_navigation_polygon** **(** :ref:`int` layer_id, :ref:`NavigationPolygon` navigation_polygon **)** Sets the navigation polygon for the TileSet navigation layer with index ``layer_id``. ---- .. _class_TileData_method_set_occluder: - void **set_occluder** **(** :ref:`int` layer_id, :ref:`OccluderPolygon2D` occluder_polygon **)** Sets the occluder for the TileSet occlusion layer with index ``layer_id``. ---- .. _class_TileData_method_set_terrain_peering_bit: - void **set_terrain_peering_bit** **(** :ref:`CellNeighbor` peering_bit, :ref:`int` terrain **)** Sets the tile's terrain bit for the given ``peering_bit`` direction. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`