GFGridSelection2D¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/foundation/math/gf_grid_selection_2d.gd - 模块：
Standard - 继承：
Resource - API：
public - 类别：协议与扩展点 (
protocol) - 首次版本：
3.17.0
通用 2D 网格格子选择器。 从候选格子中筛选一批坐标。可通过显式包含/排除、矩形边界、 自定义回调或子类重写组合出项目自己的生成规则。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 属性 | included_cells |
var included_cells: Array[Vector2i] = [] |
| 属性 | excluded_cells |
var excluded_cells: Array[Vector2i] = [] |
| 属性 | use_bounds |
var use_bounds: bool = false |
| 属性 | bounds_position |
var bounds_position: Vector2i = Vector2i.ZERO |
| 属性 | bounds_size |
var bounds_size: Vector2i = Vector2i.ZERO |
| 属性 | invert |
var invert: bool = false |
| 属性 | filter_callback |
var filter_callback: Callable = Callable() |
| 方法 | select_cells |
func select_cells(candidates: Array[Vector2i], context: Dictionary = {}) -> Array[Vector2i]: |
| 方法 | matches_cell |
func matches_cell(cell: Vector2i, context: Dictionary = {}) -> bool: |
| 方法 | _matches_cell |
func _matches_cell(cell: Vector2i, context: Dictionary) -> bool: |
属性¶
included_cells¶
- API：
public
显式包含的格子；为空时不限制。
excluded_cells¶
- API：
public
显式排除的格子。
use_bounds¶
- API：
public
是否启用矩形边界过滤。
bounds_position¶
- API：
public
边界起点。
bounds_size¶
- API：
public
边界尺寸。
invert¶
- API：
public
是否反转最终选择结果。
filter_callback¶
- API：
public
自定义过滤回调，签名为 func(cell: Vector2i, context: Dictionary) -> bool。
方法¶
select_cells¶
- API：
public
从候选格子中选择坐标。
参数：
| 名称 | 说明 |
|---|---|
candidates |
候选格子。 |
context |
项目自定义上下文。 |
返回：选中的格子。
结构：
context: Dictionary project-defined selection context.
matches_cell¶
- API：
public
检查格子是否会被选择。
参数：
| 名称 | 说明 |
|---|---|
cell |
格子坐标。 |
context |
项目自定义上下文。 |
返回：会被选择时返回 true。
结构：
context: Dictionary project-defined selection context.
_matches_cell¶
- API：
protected
执行单个格子的选择判断。子类可重写该方法定义项目自己的选择规则。
参数：
| 名称 | 说明 |
|---|---|
cell |
格子坐标。 |
context |
项目自定义上下文。 |
返回：选中该格子时返回 true。
结构：
context: Dictionary project-defined selection context.