IPlacementCommands

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 IPlacementCommands

Summary

High-level placement commands surface for GridBuilding. Engine-agnostic entry points that describe “what” to do, using UserId to indicate who is issuing the command.

Metadata

Namespace: GridPlacement.Core.Interfaces

Source File: cs/Core/Interfaces/IPlacementCommands.cs

Assembly: GridPlacement.Core

Type: interface

Methods

TryPlace

1
2
3
4
5
PlacementResult TryPlace(
    GPUserId userId,
    Placeable placeable,
    CoreVector2 worldPosition
)

Attempts to place a placeable at the given world position for the specified user.

Parameters

Name	Description
`userId`	User issuing the command.
`placeable`	Placeable definition to place.
`worldPosition`	World-space position for placement.

Returns

PlacementResult describing success and details.

TryDemolish

1
2
3
4
PlacementResult TryDemolish(
    GPUserId userId,
    CoreVector2 worldPosition
)

Attempts to demolish a building/object at the given world position for the specified user.

Parameters

Name	Description
`userId`	User issuing the command.
`worldPosition`	World-space position to demolish at.

Returns

PlacementResult describing success and details.