Skip to content

Class

HighlightSettings

Generated GDScript class reference for GridPlacement.HighlightSettings.

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.

Colors used to tint objects in each mode, such as the build preview and valid or invalid move and demolish targets.

Source: addons/grid_placement/systems/grid_targeting/highlight_settings.gd

Syntax

class HighlightSettings extends PlacementResource

Members

NameKindSummary
build_preview_colorPropertyTint of the build preview, so it reads as a preview rather than a real object.
info_hover_colorPropertyTint of the hovered object in info mode.
move_valid_colorPropertyTint of a hovered object that can be moved.
move_invalid_colorPropertyTint of a hovered object that cannot be moved.
active_manipulation_colorPropertyTint of the object while it is being moved.
demolish_valid_colorPropertyTint of an object that can be demolished (hover target, box victim). One pair, read by both dimensions: 2D modulates the sprite with it, 3D overlays it at a fixed alpha. Softer than the move pair on purpose — a box can tint a dozen objects at once, and a fully saturated green or red over a whole building reads as an error state rather than as feedback.
demolish_invalid_colorPropertyTint of an object that cannot be demolished, and of a box victim the release would refuse.
reset_colorPropertyColor objects go back to when they are no longer highlighted.
overlay_alphaPropertyHow strongly a mode color is laid over a 3D mesh, as the overlay's alpha. The overlay is the only 3D tint mechanism, so this is its strength knob; 2D modulates the sprite with the color instead and ignores it. A color's own alpha multiplies into it, so a project can fade one mode on its own.