Grid Placement

ManipulationData

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: systems/manipulation/manipulation_data.gd

Version: 5.1

class_name: ManipulationData extends: RefCounted

Summary

Data payload for an in-flight or completed manipulation operation.

This object is emitted through ManipulationService2D signals so systems (UI, audio, analytics) can react to started/failed/finished transitions.

This is treated as a base type: action-specific data can be modeled by extending this script.

Signals

  • status_changed

Exports

(none)

Methods

  • _init()
    • Create a new manipulation data payload.

[code]p_move_copy[/code] may be null for actions that do not create previews (e.g. DEMOLISH).

  • queue_free_manipulation_objects()
    • Queue-frees any temporary manipulation preview objects.

Intended to clean up [member move_copy] (and its optional [code]root[/code]) when a manipulation ends.

  • get_move_copy_root()
    • Returns the root node of the preview object, if available.

[return] The preview root Node, or null if no preview exists.

  • is_valid()
    • Checks whether the payload has the minimum required data.
  • get_issues()
  • _refresh_issues()
  • _to_string()
    • Debug string for logs.