GBValidationResults

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: systems/placement/validators/placement_rules/gb_validation_results.gd

Version: 5.1

class_name: GBValidationResults extends: RefCounted

Summary

Results from building rule validation tests.

Signals

(none)

Exports

(none)

Methods

• _init()
  • Constructor for creating validation results.[br][br] [code]p_is_successful[/code]: [i]bool[/i] - Whether validation passed[br] [code]p_message[/code]: [i]String[/i] - Success or failure message[br] [code]p_rule_results[/code]: [i]Dictionary[PlacementRule, Array][/i] - Individual rule results including an array of issues for each rule prevent successful placement validation
• add_rule_result()
  • Adds a rule result for a specific placement rule.
• get_issues()
• add_error()
  • Adds a configuration/setup error This should be reported to the developer appropriately
• add_issue()
  • Adds an issue to the validation results This is for validation issues (not configuration errors)
• is_successful()
  • Checks that there were no validation issues with the placement of the object
• has_failing_rules()
  • Whether the validation had any failing placement rules
• has_errors()
  • Whether the validation had any development configuration or setup errors These should be reported to the developer
• get_successful_rules()
  • Gets the successful rules
• get_failing_rules()
  • Gets the failing rules
• get_errors()
  • Gets the configuration/setup errors in a duplicated array
• get_failing_rule_results()
  • Gets the failing rules and their issues Array[String]
• get_summary_string()
  • Generates a concise summary string of the validation results.