ManipulationResult

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 ManipulationResult

Summary

Result of a manipulation operation

Metadata

Namespace: GridPlacement.Core.Types

Source File: cs/Core/Types/ManipulationResult.cs

Assembly: GridPlacement.Core

Type: class

Constructors

ManipulationResult

1

public ManipulationResult()

Initializes a new instance of the ManipulationResult class.

ManipulationResult

1
2
3
4

public ManipulationResult(
    bool success,
    string errorMessage = ""
)

Initializes a new instance of the ManipulationResult class.

Parameters

Properties

IsSuccess

1

public bool IsSuccess { get; set; }

Whether the operation was successful

IsValid

1

public bool IsValid { get; set; }

Whether the operation was valid (alias for IsSuccess, for compatibility)

ErrorMessage

1

public string ErrorMessage { get; set; }

Error message if operation failed

Message

1

public string Message { get; set; }

Message (alias for ErrorMessage, for compatibility)

ManipulationType

1

public ManipulationAction ManipulationType { get; set; }

Type of manipulation that was performed

OriginalPosition

1

public CoreVector2I OriginalPosition { get; set; }

Original position before manipulation

NewPosition

1

public CoreVector2I NewPosition { get; set; }

New position after manipulation

AffectedPositions

1

public List<CoreVector2I> AffectedPositions { get; set; }

Affected positions

Metadata

1

public Dictionary<string, object> Metadata { get; set; }

Operation metadata

Data

1

public Dictionary<string, object> Data { get; set; }

Additional data (alias for Metadata, for compatibility)

Timestamp

1

public DateTime Timestamp { get; set; }

Timestamp of the operation

ValidationErrors

1

public List<string> ValidationErrors { get; set; }

Validation errors (for compatibility)

Methods

Success

1

public static ManipulationResult Success()

Creates a successful result

Successful

1

public static ManipulationResult Successful()

Creates a successful result

Successful

1

public static ManipulationResult Successful(string message)

Creates a successful result with message

Success

1

public static ManipulationResult Success(string message)

Creates a successful result with message (compatibility alias for Successful)

Success

1
2
3
4
5

public static ManipulationResult Success(
    ManipulationAction type,
    CoreVector2I originalPos,
    CoreVector2I newPos
)

Creates a successful result with position data

Failed

1

public static ManipulationResult Failed(string errorMessage)

Creates a failed result

Failure

1
2
3
4

public static ManipulationResult Failure(
    string errorMessage,
    ManipulationAction type = default
)

Creates a failed result (alias for Failed)

AddAffectedPosition

1

public void AddAffectedPosition(CoreVector2I position)

Adds an affected position

AddMetadata

1
2
3
4

public void AddMetadata(
    string key,
    object value
)

Adds metadata