Skip to content

Class

RuleResult

Generated GDScript class reference for GridPlacement.RuleResult.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

Results from placement rule validation. RuleResult encapsulates the outcome of evaluating a placement rule, storing validation issues, success state, and contextual information for debugging and logging. The class supports both incremental construction (for building issues during validation) and complete construction (for finished results). Success is determined by the absence of validation issues, making the result self-documenting and suitable for build logs and user feedback systems.

Source: addons/grid_placement/placement/placement_rules/rule_result.gd

Syntax

class RuleResult extends RefCounted

Members

NameKindSummary
rulePropertyThe rule that was tested.
issuesPropertyIssues found during validation.
buildMethod
add_issueMethod
add_issuesMethod
is_successfulMethod
is_emptyMethod
get_issuesMethod