ValidationResults

Summary

Results from building rule validation tests.

message: String: Success or failure message.
rule_results: Dictionary[PlacementRule, RuleResult] = {}: Individual rule results

add_rule_result( p_placement_rule: PlacementRule, p_result: RuleResult ) -> void: Adds a rule result for a specific placement rule.
get_all_issues( ) -> Array[String]
add_error( p_error: String ) -> void: Adds a configuration/setup error This should be reported to the developer appropriately
is_successful( ) -> bool: Checks that there were no validation issues with the placement of the object
has_failing_rules( ) -> bool: Whether the validation had any failing placement rules
has_errors( ) -> bool: Whether the validation had any development configuration or setup errors These should be reported to the developer
get_successful_rules( ) -> Array[PlacementRule]: Gets the successful rules
get_failing_rules( ) -> Array[PlacementRule]: Gets the failing rules
get_errors( ) -> Array[String]: Gets the configuration/setup errors in a duplicated array
get_failing_rule_results( ) -> Dictionary[PlacementRule, Array]: Gets the failing rules and their issues Array[String]
get_summary_string( ) -> String: Generates a concise summary string of the validation results.

addons/grid_building/placement/placement_rules/validation_results.gd

This page was auto-generated from GDScript source. Edit the source file to improve documentation.

Generated on 2025-09-07