Skip to content

Class

ManipulationData

Generated GDScript class reference for GridPlacement.ManipulationData.

Status
Current
Version
v6.1.0
Source updated
2026-09-24
Generated on
2026-09-23

Holds the data for manipulating a Manipulatable object in the game scene Abstract class. Inherit to a [ActionName]Data script

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

Syntax

class ManipulationData extends RefCounted

Members

NameKindSummary
status_changedSignalEmitted when the status of the action is set to a new value
manipulatorPropertyThe character or object currently using the system to do manipulations
sourcePropertyThe manipulatable node that was selected as the basis for this manipulation
targetPropertyThe manipulatable component of the object to be manipulated. In many cases this may be a copy of the object used to determine the final manipulation before applying it to the original.
messagePropertyThe general message sent as part of the manipulation data for whether the manipulation fails or succeeds
vetoedPropertyTrue after any listener calls [method veto] from a pre-commit signal — [signal ManipulationState.pre_move] or [signal ManipulationState.pre_demolish]. The owning service checks this flag after the signal fires and skips the world change when set. Game-owned authority uses this to reject a consequence without touching plugin session state.
correlation_contextPropertyOpaque consumer correlation (for example a game-owned entity id) carried verbatim onto the host dispatch's lifecycle result. Correlation is never used as plugin identity, and the plugin never interprets its contents.
resultsPropertyThe results of rule check validation on the manipulation. Should be provided for manipulations that had to evaluate rules and have generated results
actionPropertyThe manipulation that is / was attempting to be done
statusPropertyStatus of the action
vetoMethod
cleanup_manipulation_objectsMethod
is_validMethod