GFGridGenerationStep2D¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/foundation/math/gf_grid_generation_step_2d.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：资源定义 (
resource_definition) - 首次版本：
3.17.0
通用 2D 网格生成步骤。 将选择器命中的格子写入或移除一个 Variant 值。它只操作字典数据， 不绑定 TileMap、GridMap、房间、碰撞或具体玩法。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | step_id |
var step_id: StringName = &"" |
| 属性 | selection |
var selection: GFGridSelection2D = null |
| 属性 | value |
var value: Variant = true |
| 属性 | erase_cells |
var erase_cells: bool = false |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 属性 | value_callback |
var value_callback: Callable = Callable() |
| 方法 | apply |
func apply( grid: Dictionary, candidates: Array[Vector2i], context: Dictionary = {} ) -> int: |
| 方法 | get_debug_snapshot |
func get_debug_snapshot() -> Dictionary: |
属性¶
step_id¶
- API：
public
步骤标识。
selection¶
- API：
public
格子选择器；为空时作用于全部候选格子。
value¶
- API：
public
要写入的值。
结构：
value: Variant value written to selected cells.
erase_cells¶
- API：
public
为 true 时移除选中格子，而不是写入值。
metadata¶
- API：
public
步骤元数据。
结构：
metadata: Dictionary extension metadata for the generation step.
value_callback¶
- API：
public
自定义值回调，签名为 func(cell: Vector2i, previous_value: Variant, context: Dictionary) -> Variant。
方法¶
apply¶
- API：
public
应用生成步骤。
参数：
| 名称 | 说明 |
|---|---|
grid |
目标网格字典，key 为 Vector2i。 |
candidates |
候选格子。 |
context |
项目自定义上下文。 |
返回：被修改的格子数量。
结构：
grid: Dictionary mapping Vector2i cells to generated values; mutated in place.context: Dictionary project-defined generation context.
get_debug_snapshot¶
- API：
public
获取步骤诊断快照。
返回：诊断字典。
结构：
return: Dictionary with step_id, erase_cells, has_selection, has_value_callback, and metadata.