class_tileset

TileSet

####Inherits: Resource ####Category: Core

Brief Description

Tile library for tilemaps.

Member Functions

• void create&#95tile ( int id )
• void tile&#95set&#95name ( int id, String name )
• String tile&#95get&#95name ( int id ) const
• void tile&#95set&#95texture ( int id, Texture texture )
• Texture tile&#95get&#95texture ( int id ) const
• void tile&#95set&#95offset ( int id, Vector2 offset )
• Vector2 tile&#95get&#95offset ( int id ) const
• void tile&#95set&#95region ( int id, Rect2 region )
• Rect2 tile&#95get&#95region ( int id ) const
• void tile&#95set&#95shape ( int id, Shape2D shape )
• Shape2D tile&#95get&#95shape ( int id ) const
• void tile&#95set&#95shapes ( int id, Array shapes )
• Array tile&#95get&#95shapes ( int id ) const
• void remove&#95tile ( int id )
• void clear ( )
• int get&#95last&#95unused&#95tile&#95id ( ) const
• int find&#95tile&#95by&#95name ( String name ) const

Description

A TileSet is a library of tiles for a TileMap. It contains a list of tiles, each consisting of a sprite and optional collision shapes.

Member Function Description

create_tile

• void create&#95tile ( int id )

Create a new tile, the ID must be specified.

tile_set_name

• void tile&#95set&#95name ( int id, String name )

Set the name of a tile, for decriptive purposes.

tile_get_name

• String tile&#95get&#95name ( int id ) const

Return the name of a tile, for decriptive purposes.

tile_set_texture

• void tile&#95set&#95texture ( int id, Texture texture )

Set the texture of the tile.

tile_get_texture

• Texture tile&#95get&#95texture ( int id ) const

Return the texture of the tile.

tile_set_offset

• void tile&#95set&#95offset ( int id, Vector2 offset )

Set the offset to draw the tile.

tile_get_offset

• Vector2 tile&#95get&#95offset ( int id ) const

Return the offset to draw the tile.

tile_set_region

• void tile&#95set&#95region ( int id, Rect2 region )

Set the tile sub-region in the texture. This is common in texture atlases.

tile_get_region

• Rect2 tile&#95get&#95region ( int id ) const

Return the tile sub-region in the texture. This is common in texture atlases.

tile_set_shape

• void tile&#95set&#95shape ( int id, Shape2D shape )

Set a shape for the tile, enabling physics to collide it.

tile_get_shape

• Shape2D tile&#95get&#95shape ( int id ) const

Return the shape of the tile.

remove_tile

• void remove&#95tile ( int id )

Remove a tile, by integer id.

clear

• void clear ( )

Clear all tiles.

get_last_unused_tile_id

• int get&#95last&#95unused&#95tile&#95id ( ) const

Find an empty id for creating a new tile.

find_tile_by_name

• int find&#95tile&#95by&#95name ( String name ) const

Find the first tile with the given name.