Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

TileData

繼承: Object

TileSet 中單個圖塊的設定。

說明

TileData 物件代表 TileSet 中的單個圖塊,通常使用圖塊集編輯器進行編輯,但也可以在執行時使用 TileMapLayer._tile_data_runtime_update() 進行修改。

屬性

bool

flip_h

false

bool

flip_v

false

Material

material

Color

modulate

Color(1, 1, 1, 1)

float

probability

1.0

int

terrain

-1

int

terrain_set

-1

Vector2i

texture_origin

Vector2i(0, 0)

bool

transpose

false

int

y_sort_origin

0

int

z_index

0

方法

void

add_collision_polygon(layer_id: int)

void

add_occluder_polygon(layer_id: int)

float

get_collision_polygon_one_way_margin(layer_id: int, polygon_index: int) const

PackedVector2Array

get_collision_polygon_points(layer_id: int, polygon_index: int) const

int

get_collision_polygons_count(layer_id: int) const

float

get_constant_angular_velocity(layer_id: int) const

Vector2

get_constant_linear_velocity(layer_id: int) const

Variant

get_custom_data(layer_name: String) const

Variant

get_custom_data_by_layer_id(layer_id: int) const

NavigationPolygon

get_navigation_polygon(layer_id: int, flip_h: bool = false, flip_v: bool = false, transpose: bool = false) const

OccluderPolygon2D

get_occluder(layer_id: int, flip_h: bool = false, flip_v: bool = false, transpose: bool = false) const

OccluderPolygon2D

get_occluder_polygon(layer_id: int, polygon_index: int, flip_h: bool = false, flip_v: bool = false, transpose: bool = false) const

int

get_occluder_polygons_count(layer_id: int) const

int

get_terrain_peering_bit(peering_bit: CellNeighbor) const

bool

has_custom_data(layer_name: String) const

bool

is_collision_polygon_one_way(layer_id: int, polygon_index: int) const

bool

is_valid_terrain_peering_bit(peering_bit: CellNeighbor) const

void

remove_collision_polygon(layer_id: int, polygon_index: int)

void

remove_occluder_polygon(layer_id: int, polygon_index: int)

void

set_collision_polygon_one_way(layer_id: int, polygon_index: int, one_way: bool)

void

set_collision_polygon_one_way_margin(layer_id: int, polygon_index: int, one_way_margin: float)

void

set_collision_polygon_points(layer_id: int, polygon_index: int, polygon: PackedVector2Array)

void

set_collision_polygons_count(layer_id: int, polygons_count: int)

void

set_constant_angular_velocity(layer_id: int, velocity: float)

void

set_constant_linear_velocity(layer_id: int, velocity: Vector2)

void

set_custom_data(layer_name: String, value: Variant)

void

set_custom_data_by_layer_id(layer_id: int, value: Variant)

void

set_navigation_polygon(layer_id: int, navigation_polygon: NavigationPolygon)

void

set_occluder(layer_id: int, occluder_polygon: OccluderPolygon2D)

void

set_occluder_polygon(layer_id: int, polygon_index: int, polygon: OccluderPolygon2D)

void

set_occluder_polygons_count(layer_id: int, polygons_count: int)

void

set_terrain_peering_bit(peering_bit: CellNeighbor, terrain: int)


訊號

changed() 🔗

任何屬性發生變化時發出。


屬性說明

bool flip_h = false 🔗

  • void set_flip_h(value: bool)

  • bool get_flip_h()

如果為 true,則該圖塊的紋理會被水平翻轉。


bool flip_v = false 🔗

  • void set_flip_v(value: bool)

  • bool get_flip_v()

如果為 true,則該圖塊的紋理會被垂直翻轉。


Material material 🔗

用於此 TileData 的 Material。使用預設著色器可以設為 CanvasItemMaterial,使用自訂著色器可以設為 ShaderMaterial。


Color modulate = Color(1, 1, 1, 1) 🔗

  • void set_modulate(value: Color)

  • Color get_modulate()

該圖塊的顏色調變。


float probability = 1.0 🔗

  • void set_probability(value: float)

  • float get_probability()

繪製隨機圖塊圖案時選擇該圖塊的相對概率。


int terrain = -1 🔗

  • void set_terrain(value: int)

  • int get_terrain()

該圖塊所使用的地形集中地形的 ID。


int terrain_set = -1 🔗

  • void set_terrain_set(value: int)

  • int get_terrain_set()

該圖塊所使用的地形集的 ID。


Vector2i texture_origin = Vector2i(0, 0) 🔗

該圖塊繪製時的位置偏移量。


bool transpose = false 🔗

  • void set_transpose(value: bool)

  • bool get_transpose()

如果為 true,則該圖塊會轉置顯示,即調換水平和垂直紋理 UV。


int y_sort_origin = 0 🔗

  • void set_y_sort_origin(value: int)

  • int get_y_sort_origin()

該圖塊用於確定 Y 排序順序的垂直點。


int z_index = 0 🔗

  • void set_z_index(value: int)

  • int get_z_index()

該圖塊的排序索引,相對於 TileMapLayer。


方法說明

void add_collision_polygon(layer_id: int) 🔗

為該圖塊在給定的 TileSet 實體層上新增碰撞多邊形。


void add_occluder_polygon(layer_id: int) 🔗

在索引為 layer_id 的 TileSet 遮擋層上為圖塊新增一個遮擋多邊形。


float get_collision_polygon_one_way_margin(layer_id: int, polygon_index: int) const 🔗

返回在索引為 layer_id 的 TileSet 實體層上,索引為 polygon_index 的多邊形的單向邊距(用於單向平臺)。


PackedVector2Array get_collision_polygon_points(layer_id: int, polygon_index: int) const 🔗

返回在索引為 layer_id 的 TileSet 實體層上,索引為 polygon_index 的多邊形的點。


int get_collision_polygons_count(layer_id: int) const 🔗

設定該圖塊中索引為 layer_id 的 TileSet 實體層中多邊形的數量。


float get_constant_angular_velocity(layer_id: int) const 🔗

返回恒定角速度,將套用於與此圖塊碰撞的物件。


Vector2 get_constant_linear_velocity(layer_id: int) const 🔗

返回恒定線速度,將套用於與此圖塊碰撞的物件。


Variant get_custom_data(layer_name: String) const 🔗

回傳名為 layer_name 的自訂資料層的自訂資料值。檢查自訂資料層是否存在請使用 has_custom_data()。


Variant get_custom_data_by_layer_id(layer_id: int) const 🔗

返回自訂資料層的自訂資料值,自訂資料層用索引 layer_id 指定。


NavigationPolygon get_navigation_polygon(layer_id: int, flip_h: bool = false, flip_v: bool = false, transpose: bool = false) const 🔗

回傳圖塊的導航多邊形,對應的 TileSet 導航層由索引 layer_id 指定。

可以使用 flip_h、flip_v、transpose 對回傳的多邊形進行變換。


OccluderPolygon2D get_occluder(layer_id: int, flip_h: bool = false, flip_v: bool = false, transpose: bool = false) const 🔗

已棄用: Use get_occluder_polygon() instead.

回傳圖塊的遮擋器多邊形,對應的 TileSet 遮擋層由索引 layer_id 指定。

可以使用 flip_h、flip_v、transpose 對回傳的多邊形進行變換。


OccluderPolygon2D get_occluder_polygon(layer_id: int, polygon_index: int, flip_h: bool = false, flip_v: bool = false, transpose: bool = false) const 🔗

回傳索引為 layer_id 的 TileSet 遮擋層的遮擋器中索引為 polygon_index 的多邊形。

參數 flip_h、flip_v、transpose 參數可以為 true,對回傳的多邊形進行變換。


int get_occluder_polygons_count(layer_id: int) const 🔗

回傳索引為 layer_id 的 TileSet 遮擋層的遮擋器多邊形的數量。


int get_terrain_peering_bit(peering_bit: CellNeighbor) const 🔗

回傳該圖塊給定 peering_bit 方向的地形位。要檢查方向是否有效,請使用 is_valid_terrain_peering_bit()。


bool has_custom_data(layer_name: String) const 🔗

回傳是否存在名為 layer_name 的自訂資料層。


bool is_collision_polygon_one_way(layer_id: int, polygon_index: int) const 🔗

返回索引為 layer_id 的 TileSet 實體層上索引為 polygon_index 的多邊形是否啟用了單向碰撞。


bool is_valid_terrain_peering_bit(peering_bit: CellNeighbor) const 🔗

回傳給定的 peering_bit 方向對於該圖塊是否有效。


void remove_collision_polygon(layer_id: int, polygon_index: int) 🔗

移除索引為 layer_id 的 TileSet 實體層上索引為 polygon_index 的多邊形。


void remove_occluder_polygon(layer_id: int, polygon_index: int) 🔗

移除索引為 layer_id 的 TileSet 遮擋層上索引為 polygon_index 的多邊形。


void set_collision_polygon_one_way(layer_id: int, polygon_index: int, one_way: bool) 🔗

啟用/停用索引為 layer_id 的 TileSet 實體層上索引為 polygon_index 的多邊形的單向碰撞。


void set_collision_polygon_one_way_margin(layer_id: int, polygon_index: int, one_way_margin: float) 🔗

設定在索引為 layer_id 的 TileSet 物理層上,索引為 polygon_index 的多邊形的單向邊距(用於單向平台)。


void set_collision_polygon_points(layer_id: int, polygon_index: int, polygon: PackedVector2Array) 🔗

設定索引為 layer_id 的 TileSet 實體層上索引為 polygon_index 的多邊形的頂點。


void set_collision_polygons_count(layer_id: int, polygons_count: int) 🔗

設定索引為 layer_id 的 TileSet 實體層中多邊形的數量。


void set_constant_angular_velocity(layer_id: int, velocity: float) 🔗

設定恒定角速度。不會旋轉圖塊。會對與該圖塊發生碰撞的物件套用該角速度。


void set_constant_linear_velocity(layer_id: int, velocity: Vector2) 🔗

設定恒定線速度。不會旋轉圖塊。會對與該圖塊發生碰撞的物件套用該線速度。可用於建立傳送帶。


void set_custom_data(layer_name: String, value: Variant) 🔗

設定該圖塊的自訂資料值,TileSet 自訂資料層由名稱 layer_name 指定。


void set_custom_data_by_layer_id(layer_id: int, value: Variant) 🔗

設定該圖塊的自訂資料值,TileSet 自訂資料層由索引 layer_id 指定。


void set_navigation_polygon(layer_id: int, navigation_polygon: NavigationPolygon) 🔗

設定索引為 layer_id 的 TileSet 導覽層的導覽多邊形。


void set_occluder(layer_id: int, occluder_polygon: OccluderPolygon2D) 🔗

已棄用: Use set_occluder_polygon() instead.

設定索引為 layer_id 的 TileSet 遮擋層的遮擋器。


void set_occluder_polygon(layer_id: int, polygon_index: int, polygon: OccluderPolygon2D) 🔗

設定索引為 layer_id 的 TileSet 遮擋層的遮擋器中索引為 polygon_index 的多邊形。


void set_occluder_polygons_count(layer_id: int, polygons_count: int) 🔗

設定索引為 layer_id 的 TileSet 遮擋層的遮擋器多邊形數量。


void set_terrain_peering_bit(peering_bit: CellNeighbor, terrain: int) 🔗

設定該圖塊給定 peering_bit 方向的地形位。要檢查方向是否有效,請使用 is_valid_terrain_peering_bit()。