跳到主要内容

TileSet

继承​

Resource

简要描述​

用于图块图的图块库。

描述​

TileSet是TileMap的图块库。它包含一个图块列表，每个图块均包含一个精灵和可选的碰撞形状。

图块由唯一的整数ID引用。

方法​

返回值类型方法名称
Vector2_forward_atlas_subtile_selection(atlastile_id: int, tilemap: Object, tile_location: Vector2) virtual
Vector2_forward_subtile_selection(autotile_id: int, bitmask: int, tilemap: Object, tile_location: Vector2) virtual
bool_is_tile_bound(drawn_id: int, neighbor_id: int) virtual
voidautotile_clear_bitmask_map(id: int)
intautotile_get_bitmask(id: int, coord: Vector2)
intautotile_get_bitmask_mode(id: int) const
Vector2autotile_get_icon_coordinate(id: int) const
OccluderPolygon2Dautotile_get_light_occluder(id: int, coord: Vector2) const
NavigationPolygonautotile_get_navigation_polygon(id: int, coord: Vector2) const
Vector2autotile_get_size(id: int) const
intautotile_get_spacing(id: int) const
intautotile_get_subtile_priority(id: int, coord: Vector2)
intautotile_get_z_index(id: int, coord: Vector2)
voidautotile_set_bitmask(id: int, bitmask: Vector2, flag: int)
voidautotile_set_bitmask_mode(id: int, mode: int)
voidautotile_set_icon_coordinate(id: int, coord: Vector2)
voidautotile_set_light_occluder(id: int, light_occluder: OccluderPolygon2D, coord: Vector2)
voidautotile_set_navigation_polygon(id: int, navigation_polygon: NavigationPolygon, coord: Vector2)
voidautotile_set_size(id: int, size: Vector2)
voidautotile_set_spacing(id: int, spacing: int)
voidautotile_set_subtile_priority(id: int, coord: Vector2, priority: int)
voidautotile_set_z_index(id: int, coord: Vector2, z_index: int)
voidclear()
voidcreate_tile(id: int)
intfind_tile_by_name(name: String) const
intget_last_unused_tile_id() const
Arrayget_tiles_ids() const
voidremove_tile(id: int)
voidtile_add_shape(id: int, shape: Shape2D, shape_transform: Transform2D, one_way: bool = false, autotile_coord: Vector2 = Vector2( 0, 0 ))
OccluderPolygon2Dtile_get_light_occluder(id: int) const
ShaderMaterialtile_get_material(id: int) const
Colortile_get_modulate(id: int) const
Stringtile_get_name(id: int) const
NavigationPolygontile_get_navigation_polygon(id: int) const
Vector2tile_get_navigation_polygon_offset(id: int) const
Texturetile_get_normal_map(id: int) const
Vector2tile_get_occluder_offset(id: int) const
Rect2tile_get_region(id: int) const
Shape2Dtile_get_shape(id: int, shape_id: int) const
inttile_get_shape_count(id: int) const
Vector2tile_get_shape_offset(id: int, shape_id: int) const
booltile_get_shape_one_way(id: int, shape_id: int) const
floattile_get_shape_one_way_margin(id: int, shape_id: int) const
Transform2Dtile_get_shape_transform(id: int, shape_id: int) const
Arraytile_get_shapes(id: int) const
Texturetile_get_texture(id: int) const
Vector2tile_get_texture_offset(id: int) const
inttile_get_tile_mode(id: int) const
inttile_get_z_index(id: int) const
voidtile_set_light_occluder(id: int, light_occluder: OccluderPolygon2D)
voidtile_set_material(id: int, material: ShaderMaterial)
voidtile_set_modulate(id: int, color: Color)
voidtile_set_name(id: int, name: String)
voidtile_set_navigation_polygon(id: int, navigation_polygon: NavigationPolygon)
voidtile_set_navigation_polygon_offset(id: int, navigation_polygon_offset: Vector2)
voidtile_set_normal_map(id: int, normal_map: Texture)
voidtile_set_occluder_offset(id: int, occluder_offset: Vector2)
voidtile_set_region(id: int, region: Rect2)
voidtile_set_shape(id: int, shape_id: int, shape: Shape2D)
voidtile_set_shape_offset(id: int, shape_id: int, shape_offset: Vector2)
voidtile_set_shape_one_way(id: int, shape_id: int, one_way: bool)
voidtile_set_shape_one_way_margin(id: int, shape_id: int, one_way: float)
voidtile_set_shape_transform(id: int, shape_id: int, shape_transform: Transform2D)
voidtile_set_shapes(id: int, shapes: Array)
voidtile_set_texture(id: int, texture: Texture)
voidtile_set_texture_offset(id: int, texture_offset: Vector2)
voidtile_set_tile_mode(id: int, tilemode: int)
voidtile_set_z_index(id: int, z_index: int)

枚举​

enum BitmaskMode:

  • **BITMASK_2X2 = 0**
  • **BITMASK_3X3_MINIMAL = 1**
  • **BITMASK_3X3 = 2**

enum AutotileBindings:

  • **BIND_TOPLEFT = 1**
  • **BIND_TOP = 2**
  • **BIND_TOPRIGHT = 4**
  • **BIND_LEFT = 8**
  • **BIND_CENTER = 16**
  • **BIND_RIGHT = 32**
  • **BIND_BOTTOMLEFT = 64**
  • **BIND_BOTTOM = 128**
  • **BIND_BOTTOMRIGHT = 256**

enum TileMode:

  • **SINGLE_TILE = 0**
  • **AUTO_TILE = 1**
  • **ATLAS_TILE = 2**

方法说明​

  • _forward_atlas_subtile_selection _forward_atlas_subtile_selection(atlastile_id: int, tilemap: Object, tile_location: Vector2) virtual
  • _forward_subtile_selection _forward_subtile_selection(autotile_id: int, bitmask: int, tilemap: Object, tile_location: Vector2) virtual
  • _is_tile_bound _is_tile_bound(drawn_id: int, neighbor_id: int) virtual
  • autotile_clear_bitmask_map autotile_clear_bitmask_map(id: int)

清除自动程序的所有位掩码信息。

  • autotile_get_bitmask autotile_get_bitmask(id: int, coord: Vector2)

在给定其坐标的情况下，从autotile返回subtile的位掩码。

该值是存在于细分中的AutotileBindings中的值的总和（例如，值为5表示位掩码在左上方和右上方均具有绑定）。

  • autotile_get_bitmask_mode autotile_get_bitmask_mode(id: int) const

返回autotile的BitmaskMode。

  • autotile_get_icon_coordinate autotile_get_icon_coordinate(id: int) const

返回给定其坐标的atlas/autotile中用作图标的图形。

当atlas/autotile的位掩码信息不完整时，定义为图标的细分将用作后备。它还将用于在图块集编辑器中表示它。

  • autotile_get_light_occluder autotile_get_light_occluder(id: int, coord: Vector2) const

根据给定的坐标，从atlas/autotile返回该subtile的光遮挡物。

  • autotile_get_navigation_polygon autotile_get_navigation_polygon(id: int, coord: Vector2) const

从给定其坐标的atlas/autotile返回该细分对象的导航多边形。

  • autotile_get_size autotile_get_size(id: int) const

返回atlas/autotile中子图块的大小。

  • autotile_get_spacing autotile_get_spacing(id: int) const

返回atlas/autotile的子图块之间的间距。

  • autotile_get_subtile_priority autotile_get_subtile_priority(id: int, coord: Vector2)

在给定其坐标的情况下，从Autotile返回subtile的优先级。

当多个子图块具有相同的位掩码值时，将随机选择其中之一进行绘制。

  • autotile_get_z_index autotile_get_z_index(id: int, coord: Vector2)

根据给定的坐标，从atlas/autotile返回subtile的绘图索引。

  • autotile_set_bitmask autotile_set_bitmask(id: int, bitmask: Vector2, flag: int)

给定细分对象的坐标，为其设置细分对象的位掩码。

该值是存在于细分中的AutotileBindings中的值的总和（例如，值为5表示位掩码在左上方和右上方均具有绑定）。

  • autotile_set_bitmask_mode autotile_set_bitmask_mode(id: int, mode: int)

设置autotile的[枚举BitmaskMode]。

  • autotile_set_icon_coordinate autotile_set_icon_coordinate(id: int, coord: Vector2)

给定其坐标，设置将用作atlas/autotile中的图标的图形。

当地atlas/autotile生成的位掩码信息不完整时，定义为图标的细分将用作后备。

  • autotile_set_light_occluder autotile_set_light_occluder(id: int, light_occluder: OccluderPolygon2D, coord: Vector2)

在给定其坐标的情况下，从atlas/autotile设置subtile的光遮挡物。

  • autotile_set_navigation_polygon autotile_set_navigation_polygon(id: int, navigation_polygon: NavigationPolygon, coord: Vector2)

在给定其坐标的情况下，从atlas/autotile设置细分的导航多边形。

  • autotile_set_size autotile_set_size(id: int, size: Vector2)

设置atlas/autotile中subtiles的大小。

  • autotile_set_spacing autotile_set_spacing(id: int, spacing: int)

设置atlas/autotile的subtiles之间的间距。

  • autotile_set_subtile_priority autotile_set_subtile_priority(id: int, coord: Vector2, priority: int)

在给定其坐标的情况下，根据autotile设置subtile优先级。

当多个subtile具有相同的位掩码值时，将随机选择其中之一进行绘制。

  • autotile_set_z_index autotile_set_z_index(id: int, coord: Vector2, z_index: int)

在给定其坐标的情况下，从atlas/autotile设置细分的图块索引。

  • clear clear()

清除所有图块。

  • create_tile create_tile(id: int)

使用给定的ID创建一个新的图块。

  • find_tile_by_name find_tile_by_name(name: String) const

返回与给定名称匹配的第一个图块。

  • get_last_unused_tile_id get_last_unused_tile_id() const

返回最后一个当前使用的ID之后的ID，在创建新的图块时很有用。

  • get_tiles_ids get_tiles_ids() const

返回所有当前使用的图块ID的数组。

  • remove_tile remove_tile(id: int)

删除给定的图块ID。

  • tile_add_shape tile_add_shape(id: int, shape: Shape2D, shape_transform: Transform2D, one_way: bool = false, autotile_coord: Vector2 = Vector2( 0, 0 ))

向图块添加形状。

  • tile_get_light_occluder tile_get_light_occluder(id: int) const

返回图块的光遮挡物。

  • tile_get_material tile_get_material(id: int) const

返回图块的材质。

  • tile_get_modulate tile_get_modulate(id: int) const

返回图块的调制颜色。

  • tile_get_name tile_get_name(id: int) const

返回图块的名称。

  • tile_get_navigation_polygon tile_get_navigation_polygon(id: int) const

返回图块的导航多边形。

  • tile_get_navigation_polygon_offset tile_get_navigation_polygon_offset(id: int) const

返回图块导航多边形的偏移量。

  • tile_get_normal_map tile_get_normal_map(id: int) const

返回图块的法线贴图纹理。

  • tile_get_occluder_offset tile_get_occluder_offset(id: int) const

返回图块的光遮挡物的偏移量。

  • tile_get_region tile_get_region(id: int) const

返回纹理中的tile子区域。

  • tile_get_shape tile_get_shape(id: int, shape_id: int) const

返回图块的给定形状。

  • tile_get_shape_count tile_get_shape_count(id: int) const

返回分配给图块的形状数。

  • tile_get_shape_offset tile_get_shape_offset(id: int, shape_id: int) const

返回图块形状的偏移量。

  • tile_get_shape_one_way tile_get_shape_one_way(id: int, shape_id: int) const

返回图块形状的单向碰撞值。

  • tile_get_shape_one_way_margin tile_get_shape_one_way_margin(id: int, shape_id: int) const
  • tile_get_shape_transform tile_get_shape_transform(id: int, shape_id: int) const

返回图块形状的Transform2D。

  • tile_get_shapes tile_get_shapes(id: int) const

返回图块形状的数组。

  • tile_get_texture tile_get_texture(id: int) const

返回图块的纹理。

  • tile_get_texture_offset tile_get_texture_offset(id: int) const

返回图块的纹理偏移量。

  • tile_get_tile_mode tile_get_tile_mode(id: int) const

返回图块的TileMode。

  • tile_get_z_index tile_get_z_index(id: int) const

返回图块的Z索引（绘图层）。

  • tile_set_light_occluder tile_set_light_occluder(id: int, light_occluder: OccluderPolygon2D)

为图块设置光遮挡物。

  • tile_set_material tile_set_material(id: int, material: ShaderMaterial)

设置图块的材质。

  • tile_set_modulate tile_set_modulate(id: int, color: Color)

设置图块的调制颜色。

  • tile_set_name tile_set_name(id: int, name: String)

设置图块的名称。

  • tile_set_navigation_polygon tile_set_navigation_polygon(id: int, navigation_polygon: NavigationPolygon)

设置图块的导航多边形。

  • tile_set_navigation_polygon_offset tile_set_navigation_polygon_offset(id: int, navigation_polygon_offset: Vector2)

设置图块的导航多边形的偏移量。

  • tile_set_normal_map tile_set_normal_map(id: int, normal_map: Texture)

设置图块的法线贴图纹理。

  • tile_set_occluder_offset tile_set_occluder_offset(id: int, occluder_offset: Vector2)

设置图块的光遮挡物的偏移量。

  • tile_set_region tile_set_region(id: int, region: Rect2)

在纹理中设置图块的子区域。

  • tile_set_shape tile_set_shape(id: int, shape_id: int, shape: Shape2D)

设置图块的形状，以启用碰撞。

  • tile_set_shape_offset tile_set_shape_offset(id: int, shape_id: int, shape_offset: Vector2)

设置图块形状的偏移量。

  • tile_set_shape_one_way tile_set_shape_one_way(id: int, shape_id: int, one_way: bool)

在图块的形状上启用单向碰撞。

  • tile_set_shape_one_way_margin tile_set_shape_one_way_margin(id: int, shape_id: int, one_way: float)
  • tile_set_shape_transform tile_set_shape_transform(id: int, shape_id: int, shape_transform: Transform2D)

在图块的形状上设置Transform2D。

  • tile_set_shapes tile_set_shapes(id: int, shapes: Array)

设置图块的形状数组，以启用碰撞。

  • tile_set_texture tile_set_texture(id: int, texture: Texture)

设置图块的纹理。

  • tile_set_texture_offset tile_set_texture_offset(id: int, texture_offset: Vector2)

设置平铺的纹理偏移量。

  • tile_set_tile_mode tile_set_tile_mode(id: int, tilemode: int)

设置图块的TileMode。

  • tile_set_z_index tile_set_z_index(id: int, z_index: int)

设置图块的图形索引。