Up to date
This page is up to date for Godot 4.1
.
If you still find outdated information, please open an issue.
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 TileMap._tile_data_runtime_update.
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
Signals¶
changed ( )
Emitted when any of the properties are changed.
Property Descriptions¶
bool flip_h = false
If true
, the tile will have its texture flipped horizontally.
bool flip_v = false
If true
, the tile will have its texture flipped vertically.
Material material
The 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 modulation of the tile.
float probability = 1.0
Relative probability of this tile being selected when drawing a pattern of random tiles.
int terrain = -1
ID of the terrain from the terrain set that the tile uses.
int terrain_set = -1
ID of the terrain set that the tile uses.
Vector2i texture_origin = Vector2i(0, 0)
Offsets the position of where the tile is drawn.
bool transpose = false
If true
, the tile will display transposed, i.e. with horizontal and vertical texture UVs swapped.
int y_sort_origin = 0
Vertical point of the tile used for determining y-sorted order.
int z_index = 0
Ordering index of this tile, relative to TileMap.
Method Descriptions¶
void add_collision_polygon ( int layer_id )
Adds a collision polygon to the tile on the given TileSet physics layer.
float get_collision_polygon_one_way_margin ( int layer_id, 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
.
PackedVector2Array get_collision_polygon_points ( int layer_id, int polygon_index ) const
Returns 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
Returns how many polygons the tile has for TileSet physics layer with index layer_id
.
float get_constant_angular_velocity ( int layer_id ) const
Returns the constant angular velocity applied to objects colliding with this tile.
Vector2 get_constant_linear_velocity ( int layer_id ) const
Returns the constant linear velocity applied to objects colliding with this tile.
Variant get_custom_data ( String layer_name ) const
Returns the custom data value for custom data layer named layer_name
.
Variant get_custom_data_by_layer_id ( int layer_id ) const
Returns the custom data value for custom data layer with index layer_id
.
Returns the navigation polygon of the tile for the TileSet navigation layer with index layer_id
.
OccluderPolygon2D get_occluder ( int layer_id ) const
Returns the occluder polygon of the tile for the TileSet occlusion layer with index layer_id
.
int get_terrain_peering_bit ( CellNeighbor peering_bit ) const
Returns the tile's terrain bit for the given peering_bit
direction.
bool is_collision_polygon_one_way ( int layer_id, 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
.
void remove_collision_polygon ( int layer_id, int polygon_index )
Removes the polygon at index polygon_index
for TileSet physics layer with index layer_id
.
void set_collision_polygon_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
.