PlacementModeService

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 PlacementModeService : IPlacementModeService

Summary

Simple placement mode service used by UI adapters. This is distinct from the core placement service (GridPlacement.Core.Services.Placement.IPlacementService) and is responsible for tracking the currently selected placeable for place mode.

Metadata

Namespace: GridPlacement.Core.Services

Source File: cs/Core/Services/PlacementModeService.cs

Assembly: GridPlacement.Core

Type: class

Implements

  • IPlacementModeService

Properties

IsInPlacementMode

1
public bool IsInPlacementMode { get; set; }

Gets whether the user is currently in placement mode.


CurrentPlaceableId

1
public string? CurrentPlaceableId { get; set; }

Gets the currently selected placeable ID, if any.


Methods

BeginPlacement

1
public void BeginPlacement(string placeableId)

CancelPlacement

1
public void CancelPlacement()

Events

PlacementStarted

1
public event EventHandler<string>? PlacementStarted

Raised when placement mode begins with a specific placeable.


PlacementCancelled

1
public event EventHandler? PlacementCancelled

Raised when placement mode is cancelled.