TileSet

Inherits: Resource < Reference < Object

Category: Core

Brief Description

Tile library for tilemaps.

Member Functions

void _forward_subtile_selection ( int autotile_id, int bitmask, Object tilemap, Vector2 tile_location ) virtual
void _is_tile_bound ( int drawn_id, int neighbor_id ) virtual
int autotile_get_bitmask_mode ( int arg0 ) const
void autotile_set_bitmask_mode ( int mode, int arg1 )
void clear ( )
void create_tile ( int id )
int find_tile_by_name ( String name ) const
int get_last_unused_tile_id ( ) const
Array get_tiles_ids ( ) const
void remove_tile ( int id )
void tile_add_shape ( int id, Shape2D shape, Transform2D shape_transform, bool one_way=false, Vector2 autotile_coord=Vector2( 0, 0 ) )
OccluderPolygon2D tile_get_light_occluder ( int id ) const
ShaderMaterial tile_get_material ( int id ) const
String tile_get_name ( int id ) const
NavigationPolygon tile_get_navigation_polygon ( int id ) const
Vector2 tile_get_navigation_polygon_offset ( int id ) const
Texture tile_get_normal_map ( int id ) const
Vector2 tile_get_occluder_offset ( int id ) const
Rect2 tile_get_region ( int id ) const
Shape2D tile_get_shape ( int id, int shape_id ) const
int tile_get_shape_count ( int id ) const
bool tile_get_shape_one_way ( int id, int shape_id ) const
Transform2D tile_get_shape_transform ( int id, int shape_id ) const
Array tile_get_shapes ( int id ) const
Texture tile_get_texture ( int id ) const
Vector2 tile_get_texture_offset ( int id ) const
void tile_set_light_occluder ( int id, OccluderPolygon2D light_occluder )
void tile_set_material ( int id, ShaderMaterial material )
void tile_set_name ( int id, String name )
void tile_set_navigation_polygon ( int id, NavigationPolygon navigation_polygon )
void tile_set_navigation_polygon_offset ( int id, Vector2 navigation_polygon_offset )
void tile_set_normal_map ( int id, Texture normal_map )
void tile_set_occluder_offset ( int id, Vector2 occluder_offset )
void tile_set_region ( int id, Rect2 region )
void tile_set_shape ( int id, int shape_id, Shape2D shape )
void tile_set_shape_one_way ( int id, int shape_id, bool one_way )
void tile_set_shape_transform ( int id, int shape_id, Transform2D shape_transform )
void tile_set_shapes ( int id, Array shapes )
void tile_set_texture ( int id, Texture texture )
void tile_set_texture_offset ( int id, Vector2 texture_offset )

Numeric Constants

  • BITMASK_2X2 = 0
  • BITMASK_3X3 = 1
  • BIND_TOPLEFT = 1
  • BIND_TOP = 2
  • BIND_TOPRIGHT = 4
  • BIND_LEFT = 8
  • BIND_RIGHT = 32
  • BIND_BOTTOMLEFT = 64
  • BIND_BOTTOM = 128
  • BIND_BOTTOMRIGHT = 256

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.

Tiles are referenced by a unique integer ID.

Member Function Description

  • void _forward_subtile_selection ( int autotile_id, int bitmask, Object tilemap, Vector2 tile_location ) virtual
  • void _is_tile_bound ( int drawn_id, int neighbor_id ) virtual
  • int autotile_get_bitmask_mode ( int arg0 ) const
  • void autotile_set_bitmask_mode ( int mode, int arg1 )
  • void clear ( )

Clear all tiles.

  • void create_tile ( int id )

Create a new tile which will be referenced by the given ID.

  • int find_tile_by_name ( String name ) const

Find the first tile matching the given name.

  • int get_last_unused_tile_id ( ) const

Return the ID following the last currently used ID, useful when creating a new tile.

  • Array get_tiles_ids ( ) const

Return an array of all currently used tile IDs.

  • void remove_tile ( int id )

Remove the tile referenced by the given ID.

Return the light occluder of the tile.

Return the material of the tile.

Return the name of the tile.

Return the navigation polygon of the tile.

  • Vector2 tile_get_navigation_polygon_offset ( int id ) const

Return the offset of the tile’s navigation polygon.

  • Vector2 tile_get_occluder_offset ( int id ) const

Return the offset of the tile’s light occluder.

  • Rect2 tile_get_region ( int id ) const

Return the tile sub-region in the texture.

  • int tile_get_shape_count ( int id ) const
  • bool tile_get_shape_one_way ( int id, int shape_id ) const
  • Array tile_get_shapes ( int id ) const

Return the array of shapes of the tile.

Return the texture of the tile.

  • Vector2 tile_get_texture_offset ( int id ) const

Return the texture offset of the tile.

Set a light occluder for the tile.

Set the material of the tile.

Set the name of the tile, for descriptive purposes.

Set a navigation polygon for the tile.

  • void tile_set_navigation_polygon_offset ( int id, Vector2 navigation_polygon_offset )

Set an offset for the tile’s navigation polygon.

  • void tile_set_normal_map ( int id, Texture normal_map )
  • void tile_set_occluder_offset ( int id, Vector2 occluder_offset )

Set an offset for the tile’s light occluder.

  • void tile_set_region ( int id, Rect2 region )

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

  • void tile_set_shape_one_way ( int id, int shape_id, bool one_way )
  • void tile_set_shape_transform ( int id, int shape_id, Transform2D shape_transform )
  • void tile_set_shapes ( int id, Array shapes )

Set an array of shapes for the tile, enabling physics to collide with it.

  • void tile_set_texture ( int id, Texture texture )

Set the texture of the tile.

  • void tile_set_texture_offset ( int id, Vector2 texture_offset )

Set the texture offset of the tile.