FootprintData

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 FootprintData

Summary

Core footprint data without Godot dependencies. Describes the space occupied by a building or object.

Metadata

Namespace: GridPlacement.Core.Data.Placement

Source File: cs/Core/Data/Placement/FootprintData.cs

Assembly: GridPlacement.Core

Type: class

Properties

Id

1

public string Id { get; set; }

Unique identifier for the footprint.

ShapeType

1

public FootprintShapeType ShapeType { get; set; }

Type of footprint shape.

Size

1

public CoreVector2I Size { get; set; }

Size of the footprint in grid units.

Offset

1

public CoreVector2I Offset { get; set; }

Offset from the origin position.

PolygonPoints

1

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

Custom polygon points for complex shapes. Used when ShapeType is Custom.

Radius

1

public int Radius { get; set; }

Radius for circular shapes. Used when ShapeType is Circle.

CanRotate

1

public bool CanRotate { get; set; }

Whether the footprint can be rotated.

CanFlip

1

public bool CanFlip { get; set; }

Whether the footprint can be flipped.

Methods

GetOccupiedPositions

1
2
3
4
5
6

public List<CoreVector2I> GetOccupiedPositions(
    CoreVector2I gridPosition,
    int rotation = 0,
    bool flipHorizontal = false,
    bool flipVertical = false
)

Gets the footprint positions at a given grid position.

Parameters

Returns

List of occupied grid positions