TargetingSnapshot2D

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 TargetingSnapshot2D

Summary

Represents a snapshot of targeting information for placement operations.

This class contains all the data needed to determine where a placeable object should be positioned and how it should be oriented.

Metadata

Namespace: GridPlacement.Core.Types

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

Assembly: GridPlacement.Core

Type: class

Constructors

TargetingSnapshot2D

1
public TargetingSnapshot2D()

Creates a new targeting snapshot with default values.


TargetingSnapshot2D

1
public TargetingSnapshot2D(CoreVector2I gridPosition)

Creates a new targeting snapshot with the specified grid position.

Parameters

NameDescription
gridPositionThe grid position.

Properties

GridPosition

1
public CoreVector2I GridPosition { get; set; }

Gets or sets the grid position where the targeting cursor is located.


CellCenter

1
public CoreVector2 CellCenter { get; set; }

Gets or sets the world position (center of the grid cell).


WorldPosition

1
public CoreVector2 WorldPosition { get; set; }

Gets or sets the world position of the targeting cursor.


Normal

1
public CoreVector2 Normal { get; set; }

Gets or sets the normal vector at the targeting position.


Mode

1
public TargetingMode Mode { get; set; }

Gets or sets the targeting mode being used.


Data

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

Gets or sets additional targeting data.


IsValid

1
public bool IsValid { get; set; }

Gets or sets whether the targeting position is valid.


Methods

Clone

1
public TargetingSnapshot2D Clone()

Creates a copy of this targeting snapshot.

Returns

A new TargetingSnapshot2D with the same values.