PlacementResult

Result of a building placement operation Contains success status, position, and any relevant metadata

Project: GridPlacement v6.0
Layer: Godot
Source: plugins/gameplay/GridPlacement/cs/Godot/Core/Systems/Placement/PlacementResult.cs
Namespace: GridPlacement.Core.Results
Kind: class

Parsing Method: AST-based (Roslyn) - NOT regex

⚠️ IMPORTANT: This documentation was generated using AST parsing, not regex.

Properties

Success

Whether the placement was successful

GridPosition

The grid position where placement was attempted

WorldPosition

World position of the placement

Messages

Any messages or errors related to the placement

Metadata

Additional metadata about the placement

Methods

Successful

Creates a successful placement result

Returns: PlacementResult

Parameters:

  • CoreVector2I gridPosition
  • CoreVector2 worldPosition

Failed

Creates a failed placement result with a message

Returns: PlacementResult

Parameters:

  • CoreVector2I gridPosition
  • CoreVector2 worldPosition
  • string message

Failed

Creates a failed placement result with multiple messages

Returns: PlacementResult

Parameters:

  • CoreVector2I gridPosition
  • CoreVector2 worldPosition
  • IEnumerable<string> messages