RuleCheckIndicatorLogic

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

Helper logic and diagnostics for RuleCheckIndicator.

Source File: addons/grid_building/placement/rule_check_indicator/rule_check_indicator_logic.gd

Extends: RefCounted

Public Methods

build_rules_diag

1

build_rules_diag(ind: RuleCheckIndicator) -> String

Flags: static

Build a concise rules diagnostic string for an indicator. ind The indicator to inspect [return] A short summary like: “rules=2 [{pass_on_collision=true, mask=1}, …]”

build_visuals_diag

1

build_visuals_diag(ind: RuleCheckIndicator) -> String

Flags: static

Build a visual/texture diagnostic for current indicator state. ind The indicator to inspect [return] A summary like: “display=valid_settings tex=(valid=true, invalid=false) modulate=Color(1,1,1,1)”

format_indicator_state

1
2
3
4
5

format_indicator_state(
    ind: RuleCheckIndicator,
    header: String = "",
    resource_path: String = ""
) -> String

Flags: static

Build a full indicator state diagnostic formatted via GBDiagnostics. ind The indicator to inspect header Optional header line to prepend [return] Multi-line diagnostic wrapped by GBDiagnostics.format_debug

build_rules_diag_from_rules

1

build_rules_diag_from_rules(rules: Array) -> String

Flags: static

Build a concise rules diagnostic from a rules array (no indicator object required)

build_visuals_diag_from_parts

1
2
3
4
5
6

build_visuals_diag_from_parts(
    current_display_settings: IndicatorVisualSettings,
    valid_settings: IndicatorVisualSettings,
    invalid_settings: IndicatorVisualSettings,
    validity_sprite: Sprite2D
) -> String

Flags: static

Build visuals diagnostic given discrete components (no indicator object required)

format_indicator_state_from_parts

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

format_indicator_state_from_parts(
    valid: bool,
    collisions: int,
    global_position: Vector2,
    rules: Array,
    current_display_settings: IndicatorVisualSettings,
    valid_settings: IndicatorVisualSettings,
    invalid_settings: IndicatorVisualSettings,
    validity_sprite: Sprite2D,
    header: String = "",
    resource_path: String = ""
) -> String

Flags: static

Format indicator state from small pieces of data (no indicator object required)

find_highest_rule_with_visual_settings

1

find_highest_rule_with_visual_settings(p_rules: Array[TileCheckRule]) -> TileCheckRule

Flags: static

Find the rule with highest visual priority that defines fail_visual_settings.

validate_rules_from_rules_and_checker

1
2
3
4

validate_rules_from_rules_and_checker(
    p_rules: Array[TileCheckRule],
    failing_checker: Callable
) -> Array[TileCheckRule]

Flags: static

Validate the provided rules for the given indicator and return failing rules. This mirrors RuleCheckIndicator.validate_rules but as a pure function to aid testing.

choose_display_settings

1
2
3
4
5
6

choose_display_settings(
    p_display_rules: Array[TileCheckRule],
    p_is_valid: bool,
    valid_settings: IndicatorVisualSettings,
    invalid_settings: IndicatorVisualSettings
) -> IndicatorVisualSettings

Flags: static

Pick the appropriate display settings given validity state and failing rules.