Settings for moving, rotating, flipping, and demolishing placed objects, and the messages shown for each action.
Source: addons/grid_placement/systems/manipulation/manipulation_settings.gd
Syntax
class ManipulationSettings extends PlacementResourceMembers
| Name | Kind | Summary |
|---|---|---|
rotate_increment_degrees | Property | Degrees an object turns with each rotate left or right. |
enable_demolish | Property | Whether demolish mode can remove objects. Each object also needs a Manipulatable that allows demolishing. |
demolish_drag_box_enabled | Property | When on, players can drag a box in demolish mode to remove every object inside it on release. A click without dragging removes one object, and the PlacementActions.off_mode action cancels the box. When off, objects are removed as soon as they are clicked. |
enable_rotate | Property | Whether objects can be rotated, both while moving and while previewing a build. Each object also needs ManipulatableSettings.rotatable. |
enable_flip_horizontal | Property | Whether objects can be flipped horizontally, both while moving and while previewing a build. |
enable_flip_vertical | Property | Whether objects can be flipped vertically, both while moving and while previewing a build. |
reset_transform_on_manipulation | Property | When on, an object's rotation, flip, and scale are reset when a move starts. Useful for objects that turn during play, such as RigidBody2Ds, so they are placed the way the scene was built. |
disable_layer_in_manipulation | Property | When on, disabled_physics_layer is turned off on the object while it is being moved. |
disabled_physics_layer | Property | Physics layer turned off on the object while it is moved. Use a layer that only placement checks use, not one that affects gameplay physics. Alternatively, pause the game when a move starts. |
move_suffix | Property | Text added to the name of the copy shown while an object is moved. |
demolish_success | Property | Shown when an object is demolished. In these messages, %s is replaced with the object's name. |
failed_not_demolishable | Property | Message when target cannot be demolished |
demolish_already_deleted | Property | Message when demolish target was already deleted |
demolish_canceled | Property | Shown when your game cancels a demolish by calling data.veto() from ManipulationState.pre_demolish. |
move_started | Property | Message when move action starts |
move_success | Property | Message displayed when move succeeds |
failed_to_start_move | Property | Message when move fails to start |
no_move_target | Property | Message when there is no move target |
failed_placement_invalid | Property | Message when placement at target location is invalid |
target_not_rotatable | Property | Message when target cannot be rotated |
rotate_success | Property | Message when a rotate succeeds |
target_not_flippable_horizontally | Property | Message when target cannot be flipped horizontally |
target_not_flippable_vertically | Property | Message when target cannot be flipped vertically |
flip_horizontal_success | Property | Message when a horizontal flip succeeds |
flip_vertical_success | Property | Message when a vertical flip succeeds |
invalid_data | Property | Message when manipulation data is invalid |
failed_manipulation_state_invalid | Property | Message when manipulation state validation fails |
failed_object_not_manipulatable | Property | Message when object is not manipulatable |
failed_object_not_movable | Property | Message when object is not movable |
failed_object_has_dependents | Property | Message when an object cannot be moved or rotated because other pieces are attached to it, such as paintings or roof pieces. |
failed_root_not_assigned | Property | Message when root node is not assigned |
failed_root_not_node2D | Property | Message when root is not a Node2D |
failed_no_target_object | Property | Message when there is no target object |
target_not_manipulatable | Property | Message when target is not manipulatable |
unsupported_node_type | Property | Message for unsupported node types |
get_editor_issues | Method |