Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
Table of contents
-
var flip_h: bool = false -
var flip_v: bool = false -
var material: Material -
var modulate: Color = Color(1, 1, 1, 1) -
var probability: float = 1.0 -
var terrain: int = -1 -
var terrain_set: int = -1 -
var texture_origin: Vector2i = Vector2i(0, 0) -
var transpose: bool = false -
var y_sort_origin: int = 0 -
var z_index: int = 0 -
func add_collision_polygon(layer_id: int) -> void -
func add_occluder_polygon(layer_id: int) -> void -
const func get_collision_polygon_one_way_margin(polygon_index: int) -> float -
const func get_collision_polygon_points(polygon_index: int) -> PackedVector2Array -
const func get_collision_polygons_count(layer_id: int) -> int -
const func get_constant_angular_velocity(layer_id: int) -> float -
const func get_constant_linear_velocity(layer_id: int) -> Vector2 -
const func get_custom_data(layer_name: String) -> Variant -
const func get_custom_data_by_layer_id(layer_id: int) -> Variant -
const func get_navigation_polygon(transpose: bool = false) -> NavigationPolygon -
const func get_occluder(transpose: bool = false) -> OccluderPolygon2D -
const func get_occluder_polygon(transpose: bool = false) -> OccluderPolygon2D -
const func get_occluder_polygons_count(layer_id: int) -> int -
const func get_terrain_peering_bit(peering_bit: int enumTileSet.CellNeighbor) -> int -
const func has_custom_data(layer_name: String) -> bool -
const func is_collision_polygon_one_way(polygon_index: int) -> bool -
const func is_valid_terrain_peering_bit(peering_bit: int enumTileSet.CellNeighbor) -> bool -
func remove_collision_polygon(polygon_index: int) -> void -
func remove_occluder_polygon(polygon_index: int) -> void -
func set_collision_polygon_one_way(one_way: bool) -> void -
func set_collision_polygon_one_way_margin(one_way_margin: float) -> void -
func set_collision_polygon_points(polygon: PackedVector2Array) -> void -
func set_collision_polygons_count(polygons_count: int) -> void -
func set_constant_angular_velocity(velocity: float) -> void -
func set_constant_linear_velocity(velocity: Vector2) -> void -
func set_custom_data(value: Variant) -> void -
func set_custom_data_by_layer_id(value: Variant) -> void -
func set_navigation_polygon(navigation_polygon: NavigationPolygon) -> void -
func set_occluder(occluder_polygon: OccluderPolygon2D) -> void -
func set_occluder_polygon(polygon: OccluderPolygon2D) -> void -
func set_occluder_polygons_count(polygons_count: int) -> void -
func set_terrain_peering_bit(terrain: int) -> void -
signal changed()
TileData #
is_instantiable, core, not_builtin_classes
Settings for a single tile in a TileSet.
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.
Members #
var flip_h: bool = false#
If true, the tile will have its texture flipped horizontally.
var flip_v: bool = false#
If true, the tile will have its texture flipped vertically.
var 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.
var modulate: Color = Color(1, 1, 1, 1)#
Color modulation of the tile.
var probability: float = 1.0#
Relative probability of this tile being selected when drawing a pattern of random tiles.
var terrain: int = -1#
ID of the terrain from the terrain set that the tile uses.
var terrain_set: int = -1#
ID of the terrain set that the tile uses.
var texture_origin: Vector2i = Vector2i(0, 0)#
Offsets the position of where the tile is drawn.
var transpose: bool = false#
If true, the tile will display transposed, i.e. with horizontal and vertical texture UVs swapped.
var y_sort_origin: int = 0#
Vertical point of the tile used for determining y-sorted order.
var z_index: int = 0#
Ordering index of this tile, relative to TileMap.
Methods #
func add_collision_polygon(layer_id: int) -> void#
Adds a collision polygon to the tile on the given TileSet physics layer.
func add_occluder_polygon(layer_id: int) -> void#
Adds an occlusion polygon to the tile on the TileSet occlusion layer with index layer_id.
const func get_collision_polygon_one_way_margin(polygon_index: int) -> float#
Returns the one-way margin (for one-way platforms) of the polygon at index polygon_index for TileSet physics layer with index layer_id.
const func get_collision_polygon_points(polygon_index: int) -> PackedVector2Array#
Returns the points of the polygon at index polygon_index for TileSet physics layer with index layer_id.
const func get_collision_polygons_count(layer_id: int) -> int#
Returns how many polygons the tile has for TileSet physics layer with index layer_id.
const func get_constant_angular_velocity(layer_id: int) -> float#
Returns the constant angular velocity applied to objects colliding with this tile.
const func get_constant_linear_velocity(layer_id: int) -> Vector2#
Returns the constant linear velocity applied to objects colliding with this tile.
const func get_custom_data(layer_name: String) -> Variant#
Returns the custom data value for custom data layer named layer_name. To check if a custom data layer exists, use has_custom_data.
const func get_custom_data_by_layer_id(layer_id: int) -> Variant#
Returns the custom data value for custom data layer with index layer_id.
const func get_navigation_polygon(transpose: bool = false) -> NavigationPolygon#
Returns 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.
const func get_occluder(transpose: bool = false) -> OccluderPolygon2D#
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.
const func get_occluder_polygon(transpose: bool = false) -> OccluderPolygon2D#
Returns 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.
const func get_occluder_polygons_count(layer_id: int) -> int#
Returns the number of occluder polygons of the tile in the TileSet occlusion layer with index layer_id.
const func get_terrain_peering_bit(peering_bit: int enumTileSet.CellNeighbor) -> int#
Returns the tile's terrain bit for the given peering_bit direction. To check that a direction is valid, use is_valid_terrain_peering_bit.
const func has_custom_data(layer_name: String) -> bool#
Returns whether there exists a custom data layer named layer_name.
const func is_collision_polygon_one_way(polygon_index: int) -> bool#
Returns whether one-way collisions are enabled for the polygon at index polygon_index for TileSet physics layer with index layer_id.
const func is_valid_terrain_peering_bit(peering_bit: int enumTileSet.CellNeighbor) -> bool#
Returns whether the given peering_bit direction is valid for this tile.
func remove_collision_polygon(polygon_index: int) -> void#
Removes the polygon at index polygon_index for TileSet physics layer with index layer_id.
func remove_occluder_polygon(polygon_index: int) -> void#
Removes the polygon at index polygon_index for TileSet occlusion layer with index layer_id.
func set_collision_polygon_one_way(one_way: bool) -> void#
Enables/disables one-way collisions on the polygon at index polygon_index for TileSet physics layer with index layer_id.
func set_collision_polygon_one_way_margin(one_way_margin: float) -> void#
Sets the one-way margin (for one-way platforms) of the polygon at index polygon_index for TileSet physics layer with index layer_id.
func set_collision_polygon_points(polygon: PackedVector2Array) -> void#
Sets the points of the polygon at index polygon_index for TileSet physics layer with index layer_id.
func set_collision_polygons_count(polygons_count: int) -> void#
Sets the polygons count for TileSet physics layer with index layer_id.
func set_constant_angular_velocity(velocity: float) -> void#
Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile.
func set_constant_linear_velocity(velocity: Vector2) -> void#
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.
func set_custom_data(value: Variant) -> void#
Sets the tile's custom data value for the TileSet custom data layer with name layer_name.
func set_custom_data_by_layer_id(value: Variant) -> void#
Sets the tile's custom data value for the TileSet custom data layer with index layer_id.
func set_navigation_polygon(navigation_polygon: NavigationPolygon) -> void#
Sets the navigation polygon for the TileSet navigation layer with index layer_id.
func set_occluder(occluder_polygon: OccluderPolygon2D) -> void#
Sets the occluder for the TileSet occlusion layer with index layer_id.
func set_occluder_polygon(polygon: OccluderPolygon2D) -> void#
Sets the occluder for polygon with index polygon_index in the TileSet occlusion layer with index layer_id.
func set_occluder_polygons_count(polygons_count: int) -> void#
Sets the occluder polygon count in the TileSet occlusion layer with index layer_id.
func set_terrain_peering_bit(terrain: int) -> void#
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.
Annotations #
Constants #
Constructors #
Enums #
Operators #
Signals #
signal changed()#
Emitted when any of the properties are changed.