Class IndicatorSetupReport

Namespace

MoonBark.GridPlacement.Core.Data

Assembly

MoonBark.GridPlacement.Core.dll

Core POCS implementation of IndicatorSetupReport for state management. Report containing diagnostic information from indicator setup operations.

Ported from: godot/addons/grid_building/systems/placement/managers/indicator_setup_report.gd

public class IndicatorSetupReport

Inheritance

object

IndicatorSetupReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

IndicatorSetupReport()

Creates a new IndicatorSetupReport with empty collections.

public IndicatorSetupReport()

IndicatorSetupReport(List<IPlacementRule>, IGridMap2D?, IGridPositioner?, IIndicatorTemplate?)

Creates a new IndicatorSetupReport.

public IndicatorSetupReport(List<IPlacementRule> tileCheckRules, IGridMap2D? targetMap, IGridPositioner? positioner, IIndicatorTemplate? indicatorTemplate)

Parameters

tileCheckRules List<IPlacementRule>

The tile check rules that were applied

targetMap IGridMap2D

The target map used for setup

positioner IGridPositioner

The positioner used for setup

indicatorTemplate IIndicatorTemplate

The indicator template used

Properties

DiagnosticMetadata

Diagnostic metadata.

public Dictionary<string, object> DiagnosticMetadata { get; }

Property Value

Dictionary<string, object>

IndicatorTemplate

The indicator template used.

public IIndicatorTemplate? IndicatorTemplate { get; }

Property Value

IIndicatorTemplate

Issues

List of issues found during setup.

public List<string> Issues { get; }

Property Value

List<string>

Positioner

The positioner used for setup.

public IGridPositioner? Positioner { get; }

Property Value

IGridPositioner

TargetMap

The target map used for setup.

public IGridMap2D? TargetMap { get; }

Property Value

IGridMap2D

TileCheckRules

The tile check rules that were applied.

public List<IPlacementRule> TileCheckRules { get; }

Property Value

List<IPlacementRule>

Methods

AddIssue(string)

Adds an issue to the report.

public void AddIssue(string issue)

Parameters

issue string

The issue to add

AddIssues(IEnumerable<string>)

Adds multiple issues to the report.

public void AddIssues(IEnumerable<string> issues)

Parameters

issues IEnumerable<string>

The issues to add

IsFailed()

Checks if the setup failed.

public bool IsFailed()

Returns

bool

True if failed, false otherwise

IsSuccessful()

Checks if the setup was successful.

public bool IsSuccessful()

Returns

bool

True if successful, false otherwise

ToString()

Gets a string representation of the report.

public override string ToString()

Returns

string

String representation

ToVerboseString()

Gets a verbose string representation of the report.

public string ToVerboseString()

Returns

string

Verbose string representation