Draft — Unreleased:This page is in active development. APIs, class names, and behavior may change before the release is finalized. Use it as a preview of what's coming — not as a stable integration target.
Settings concerning moving objects within the game world
Source: addons/grid_placement/systems/manipulation/manipulation_settings.gd
Syntax
class ManipulationSettings extends PlacementResourceMembers
| Name | Kind | Summary |
|---|---|---|
rotate_increment_degrees | Property | Amount to rotate objects with every step of call to left or right rotation |
enable_demolish | Property | Allows objects which that have a Manipulatable component with demolish enabled to be removed by the demolish manipulation function |
demolish_while_moving | Property | Whether an object that is selected for moving can be demolished while is it being moved in move mode |
enable_rotate | Property | Allows the building system to rotate objects left and right during build mode |
enable_flip_horizontal | Property | Allows the building system to flip objects horizontally during build mode |
enable_flip_vertical | Property | Allows the building system to flip objects vertically during build mode |
reset_transform_on_manipulation | Property | Whether 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_manipulation | Property | Whether you want to disable a layer when a manipulation like a move starts until it is canceled or finished |
disabled_physics_layer | Property | Layer 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_suffix | Property | String to append to an object's move copy node name to differentiate it from the original source object |
demolish_success | Property | Message displayed when demolish succeeds |
failed_not_demolishable | Property | Message when target cannot be demolished |
demolish_already_deleted | Property | Message when demolish target was already deleted |
demolish_canceled | Property | Message when a [signal ManipulationState.pre_demolish] listener calls [code]data.veto()[/code] to cancel the demolish. Additive in 5.1.0-C. |
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 |
all_succeeded | Property | Message when all placement rules succeed |
failed_to_setup_rules | Property | Message when rule setup fails |
target_not_rotatable | Property | Message when target cannot be rotated |
target_not_flippable_horizontally | Property | Message when target cannot be flipped horizontally |
target_not_flippable_vertically | Property | Message when target cannot be flipped vertically |
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_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 | |
issues | Property | |
get_runtime_issues | Method | |
issues | Property |
Source
addons/grid_placement/systems/manipulation/manipulation_settings.gd
Plugin docs root:gdscript/plugins/grid_placement_dev/docs