Skip to content
Grid Building Docs

TargetHighlighter

Summary

Section titled “Summary”

When a target node is set on the build state, marks it by colors based on the settings of its Manipulatable node (or lack thereof)

Properties

Section titled “Properties”
mode_state: ModeState
targeting_state: GridTargetingState :
manipulation_state: ManipulationState :
highlight_settings: HighlightSettings

Holds color settings for how a highlighted target should be displayed in the game world

current_target: CanvasItem :

The currently highlighter target. When set to a new value, the old one’s modulate clears automatically

Methods

Section titled “Methods”
resolve_gb_dependencies( p_container: GBCompositionContainer ) -> void

Resolves dependencies from the composition container. Sets up mode state, targeting state, manipulation state, and highlight settings.

p_container: GBCompositionContainer - Container with system dependencies and settings

set_movable_display( p_target: CanvasItem, p_movable: bool ) -> Color

Sets a canvas item modulate to either the valid or invalid move color. Returns the new modulate color.

p_target: CanvasItem - Target canvas item to set modulate color on

p_movable: bool - Whether the target is movable (valid) or not (invalid)

set_demolish_display( p_target: CanvasItem, p_demolishable: bool ) -> Color

Sets a canvas item modulate to either the valid or invalid demolish color. Returns the new modulate color.

p_target: CanvasItem - Target canvas item to set modulate color on

p_demolishable: bool - Whether the target is demolishable (valid) or not (invalid)

set_build_preview_display( p_target: CanvasItem )

Setsthe color of a build preview to the preview color

set_info_display( p_target: CanvasItem )
set_actionable_colors( p_target: CanvasItem ) -> Color

Sets the target modulate to colors based on current mode actionability. Changes color based on whether the target can be affected by the current mode’s action.

p_target: CanvasItem - Target canvas item to set actionable colors on

should_highlight( p_data: ManipulationData, p_target: CanvasItem ) -> bool

Checks if the highlighter should highlight the target based on manipulation data. Returns true if the target matches the manipulation data target.

p_data: ManipulationData - Current manipulation data to compare against

p_target: CanvasItem - Target canvas item to check for highlighting

is_locked( ) -> bool

Returns true if the highlighter is locked by active manipulation state. A locked highlighter won’t respond to target changes until manipulation finishes.

get_runtime_issues( ) -> Array[String]

Validates that all required dependencies are properly set. Returns true if all dependencies are valid, false otherwise.

Source

Section titled “Source”

addons/grid_building/components/target_highlighter.gd

This page was auto-generated from GDScript source. Edit the source file to improve documentation.

Generated on 2025-09-07