Class reference
TileData
Inherits Object
Settings for a single tile in a TileSet.
Description
TileData object represents a single tile in a TileSet. It is usually edited using the tileset editor, but it can be modified at runtime using TileMapLayer._tile_data_runtime_update().
Properties
bool flip_h = false
bool flip_h = falseIf true, the tile will have its texture flipped horizontally.
bool flip_v = false
bool flip_v = falseIf true, the tile will have its texture flipped vertically.
Material material
Material materialThe Material to use for this TileData. This can be a CanvasItemMaterial to use the default shader, or a ShaderMaterial to use a custom shader.
Color modulate = Color(1, 1, 1, 1)
Color modulate = Color(1, 1, 1, 1)Color modulation of the tile.
float probability = 1.0
float probability = 1.0Relative probability of this tile being selected when drawing a pattern of random tiles.
int terrain = -1
int terrain = -1ID of the terrain from the terrain set that the tile uses.
int terrain_set = -1
int terrain_set = -1ID of the terrain set that the tile uses.
Vector2i texture_origin = Vector2i(0, 0)
Vector2i texture_origin = Vector2i(0, 0)Offsets the position of where the tile is drawn.
bool transpose = false
bool transpose = falseIf true, the tile will display transposed, i.e. with horizontal and vertical texture UVs swapped.
int y_sort_origin = 0
int y_sort_origin = 0Vertical point of the tile used for determining y-sorted order.
int z_index = 0
int z_index = 0Ordering index of this tile, relative to TileMapLayer.
Methods
void add_collision_polygon(int layer_id)
int layer_id)Adds a collision polygon to the tile on the given TileSet physics layer.
void add_occluder_polygon(int layer_id)
int layer_id)Adds an occlusion polygon to the tile on the TileSet occlusion layer with index layer_id.
float get_collision_polygon_one_way_margin(int layer_id, int polygon_index) const
float get_collision_polygon_one_way_margin(int layer_id, int polygon_index) constReturns the one-way margin (for one-way platforms) of the polygon at index polygon_index for TileSet physics layer with index layer_id.
PackedVector2Array get_collision_polygon_points(int layer_id, int polygon_index) const
PackedVector2Array get_collision_polygon_points(int layer_id, int polygon_index) constReturns the points of the polygon at index polygon_index for TileSet physics layer with index layer_id.
int get_collision_polygons_count(int layer_id) const
int get_collision_polygons_count(int layer_id) constReturns how many polygons the tile has for TileSet physics layer with index layer_id.
float get_constant_angular_velocity(int layer_id) const
float get_constant_angular_velocity(int layer_id) constReturns the constant angular velocity applied to objects colliding with this tile.
Vector2 get_constant_linear_velocity(int layer_id) const
Vector2 get_constant_linear_velocity(int layer_id) constReturns the constant linear velocity applied to objects colliding with this tile.
Variant get_custom_data(String layer_name) const
Variant get_custom_data(String layer_name) constReturns the custom data value for custom data layer named layer_name. To check if a custom data layer exists, use has_custom_data().
Variant get_custom_data_by_layer_id(int layer_id) const
Variant get_custom_data_by_layer_id(int layer_id) constReturns the custom data value for custom data layer with index layer_id.
NavigationPolygon get_navigation_polygon(int layer_id, bool flip_h = false, bool flip_v = false, bool transpose = false) const
NavigationPolygon get_navigation_polygon(int layer_id, bool flip_h = false, bool flip_v = false, bool transpose = false) constReturns the navigation polygon of the tile for the TileSet navigation layer with index layer_id. flip_h, flip_v, and transpose allow transforming the returned polygon.
OccluderPolygon2D get_occluder(int layer_id, bool flip_h = false, bool flip_v = false, bool transpose = false) const
OccluderPolygon2D get_occluder(int layer_id, bool flip_h = false, bool flip_v = false, bool transpose = false) constUse get_occluder_polygon() instead.
Returns the occluder polygon of the tile for the TileSet occlusion layer with index layer_id. flip_h, flip_v, and transpose allow transforming the returned polygon.
OccluderPolygon2D get_occluder_polygon(int layer_id, int polygon_index, bool flip_h = false, bool flip_v = false, bool transpose = false) const
OccluderPolygon2D get_occluder_polygon(int layer_id, int polygon_index, bool flip_h = false, bool flip_v = false, bool transpose = false) constReturns the occluder polygon at index polygon_index from the TileSet occlusion layer with index layer_id. The flip_h, flip_v, and transpose parameters can be true to transform the returned polygon.
int get_occluder_polygons_count(int layer_id) const
int get_occluder_polygons_count(int layer_id) constReturns the number of occluder polygons of the tile in the TileSet occlusion layer with index layer_id.
int get_terrain_peering_bit(int peering_bit) const
int get_terrain_peering_bit(int peering_bit) constReturns the tile's terrain bit for the given peering_bit direction. To check that a direction is valid, use is_valid_terrain_peering_bit().
bool has_custom_data(String layer_name) const
bool has_custom_data(String layer_name) constReturns whether there exists a custom data layer named layer_name.
bool is_collision_polygon_one_way(int layer_id, int polygon_index) const
bool is_collision_polygon_one_way(int layer_id, int polygon_index) constReturns whether one-way collisions are enabled for the polygon at index polygon_index for TileSet physics layer with index layer_id.
bool is_valid_terrain_peering_bit(int peering_bit) const
bool is_valid_terrain_peering_bit(int peering_bit) constReturns whether the given peering_bit direction is valid for this tile.
void remove_collision_polygon(int layer_id, int polygon_index)
int layer_id, int polygon_index)Removes the polygon at index polygon_index for TileSet physics layer with index layer_id.
void remove_occluder_polygon(int layer_id, int polygon_index)
int layer_id, int polygon_index)Removes the polygon at index polygon_index for TileSet occlusion layer with index layer_id.
void set_collision_polygon_one_way(int layer_id, int polygon_index, bool one_way)
int layer_id, int polygon_index, bool one_way)Enables/disables one-way collisions on the polygon at index polygon_index for TileSet physics layer with index layer_id.
void set_collision_polygon_one_way_margin(int layer_id, int polygon_index, float one_way_margin)
int layer_id, int polygon_index, float one_way_margin)Sets the one-way margin (for one-way platforms) of the polygon at index polygon_index for TileSet physics layer with index layer_id.
void set_collision_polygon_points(int layer_id, int polygon_index, PackedVector2Array polygon)
int layer_id, int polygon_index, PackedVector2Array polygon)Sets the points of the polygon at index polygon_index for TileSet physics layer with index layer_id.
void set_collision_polygons_count(int layer_id, int polygons_count)
int layer_id, int polygons_count)Sets the polygons count for TileSet physics layer with index layer_id.
void set_constant_angular_velocity(int layer_id, float velocity)
int layer_id, float velocity)Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile.
void set_constant_linear_velocity(int layer_id, Vector2 velocity)
int layer_id, 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.
void set_custom_data(String layer_name, Variant value)
String layer_name, Variant value)Sets the tile's custom data value for the TileSet custom data layer with name layer_name.
void set_custom_data_by_layer_id(int layer_id, Variant value)
int layer_id, Variant value)Sets the tile's custom data value for the TileSet custom data layer with index layer_id.
void set_navigation_polygon(int layer_id, NavigationPolygon navigation_polygon)
int layer_id, NavigationPolygon navigation_polygon)Sets the navigation polygon for the TileSet navigation layer with index layer_id.
void set_occluder(int layer_id, OccluderPolygon2D occluder_polygon)
int layer_id, OccluderPolygon2D occluder_polygon)Use set_occluder_polygon() instead.
Sets the occluder for the TileSet occlusion layer with index layer_id.
void set_occluder_polygon(int layer_id, int polygon_index, OccluderPolygon2D polygon)
int layer_id, int polygon_index, OccluderPolygon2D polygon)Sets the occluder for polygon with index polygon_index in the TileSet occlusion layer with index layer_id.
void set_occluder_polygons_count(int layer_id, int polygons_count)
int layer_id, int polygons_count)Sets the occluder polygon count in the TileSet occlusion layer with index layer_id.
void set_terrain_peering_bit(int peering_bit, int terrain)
int peering_bit, int terrain)Sets the tile's terrain bit for the given peering_bit direction. To check that a direction is valid, use is_valid_terrain_peering_bit().
Signals
changed()
Emitted when any of the properties are changed.