Skip to content
ct

Class

Manipulatable

Generated GDScript class reference for GridPlacement.Manipulatable.

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.

Component node that makes a object movable, demolishable, or other system actions to be performed on the object

Source: addons/grid_placement/components/manipulatable.gd

Syntax

class Manipulatable extends PlacementGameNode

Members

NameKindSummary
keep_during_previewFieldSpecial marker that tells building system to keep this script during preview
manipulation_finishedSignalEmitted when this object's manipulation is finished (placed/moved) This allows the root object to respond to being manipulated Parameters: - old_transform: Transform2D - The transform before manipulation - new_transform: Transform2D - The transform after manipulation
manipulation_finished_3dSignal
settingsPropertyRule settings for replacing this object in move mode, etc
build_cost_rulePropertyOptional build-cost label for refund-on-demolish: points at the same saved [SpendMaterialsRuleById] resource the placement pipeline spends from, so cost has one source of truth. Lives here (per-object node, not the shared [ManipulatableSettings] resource) because demolishability and refund value are the same concern — an object without a Manipulatable cannot be demolished at all. ScenePlacementEntry-backed scenes can leave this empty: [PlaceableInstance] already resolves their costs. See [method BuildCost.resolve_for] for the precedence order.
rootPropertyThe root of the object that should be manipulated by any actions. This manipulatable component is usually a child of the root.
resolve_placement_dependenciesMethod
is_root_hierarchy_validMethod
create_copyMethod
get_move_rulesMethod
is_demolishableMethod
is_movableMethod
validate_setupMethod
get_issuesMethod
complete_manipulationMethod
new_transformProperty
complete_manipulation_3dMethod
root_3dProperty