PlaceableEntry

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
2
3
4
5
public record PlaceableEntry(
    string Id,
    string Category,
    string DisplayName
)

Summary

Represents a single placeable item exposed through IPlaceableCatalog and PlaceableSequence. This is a pure C# data type with no engine dependencies.

Parameters

Name	Description
`Id`	Stable unique identifier for this placeable.
`Category`	Category used for filtering (for example, “buildings” or “decorations”).
`DisplayName`	Human-readable name shown in UI and tooling.

Metadata

Namespace: GridPlacement.Core.Catalog

Source File: cs/Core/Catalog/PlaceableEntry.cs

Assembly: GridPlacement.Core

Type: record

Implements

IEquatable<PlaceableEntry>

Constructors

PlaceableEntry

1
2
3
4
5
public PlaceableEntry(
    string Id,
    string Category,
    string DisplayName
)

Represents a single placeable item exposed through IPlaceableCatalog and PlaceableSequence. This is a pure C# data type with no engine dependencies.

Parameters

Name	Description
`Id`	Stable unique identifier for this placeable.
`Category`	Category used for filtering (for example, “buildings” or “decorations”).
`DisplayName`	Human-readable name shown in UI and tooling.

Properties

DisplayName

1
public string DisplayName { get; init; }

Id

1
public string Id { get; init; }

IconPath

1
public string? IconPath { get; init; }

Optional icon path or resource identifier for UI rendering.

Description

1
public string? Description { get; init; }

Optional description for tooltips.

Metadata

1
public IReadOnlyDictionary<string, object>? Metadata { get; init; }

Optional metadata dictionary for custom properties.