Chris' Tutorials
Docs/Grid Placement

Class

RuleResult

Generated GDScript class reference for GridPlacement.RuleResult.

StatusDraft
Versionv6.0
UpdatedDevelopment docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.

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
resultProperty
add_issueMethod
add_issuesMethod
is_successfulMethod
is_emptyMethod
get_issuesMethod

Source

addons/grid_placement/placement/placement_rules/rule_result.gd

Plugin docs root:gdscript/plugins/grid_placement_dev/docs