TargetHighlight3D

Tints the placed 3D object under the cursor, with a color for each mode (info, build, move, demolish). While an object is being moved, the tint shows whether it can be dropped where it is. The object's own materials are not changed. Hidden when nothing is hovered or placement is off.

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

Syntax

class TargetHighlight3D extends PlacementNode3D

Members

Name	Kind	Summary
HIGHLIGHT_GROUP	Field	Scene-tree group the highlight adds itself to.
COLOR_INFO	Field	How the hovered object is shown. MESH tints the object itself. BOX draws a wireframe box around it.
COLOR_BUILD	Field
COLOR_MOVE	Field
COLOR_DEMOLISH_VALID	Field	Fallback demolish colors when no HighlightSettings are configured; they mirror the demolish_valid_color/demolish_invalid_color defaults. Configured values win, so 3D and 2D answer with the same two colors.
COLOR_DEMOLISH_INVALID	Field
COLOR_MOVE_VALID	Field	Fallback carry colors when no HighlightSettings are configured; mirror the move_valid_color/move_invalid_color defaults.
COLOR_MOVE_INVALID	Field
OVERLAY_ALPHA	Field	Overlay tint strength in MESH mode when the session configures no HighlightSettings; mirrors HighlightSettings.overlay_alpha. Light enough that a box tinting a whole row of buildings reads as feedback rather than as an error state.
EMISSION_ENERGY	Field	Emission strength of cutout surface tints. The clone keeps the authored albedo, so the mode color reads as a glow over the intact texture.
display_mode	Property	How the hovered object is shown. MESH (default) tints the object itself. BOX draws a wireframe box around it.
highlight_settings	Property	Configured carry colors (same resource the 2D highlighter uses); falls back to COLOR_MOVE_VALID/COLOR_MOVE_INVALID when unconfigured.
resolve_placement_dependencies	Method
current_box	Method
get_highlight_subject	Method
set_box_roots	Method
get_box_roots	Method
set_refused_box_roots	Method
get_refused_box_roots	Method
get_highlighted_root	Method