PlacementReport

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

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

Version: 5.1

class_name: PlacementReport extends: RefCounted

Summary

Report generated for a placement action outcome.

Encapsulates all relevant information about a placement attempt including the entity performing the action, the object being placed, validation results, and any issues or notes encountered during the process.

Signals

(none)

Exports

(none)

Methods

• _init()
  • Constructor for creating a placement report. [param p_placer] The GBOwner entity responsible for initiating placement. [param p_preview_instance] The Node being tested for placement validity. [param p_indicators_report] The IndicatorSetupReport from validation. [param p_action_type] The type of placement action (BUILD, MOVE, etc.).
• add_issue()
  • Adds an issue to the report’s issues list. Issues represent problems or validation failures that occurred during placement. [param p_issue] The issue message to add.
• add_note()
  • Adds a diagnostic note to the report’s notes list. Notes contain additional information about the placement process that may be useful for debugging or logging, but don’t represent errors. [param p_note] The diagnostic note to add.
• get_placer_root()
  • Returns the root node of the entity responsible for placement. [return] The root Node of the GBOwner entity, or null if no placer is set.
• is_successful()
  • Checks if the placement was successful (no issues or validation failures). [return] True if placement succeeded, false if any issues occurred.
• get_issues()
  • Returns all issues associated with this placement attempt, including any indicator validation failures collected in the associated IndicatorSetupReport. [return] An array of issue strings aggregated from both primary report issues and indicator validation failures.
• to_verbose_string()
  • Converts the report to a verbose string representation for debugging. [return] A formatted string containing all report information.