TileSetAtlasSource

public Vector2I Margins { get; set; }

Margins, in pixels, to offset the origin of the grid in the texture.

public Vector2I Separation { get; set; }

Separation, in pixels, between each tile texture region of the grid.

public Texture2D Texture { get; set; }

The atlas texture.

public Vector2I TextureRegionSize { get; set; }

Base image-region size in atlas pixels. A tile may span several such regions. This does not replace TileSet.TileSize or create collision. CreateTile/SetCell atlas coordinates use atlas-grid units, not these pixel dimensions.

public bool UseTexturePadding { get; set; }

If true, generates an internal texture with an additional one pixel padding around each tile. Texture padding avoids a common artifact where lines appear between tiles. Disabling this setting might lead a small performance improvement, as generating the internal texture requires both memory and processing time when the TileSetAtlasSource resource is modified.

public void ClearTilesOutsideTexture();

Removes all tiles that don't fit the available texture area. This method iterates over all the source's tiles, so it's advised to use TileSetAtlasSource.HasTilesOutsideTexture beforehand.

public int CreateAlternativeTile(Vector2I atlasCoords, int alternativeIdOverride = -1);

Creates an alternative tile for the tile at coordinates atlas_coords. If alternative_id_override is -1, give it an automatically generated unique ID, or assigns it the given ID otherwise. Returns the new alternative identifier, or -1 if the alternative could not be created with a provided alternative_id_override.

public void CreateTile(Vector2I atlasCoords, Vector2I? size = default);

Creates a new tile at coordinates atlas_coords with the given size.

public Vector2I GetAtlasGridSize();

Returns the atlas grid size, which depends on how many tiles can fit in the texture. It thus depends on the TileSetAtlasSource.Texture's size, the atlas TileSetAtlasSource.Margins, and the tiles' TileSetAtlasSource.TextureRegionSize.

public int GetNextAlternativeTileId(Vector2I atlasCoords);

Returns the alternative ID a following call to TileSetAtlasSource.CreateAlternativeTile would return.

public Texture2D GetRuntimeTexture();

If TileSetAtlasSource.UseTexturePadding is false, returns TileSetAtlasSource.Texture. Otherwise, returns an internal ImageTexture created that includes the padding.

public Rect2I GetRuntimeTileTextureRegion(Vector2I atlasCoords, int frame);

Returns the region of the tile at coordinates atlas_coords for the given frame inside the texture returned by TileSetAtlasSource.GetRuntimeTexture. Note: If TileSetAtlasSource.UseTexturePadding is false, returns the same as TileSetAtlasSource.GetTileTextureRegion.

public int GetTileAnimationColumns(Vector2I atlasCoords);

Returns how many columns the tile at atlas_coords has in its animation layout.

public float GetTileAnimationFrameDuration(Vector2I atlasCoords, int frameIndex);

Returns the animation frame duration of frame frame_index for the tile at coordinates atlas_coords.

public int GetTileAnimationFramesCount(Vector2I atlasCoords);

Returns how many animation frames has the tile at coordinates atlas_coords.

public TileSetAtlasSource.TileAnimationMode GetTileAnimationMode(Vector2I atlasCoords);

Returns the tile animation mode of the tile at atlas_coords. See also TileSetAtlasSource.SetTileAnimationMode.

public Vector2I GetTileAnimationSeparation(Vector2I atlasCoords);

Returns the separation (as in the atlas grid) between each frame of an animated tile at coordinates atlas_coords.

public float GetTileAnimationSpeed(Vector2I atlasCoords);

Returns the animation speed of the tile at coordinates atlas_coords.

public float GetTileAnimationTotalDuration(Vector2I atlasCoords);

Returns the sum of the sum of the frame durations of the tile at coordinates atlas_coords. This value needs to be divided by the animation speed to get the actual animation loop duration.

public Vector2I GetTileAtCoords(Vector2I atlasCoords);

If there is a tile covering the atlas_coords coordinates, returns the top-left coordinates of the tile (thus its coordinate ID). Returns Vector2i(-1, -1) otherwise.

public TileData GetTileData(Vector2I atlasCoords, int alternativeTile);

Returns the TileData object for the given atlas coordinates and alternative ID.

public Vector2I GetTileSizeInAtlas(Vector2I atlasCoords);

Returns the size of the tile (in the grid coordinates system) at coordinates atlas_coords.

public Rect2I GetTileTextureRegion(Vector2I atlasCoords, int frame = 0);

Returns a tile's texture region in the atlas texture. For animated tiles, a frame argument might be provided for the different frames of the animation.

public Vector2[] GetTilesToBeRemovedOnChange(Texture2D texture, Vector2I margins, Vector2I separation, Vector2I textureRegionSize);

Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: TileSetAtlasSource.Texture, TileSetAtlasSource.Margins, TileSetAtlasSource.Separation or TileSetAtlasSource.TextureRegionSize. This can be used to undo changes that would have caused tiles data loss.

public bool HasRoomForTile(Vector2I atlasCoords, Vector2I size, int animationColumns, Vector2I animationSeparation, int framesCount, Vector2I? ignoredTile = default);

Returns whether there is enough room in an atlas to create/modify a tile with the given properties. If ignored_tile is provided, act as is the given tile was not present in the atlas. This may be used when you want to modify a tile's properties.

public bool HasTilesOutsideTexture();

Checks if the source has any tiles that don't fit the texture area (either partially or completely).

public void MoveTileInAtlas(Vector2I atlasCoords, Vector2I? newAtlasCoords = default, Vector2I? newSize = default);

Move the tile and its alternatives at the atlas_coords coordinates to the new_atlas_coords coordinates with the new_size size. This functions will fail if a tile is already present in the given area. If new_atlas_coords is Vector2i(-1, -1), keeps the tile's coordinates. If new_size is Vector2i(-1, -1), keeps the tile's size. To avoid an error, first check if a move is possible using TileSetAtlasSource.HasRoomForTile.

public void RemoveAlternativeTile(Vector2I atlasCoords, int alternativeTile);

Remove a tile's alternative with alternative ID alternative_tile. Calling this function with alternative_tile equals to 0 will fail, as the base tile alternative cannot be removed.

public void RemoveTile(Vector2I atlasCoords);

Remove a tile and its alternative at coordinates atlas_coords.

public void SetAlternativeTileId(Vector2I atlasCoords, int alternativeTile, int newId);

Change a tile's alternative ID from alternative_tile to new_id. Calling this function with new_id of 0 will fail, as the base tile alternative cannot be moved.

public void SetTileAnimationColumns(Vector2I atlasCoords, int frameColumns);

Sets the number of columns in the animation layout of the tile at coordinates atlas_coords. If set to 0, then the different frames of the animation are laid out as a single horizontal line in the atlas.

public void SetTileAnimationFrameDuration(Vector2I atlasCoords, int frameIndex, float duration);

Sets the animation frame duration of frame frame_index for the tile at coordinates atlas_coords.

public void SetTileAnimationFramesCount(Vector2I atlasCoords, int framesCount);

Sets how many animation frames the tile at coordinates atlas_coords has.

public void SetTileAnimationMode(Vector2I atlasCoords, TileSetAtlasSource.TileAnimationMode mode);

Sets the tile animation mode of the tile at atlas_coords to mode. See also TileSetAtlasSource.GetTileAnimationMode.

public void SetTileAnimationSeparation(Vector2I atlasCoords, Vector2I separation);

Sets the margin (in grid tiles) between each tile in the animation layout of the tile at coordinates atlas_coords has.

public void SetTileAnimationSpeed(Vector2I atlasCoords, float speed);

Sets the animation speed of the tile at coordinates atlas_coords has.

public const long TransformFlipH = 4096;

Represents cell's horizontal flip flag. Should be used directly with TileMapLayer to flip placed tiles by altering their alternative IDs.

Note: These transformations can be combined to do the equivalent of 0, 90, 180, and 270 degree rotations, as shown below:

enum TileTransform {
    ROTATE_0 = 0,
    ROTATE_90 = TileSetAtlasSource.TRANSFORM_TRANSPOSE | TileSetAtlasSource.TRANSFORM_FLIP_H,
    ROTATE_180 = TileSetAtlasSource.TRANSFORM_FLIP_H | TileSetAtlasSource.TRANSFORM_FLIP_V,
    ROTATE_270 = TileSetAtlasSource.TRANSFORM_TRANSPOSE | TileSetAtlasSource.TRANSFORM_FLIP_V,
}

public const long TransformFlipV = 8192;

Represents cell's vertical flip flag. See TileSetAtlasSource.TransformFlipH for usage.

public const long TransformTranspose = 16384;

Represents cell's transposed flag. See TileSetAtlasSource.TransformFlipH for usage.