Click or drag to resize

TileMap Properties

The TileMap type exposes the following members.

Properties
  NameDescription
Public property_ImportPath (Inherited from Node.)
Public propertyCellClipUv

If true, the cell's UVs will be clipped.

Public propertyCellCustomTransform

The custom Transform2D to be applied to the TileMap's cells.

Public propertyCellHalfOffset

Amount to offset alternating tiles. See TileMapHalfOffset for possible values.

Public propertyCellQuadrantSize

The TileMap's quadrant size. Optimizes drawing by batching, using chunks of this size.

Public propertyCellSize

The TileMap's cell size.

Public propertyCellTileOrigin
Public propertyCellYSort

If true, the TileMap's direct children will be drawn in order of their Y coordinate.

Public propertyCenteredTextures

If true, the textures will be centered in the middle of each tile. This is useful for certain isometric or top-down modes when textures are made larger or smaller than the tiles (e.g. to avoid flickering on tile edges). The offset is still applied, but from the center of the tile. If used, CompatibilityMode is ignored.

If false, the texture position start in the top-left corner unless CompatibilityMode is enabled.

Public propertyCollisionBounce

Bounce value for static body collisions (see collision_use_kinematic).

Public propertyCollisionFriction

Friction value for static body collisions (see collision_use_kinematic).

Public propertyCollisionLayer

The collision layer(s) for all colliders in the TileMap. See Collision layers and masks in the documentation for more information.

Public propertyCollisionMask

The collision mask(s) for all colliders in the TileMap. See Collision layers and masks in the documentation for more information.

Public propertyCollisionUseKinematic

If true, TileMap collisions will be handled as a kinematic body. If false, collisions will be handled as static body.

Public propertyCollisionUseParent

If true, this tilemap's collision shape will be added to the collision shape of the parent. The parent has to be a CollisionObject2D.

Public propertyCompatibilityMode

If true, the compatibility with the tilemaps made in Godot 3.1 or earlier is maintained (textures move when the tile origin changes and rotate if the texture size is not homogeneous). This mode presents problems when doing flip_h, flip_v and transpose tile operations on non-homogeneous isometric tiles (e.g. 2:1), in which the texture could not coincide with the collision, thus it is not recommended for isometric or non-square tiles.

If false, the textures do not move when doing flip_h, flip_v operations if no offset is used, nor when changing the tile origin.

The compatibility mode doesn't work with the CenteredTextures option, because displacing textures with the CellTileOrigin option or in irregular tiles is not relevant when centering those textures.

Public propertyCustomMultiplayer

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

(Inherited from Node.)
Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyEditorDescription (Inherited from Node.)
Public propertyFilename

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

(Inherited from Node.)
Public propertyGlobalPosition

Global position.

(Inherited from Node2D.)
Public propertyGlobalRotation

Global rotation in radians.

(Inherited from Node2D.)
Public propertyGlobalRotationDegrees

Global rotation in degrees.

(Inherited from Node2D.)
Public propertyGlobalScale

Global scale.

(Inherited from Node2D.)
Public propertyGlobalTransform

Global Transform2D.

(Inherited from Node2D.)
Public propertyLightMask

The rendering layers in which this CanvasItem responds to Light2D nodes.

(Inherited from CanvasItem.)
Public propertyMaterial

The material applied to textures on this CanvasItem.

(Inherited from CanvasItem.)
Public propertyMode
Public propertyModulate

The color applied to textures on this CanvasItem.

(Inherited from CanvasItem.)
Public propertyMultiplayer

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

(Inherited from Node.)
Public propertyName

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

(Inherited from Node.)
Public propertyNativeInstance (Inherited from Object.)
Public propertyOccluderLightMask

The light mask assigned to all light occluders in the TileMap. The TileSet's light occluders will cast shadows only from Light2D(s) that have the same light mask(s).

Public propertyOwner

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

(Inherited from Node.)
Public propertyPauseMode

Pause mode. How the node will behave if the SceneTree is paused.

(Inherited from Node.)
Public propertyPosition

Position, relative to the node's parent.

(Inherited from Node2D.)
Public propertyProcessPriority

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

(Inherited from Node.)
Public propertyRotation

Rotation in radians, relative to the node's parent.

(Inherited from Node2D.)
Public propertyRotationDegrees

Rotation in degrees, relative to the node's parent.

(Inherited from Node2D.)
Public propertyScale

The node's scale. Unscaled value: (1, 1).

(Inherited from Node2D.)
Public propertySelfModulate

The color applied to textures on this CanvasItem. This is not inherited by children CanvasItems.

(Inherited from CanvasItem.)
Public propertyShowBehindParent

If true, the object draws behind its parent.

(Inherited from CanvasItem.)
Public propertyShowCollision

If true, collision shapes are shown in the editor and at run-time. Requires Visible Collision Shapes to be enabled in the Debug menu for collision shapes to be visible at run-time.

Public propertyShowOnTop

If true, the object draws on top of its parent.

(Inherited from CanvasItem.)
Public propertyTileSet

The assigned TileSet.

Public propertyTransform (Inherited from Node2D.)
Public propertyUseParentMaterial

If true, the parent CanvasItem's Material property is used as this one's material.

(Inherited from CanvasItem.)
Public propertyVisible

If true, this CanvasItem is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true).

Note: For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

(Inherited from CanvasItem.)
Public propertyZAsRelative

If true, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.

(Inherited from Node2D.)
Public propertyZIndex

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.

(Inherited from Node2D.)
Top
See Also