Class PlacementReport

Namespace

MoonBark.GridPlacement.Core.Results

Assembly

MoonBark.GridPlacement.Core.dll

Represents a placement report containing validation results and placement data.

This class contains information about a placement operation including validation results, the placeable being placed, and other contextual data.

public class PlacementReport

Inheritance

object

PlacementReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PlacementReport(IOwner?, Placeable?, CoreVector2I?, ManipulationAction)

Initializes a new instance of the PlacementReport class.

public PlacementReport(IOwner? owner, Placeable? placeable, CoreVector2I? position, ManipulationAction action)

Parameters

owner IOwner

The owner performing the placement.

placeable Placeable

The placeable being placed.

position CoreVector2I?

The placement position.

action ManipulationAction

The manipulation action.

Properties

Action

Gets the manipulation action being performed.

public ManipulationAction Action { get; }

Property Value

ManipulationAction

IndicatorsReport

Optional indicator setup diagnostics associated with this report.

public IndicatorSetupReport? IndicatorsReport { get; set; }

Property Value

IndicatorSetupReport

IsSuccessful

Gets whether the placement is successful.

public bool IsSuccessful { get; }

Property Value

bool

Issues

Gets the list of placement issues.

public List<string> Issues { get; }

Property Value

List<string>

Notes

Supplemental notes for diagnostics.

public List<string> Notes { get; }

Property Value

List<string>

Owner

Gets the owner who performed the placement.

public IOwner? Owner { get; }

Property Value

IOwner

Placeable

Gets the placeable being placed.

public Placeable? Placeable { get; }

Property Value

Placeable

Placed

Legacy alias used by older workflow code paths.

public Placeable? Placed { get; set; }

Property Value

Placeable

Position

Gets the position where the placeable is being placed.

public CoreVector2I? Position { get; }

Property Value

CoreVector2I?

StructuredIssues

public List<PlacementValidationIssue> StructuredIssues { get; }

Property Value

List<PlacementValidationIssue>

Methods

AddIssue(string)

Adds an issue to the placement report.

public void AddIssue(string issue)

Parameters

issue string

The issue to add.

AddNote(string)

public void AddNote(string note)

Parameters

note string

AddStructuredIssue(PlacementValidationIssue)

Adds a structured validation issue to the placement report.

public void AddStructuredIssue(PlacementValidationIssue issue)

Parameters

issue PlacementValidationIssue

The structured issue to add.

GetIssues()

Gets all placement issues.

public List<string> GetIssues()

Returns

List<string>

A list of placement issues.

IsFailed()

public bool IsFailed()

Returns

bool

ToVerboseString()

public string ToVerboseString()

Returns

string