Table of Contents

Class ValidationResults

Namespace
GridPlacement.GDScript
Assembly
MoonBark.GridPlacement.GDScript.dll

Results from building rule validation tests.

class ValidationResults extends RefCounted
ValidationResults

Properties

message

Success or failure message.

var message: String

rule_results

Individual rule results

var rule_results: Dictionary[PlacementRule, RuleResult] = {}

all_issues

var all_issues = get_issues()

successful_rules

var successful_rules = get_successful_rules().size()

rule_result

var rule_result: RuleResult = rule_results[rule]

failing_rules

var failing_rules: Array[PlacementRule] = []

rule_result

var rule_result: RuleResult = rule_results[rule]

failing_results

var failing_results: Dictionary[PlacementRule, Array] = {}

total_rules

var total_rules = rule_results.size()

successful_rules

var successful_rules = get_successful_rules().size()

failed_rules

var failed_rules = get_failing_rules().size()

success_rate

var success_rate = 0.0

all_issues

var all_issues = get_issues()

Methods

add_rule_result

func add_rule_result(p_placement_rule : PlacementRule, p_result : RuleResult) -> void:

Parameters

p_placement_rule
p_result

Returns

get_issues

func get_issues() -> Array[String]:

Returns

add_error

func add_error(p_error : String) -> void:

Parameters

p_error

Returns

add_issue

func add_issue(p_issue : String) -> void:

Parameters

p_issue

Returns

is_successful

func is_successful() -> bool:

Returns

has_failing_rules

func has_failing_rules() -> bool:

Returns

has_errors

func has_errors() -> bool:

Returns

get_successful_rules

func get_successful_rules() -> Array[PlacementRule]:

Returns

get_failing_rules

func get_failing_rules() -> Array[PlacementRule]:

Returns

get_errors

func get_errors() -> Array[String]:

Returns

get_failing_rule_results

func get_failing_rule_results() -> Dictionary[PlacementRule, Array]:

Returns

get_summary_string

func get_summary_string() -> String:

Returns