Skip to content

Class

PlacementPresentationProfile3D

Generated GDScript class reference for GridPlacement.PlacementPresentationProfile3D.

Status
Current
Version
v6.3.0
Source updated
2026-10-29
Generated on
2026-10-29

6.3. These pages document the 6.3 release, where placeable is now entry (what changed) and PlacementOwner is deprecated (migration). Still on 6.2? Your version's guides ship inside the plugin itself, under addons/grid_placement/guides/; the 6.2 URLs on this site now redirect to this series.

Optional look for the 3D placement preview: how the ghost is shaded and a ring on the ground under it. Assign it in ObjectPlacementSettings3D.presentation_profile. It only changes how the preview looks, never where or whether an object can be placed. Without a profile the preview uses the plain valid/invalid tint.

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

Syntax

class PlacementPresentationProfile3D extends Resource

Members

NameKindSummary
ghost_alpha_scalePropertyMultiplies the opacity of the ghost's valid and invalid colors.
ghost_detail_tintPropertyHow strongly the ghost is tinted with the valid or invalid color. 1.0 is a flat tint; lower values show more of the object's own materials.
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_ringPropertyDraws a ring on the ground under grid placement previews. For smooth placement, use ObjectPlacementSettings3D.smooth_enable_contact_ring; it uses the ring colors and shape set here.
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.