IndicatorModel

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

This page documents the supported public API surface only. Private, internal, benchmark, test, and implementation-detail types are intentionally omitted.

Declaration

1

public class IndicatorModel

Summary

Represents an indicator model for placement validation.

This class contains the visual data needed to show placement indicators (valid/invalid tiles, collision areas, etc.).

Metadata

Namespace: GridPlacement.Core.Types

Source File: cs/Core/Types/PreviewModel.cs

Assembly: GridPlacement.Core

Type: class

Constructors

IndicatorModel

1

public IndicatorModel()

Initializes a new instance of the IndicatorModel class.

Properties

IsVisible

1

public bool IsVisible { get; set; }

Gets or sets whether the indicators should be visible.

ValidPositions

1

public List<CoreVector2I> ValidPositions { get; set; }

Gets or sets the list of valid indicator positions.

InvalidPositions

1

public List<CoreVector2I> InvalidPositions { get; set; }

Gets or sets the list of invalid indicator positions.

ValidColor

1

public CoreColor ValidColor { get; set; }

Gets or sets the indicator color for valid positions.

InvalidColor

1

public CoreColor InvalidColor { get; set; }

Gets or sets the indicator color for invalid positions.

Methods

Visible

1
2
3
4
5
6

public static IndicatorModel Visible(
    List<CoreVector2I> validPositions,
    List<CoreVector2I> invalidPositions,
    CoreColor validColor = default,
    CoreColor invalidColor = default
)

Creates a visible indicator model with the specified positions.

Parameters

Returns

A new IndicatorModel instance.

Hidden

1

public static IndicatorModel Hidden()

Creates a hidden indicator model.

Returns

A new hidden IndicatorModel instance.