TileSetAtlasSource #

func clear_tiles_outside_texture() -> void#

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 has_tiles_outside_texture beforehand.

func create_alternative_tile(alternative_id_override: int = -1) -> int#

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.

func create_tile(size: Vector2i = Vector2i(1, 1)) -> void#

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

const func get_atlas_grid_size() -> Vector2i#

Returns the atlas grid size, which depends on how many tiles can fit in the texture. It thus depends on the texture's size, the atlas margins, and the tiles' texture_region_size.

const func get_next_alternative_tile_id(atlas_coords: Vector2i) -> int#

Returns the alternative ID a following call to create_alternative_tile would return.

const func get_runtime_texture() -> Texture2D#

If use_texture_padding is false, returns texture. Otherwise, returns and internal ImageTexture created that includes the padding.

const func get_runtime_tile_texture_region(frame: int) -> Rect2i#

Returns the region of the tile at coordinates atlas_coords for the given frame inside the texture returned by get_runtime_texture.

Note: If use_texture_padding is false, returns the same as get_tile_texture_region.

const func get_tile_animation_columns(atlas_coords: Vector2i) -> int#

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

const func get_tile_animation_frame_duration(frame_index: int) -> float#

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

const func get_tile_animation_frames_count(atlas_coords: Vector2i) -> int#

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

const func get_tile_animation_mode(atlas_coords: Vector2i) -> intTileSetAtlasSource.TileAnimationMode#

Returns the tile animation mode of the tile at atlas_coords. See also set_tile_animation_mode.

const func get_tile_animation_separation(atlas_coords: Vector2i) -> Vector2i#

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

const func get_tile_animation_speed(atlas_coords: Vector2i) -> float#

Returns the animation speed of the tile at coordinates atlas_coords.

const func get_tile_animation_total_duration(atlas_coords: Vector2i) -> float#

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.

const func get_tile_at_coords(atlas_coords: Vector2i) -> Vector2i#

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.

const func get_tile_data(alternative_tile: int) -> TileData#

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

const func get_tile_size_in_atlas(atlas_coords: Vector2i) -> Vector2i#

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

const func get_tile_texture_region(frame: int = 0) -> Rect2i#

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.

func get_tiles_to_be_removed_on_change(texture_region_size: Vector2i) -> PackedVector2Array#

Returns an array of tiles coordinates ID that will be automatically removed when modifying one or several of those properties: texture, margins, separation or texture_region_size. This can be used to undo changes that would have caused tiles data loss.

const func has_room_for_tile(ignored_tile: Vector2i = Vector2i(-1, -1)) -> bool#

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.

const func has_tiles_outside_texture() -> bool#

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

func move_tile_in_atlas(new_size: Vector2i = Vector2i(-1, -1)) -> void#

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 has_room_for_tile.

func remove_alternative_tile(alternative_tile: int) -> void#

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.

func remove_tile(atlas_coords: Vector2i) -> void#

Remove a tile and its alternative at coordinates atlas_coords.

func set_alternative_tile_id(new_id: int) -> void#

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.

func set_tile_animation_columns(frame_columns: int) -> void#

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.

func set_tile_animation_frame_duration(duration: float) -> void#

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

func set_tile_animation_frames_count(frames_count: int) -> void#

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

func set_tile_animation_mode(mode: int enumTileSetAtlasSource.TileAnimationMode) -> void#

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

func set_tile_animation_separation(separation: Vector2i) -> void#

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

func set_tile_animation_speed(speed: float) -> void#

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