GridModeExtensions
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
Summary
Extension methods for working with GridMode values.
Metadata
Namespace: GridPlacement.Core.Types
Source File: cs/Core/Types/GridModeExtensions.cs
Assembly: GridPlacement.Core
Type: class
Methods
ToDisplayString
Converts the mode to a display-friendly string.
Parameters
| Name | Description |
|---|---|
mode | The mode to convert. |
Returns
A display string for the mode.
IsToolMode
Returns whether the mode represents an active tool mode (e.g. place, move, remove).
Parameters
| Name | Description |
|---|---|
mode | The mode to evaluate. |
Returns
true if the mode is a tool mode; otherwise false.
IsActiveMode
Returns whether the mode is active (not Off).
Parameters
| Name | Description |
|---|---|
mode | The mode to evaluate. |
Returns
true if the mode is active; otherwise false.
ToStringValue
Converts the mode to a lowercase string for UI compatibility.
Parameters
| Name | Description |
|---|---|
mode | The mode to convert. |
Returns
A lowercase string for the mode.