Skip to content

Class

ManipulationSettings

Generated GDScript class reference for GridPlacement.ManipulationSettings.

Status
Current
Version
v6.0
Source updated
Active v6.0 guide line from Grid Placement repo
Generated on
2026-09-01

Settings concerning moving objects within the game world

Source: addons/grid_placement/systems/manipulation/manipulation_settings.gd

Syntax

class ManipulationSettings extends PlacementResource

Members

NameKindSummary
rotate_increment_degreesPropertyAmount to rotate objects with every step of call to left or right rotation
enable_demolishPropertyAllows objects which that have a Manipulatable component with demolish enabled to be removed by the demolish manipulation function
demolish_while_movingPropertyWhether an object that is selected for moving can be demolished while is it being moved in move mode
enable_rotatePropertyAllows the manipulation system to rotate objects left and right. Active in both MOVE mode (placed objects) and placement-preview (PLACE/BUILD mode) per https://github.com/ChrisTutorials/grid_placement_dev/issues/586. See guides/manipulation-system-vs-parent.md.
enable_flip_horizontalPropertyAllows the manipulation system to flip objects horizontally. Active in both MOVE mode and placement-preview. See enable_rotate.
enable_flip_verticalPropertyAllows the manipulation system to flip objects vertically. Active in both MOVE mode and placement-preview. See enable_rotate.
reset_transform_on_manipulationPropertyWhether the transform of the manipulation target object should be reset to Transform2D.IDENTITY when starting a manipulation [br][br] This may be most useful when moving RigidBody2Ds or other objects that rotate during gameplay to make placing to a new location clean as the original scene designates.
disable_layer_in_manipulationPropertyWhether you want to disable a layer when a manipulation like a move starts until it is canceled or finished
disabled_physics_layerPropertyLayer that you want disabled in source object during manipulation until the manipulation is finished or canceled. [br][br] Recommended to use a placement only layer and not to disable the layer that effects physics of objects currently moving around in the scene [br][br] Alternatively, you could put game into a pause state on started signal from ManipulationState
move_suffixPropertyString to append to an object's move copy node name to differentiate it from the original source object
demolish_successPropertyMessage displayed when demolish succeeds
failed_not_demolishablePropertyMessage when target cannot be demolished
demolish_already_deletedPropertyMessage when demolish target was already deleted
demolish_canceledPropertyMessage when a [signal ManipulationState.pre_demolish] listener calls [code]data.veto()[/code] to cancel the demolish. Additive in 5.1.0-C.
move_startedPropertyMessage when move action starts
move_successPropertyMessage displayed when move succeeds
failed_to_start_movePropertyMessage when move fails to start
no_move_targetPropertyMessage when there is no move target
failed_placement_invalidPropertyMessage when placement at target location is invalid
all_succeededPropertyMessage when all placement rules succeed
failed_to_setup_rulesPropertyMessage when rule setup fails
target_not_rotatablePropertyMessage when target cannot be rotated
target_not_flippable_horizontallyPropertyMessage when target cannot be flipped horizontally
target_not_flippable_verticallyPropertyMessage when target cannot be flipped vertically
invalid_dataPropertyMessage when manipulation data is invalid
failed_manipulation_state_invalidPropertyMessage when manipulation state validation fails
failed_object_not_manipulatablePropertyMessage when object is not manipulatable
failed_object_not_movablePropertyMessage when object is not movable
failed_root_not_assignedPropertyMessage when root node is not assigned
failed_root_not_node2DPropertyMessage when root is not a Node2D
failed_no_target_objectPropertyMessage when there is no target object
target_not_manipulatablePropertyMessage when target is not manipulatable
unsupported_node_typePropertyMessage for unsupported node types
get_editor_issuesMethod
get_runtime_issuesMethod