Skip to content

Class

PlacementPresentationProfile3D

Generated GDScript class reference for GridPlacement.PlacementPresentationProfile3D.

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.

Opt-in 3D placement presentation: preview-ghost material response and a ground contact ring. Presentation only. A profile never changes validation, the resolved mount or transform, commit behavior, or save/restore semantics; it only changes how the existing authoritative preview is drawn. A null profile keeps the built-in validity tint and adds no extra visuals, so existing projects and the lightweight path are unchanged.

Source: addons/grid_placement/resources/presentation/placement_presentation_profile_3d.gd

Syntax

class PlacementPresentationProfile3D extends Resource

Members

NameKindSummary
ghost_alpha_scalePropertyMultiplies the settings valid/invalid color alpha for the preview ghost.
ghost_detail_tintPropertyBlend of each ghost surface toward the validity color. 1.0 is a flat silhouette tint; lower values keep more of the authored material detail.
ghost_valid_emissionPropertyEmission added to valid previews (alpha is the energy multiplier; 0 disables). Keeps the ghost readable over dark, textured surfaces.
ghost_blocked_emissionPropertyEmission added to blocked previews (alpha is the energy multiplier).
ghost_rim_strengthPropertyRim light strength (0 disables). A rim reads the piece silhouette against busy backgrounds without obscuring its surface.
ghost_rim_tintPropertyHow much the rim is tinted by the surface albedo (0 is white, 1 is albedo).
enable_contact_ringPropertyDraw a ring on the ground under the footprint. Presentation only; it sits at the authoritative support height and never implies a different surface. Governs GRID previews; SMOOTH previews use the settings-level smooth_enable_contact_ring flag and share these colors and shape.
ring_valid_colorPropertyRing color while the pending placement is valid.
ring_blocked_colorPropertyRing color while the pending placement is blocked.
ring_innerPropertyInner radius fraction of the ring (0.78 leaves a 22% band at the edge).
ring_softnessPropertyRing edge softness in UV units.
ring_padPropertyExtra radius beyond the preview's horizontal extent, in meters.
ring_pulse_speedPropertyPulse speed in radians per second; 0 disables the pulse.
ring_pulse_amountPropertyPulse depth as a fraction of ring alpha.
ring_shaderPropertyOptional custom ring shader. It must expose the `ring_color`, `ring_inner`, `ring_softness`, `pulse_speed`, and `pulse_amount` uniforms.