IPlaceableCatalog

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 interface IPlaceableCatalog

Summary

Service interface for managing available placeables. Pure C# contract with no Godot dependencies.

Metadata

Namespace: GridPlacement.Core.Catalog

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

Assembly: GridPlacement.Core

Type: interface

Methods

GetAll

1
IReadOnlyList<PlaceableEntry> GetAll()

Gets all available placeables.

Returns

Read-only list of all placeable entries.

GetByCategory

1
IReadOnlyList<PlaceableEntry> GetByCategory(string category)

Gets placeables filtered by category.

Parameters

Name	Description
`category`	Category to filter by (case-insensitive).

Returns

Read-only list of matching entries.

TryGet

1
2
3
4
bool TryGet(
    string id,
    out PlaceableEntry? entry
)

Tries to get a placeable by ID.

Parameters

Name	Description
`id`	Placeable ID.
`entry`	The entry if found, null otherwise.

Returns

True if found, false otherwise.

GetSequence

1
PlaceableSequence? GetSequence(string id)

Gets a placeable sequence by ID.

Parameters

Name	Description
`id`	Sequence ID.

Returns

The sequence if found, null otherwise.

Add

1
void Add(PlaceableEntry entry)

Adds a placeable to the catalog.

Parameters

Name	Description
`entry`	Entry to add.

Remove

1
bool Remove(string id)

Removes a placeable from the catalog.

Parameters

Name	Description
`id`	ID of the entry to remove.

Returns

True if removed, false if not found.

AddSequence

1
void AddSequence(PlaceableSequence sequence)

Adds a placeable sequence to the catalog.

Parameters

Name	Description
`sequence`	Sequence to add.