Class

PlacementContactRing3D

Generated GDScript class reference for GridPlacement.PlacementContactRing3D.

Status: Draft
Version: v6.0
Updated: Development docs generated from GDScript source

This is unreleased documentation in active development. APIs, class names, and behavior may change before the final release.

Ground contact ring for the 3D placement preview. Owns one pooled [MeshInstance3D] and one [ShaderMaterial] per profile, so cursor movement updates a shader uniform and a transform only — no per-frame material or mesh churn. Presentation only: it copies the authoritative ghost transform and validity, never computes them.

Source: addons/grid_placement/systems/building/3d/placement_contact_ring_3d.gd

Syntax

class PlacementContactRing3D extends RefCounted

Members

Name	Kind	Summary
`RING_SHADER`	Field
`SURFACE_LIFT`	Field	Small lift above the resolved support height to avoid z-fighting.
`update`	Method
`radius`	Property
`origin`	Property
`color`	Property
`hide`	Method
`dispose`	Method
`is_ring_visible`	Method
`get_ring`	Method
`get_material`	Method