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

1
public static class GridModeExtensions

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

1
public static string ToDisplayString(this GridMode mode)

Converts the mode to a display-friendly string.

Parameters

NameDescription
modeThe mode to convert.

Returns

A display string for the mode.


IsToolMode

1
public static bool IsToolMode(this GridMode mode)

Returns whether the mode represents an active tool mode (e.g. place, move, remove).

Parameters

NameDescription
modeThe mode to evaluate.

Returns

true if the mode is a tool mode; otherwise false.


IsActiveMode

1
public static bool IsActiveMode(this GridMode mode)

Returns whether the mode is active (not Off).

Parameters

NameDescription
modeThe mode to evaluate.

Returns

true if the mode is active; otherwise false.


ToStringValue

1
public static string ToStringValue(this GridMode mode)

Converts the mode to a lowercase string for UI compatibility.

Parameters

NameDescription
modeThe mode to convert.

Returns

A lowercase string for the mode.