CollisionsCheckRule

Returns an array of issues found during runtime validation

sort Weight: 10

Returns an array of issues found during runtime validation

Version: v5.0.0

STABLE

Inherits: TileCheckRule
Source: collisions_check_rule.gd
Parsing: AST-based for maximum accuracy with symbol typing


Variables

_rule_check_layer_names: Array[String]

Type: Array[String]


Methods

_init

Signature: _init() -> void

Returns: void


setup

Signature: setup(p_gts : GridTargetingState: Variant) -> Array

[returns] Array[String] - Array of issues found during setup

Returns: Array

Parameters:

  • p_gts : GridTargetingState: Variant

validate_placement

Signature: validate_placement() -> RuleResult

Returns a RuleResult with success/failure and messages.

Returns: RuleResult


get_failing_indicators

Signature: get_failing_indicators(p_indicators : Array[RuleCheckIndicator]: Variant) -> Array

private wrapper _get_failing_indicators was removed to simplify the API.

Returns: Array

Parameters:

  • p_indicators : Array[RuleCheckIndicator]: Variant

_indicator_apply_target_exceptions

Signature: _indicator_apply_target_exceptions(indicator: ShapeCast2D) -> void

Also adds any nodes from GridTargetingState.collision_exclusions (e.g., original object during manipulation move).

Returns: void

Parameters:

  • indicator: ShapeCast2D

_collect_bodies_recursive

Signature: _collect_bodies_recursive(node: Node, out: Array[CollisionObject2D]: Variant) -> void

Apply all collected bodies as exceptions

Returns: void

Parameters:

  • node: Node
  • out: Array[CollisionObject2D]: Variant

get_editor_issues

Signature: get_editor_issues() -> Array

Returns an array of issues found during editor validation

Returns: Array


get_runtime_issues

Signature: get_runtime_issues() -> Array

Returns an array of issues found during runtime validation

Returns: Array