Table of Contents

Class PlacementMetadata

Namespace
MoonBark.GridPlacement.Core.Types
Assembly
MoonBark.GridPlacement.Core.dll

Strongly-typed metadata for placement operations.

public record PlacementMetadata : IEquatable<PlacementMetadata>
Inheritance
PlacementMetadata
Implements
Inherited Members

Fields

Empty

Creates an empty PlacementMetadata.

public static readonly PlacementMetadata Empty

Field Value

PlacementMetadata

Properties

EntityId

Entity ID of the placed object (if applicable).

public long? EntityId { get; init; }

Property Value

long?

IsPreview

Whether the placement was a preview or actual placement.

public bool IsPreview { get; init; }

Property Value

bool

OriginalPosition

Original position before placement (for move operations).

public CoreVector2I? OriginalPosition { get; init; }

Property Value

CoreVector2I?

PlacementDuration

Duration of the placement operation.

public TimeSpan? PlacementDuration { get; init; }

Property Value

TimeSpan?

PlacementSource

Source of the placement operation (e.g., "ui", "script", "network").

public string? PlacementSource { get; init; }

Property Value

string

Rotation

Rotation applied to the placed object.

public int? Rotation { get; init; }

Property Value

int?

Methods

WithSource(string)

Creates a PlacementMetadata with the specified source.

public static PlacementMetadata WithSource(string source)

Parameters

source string

Returns

PlacementMetadata