Class ManipulationData

Namespace

GridPlacement.GDScript

Assembly

MoonBark.GridPlacement.GDScript.dll

class ManipulationData extends RefCounted

ManipulationData

Properties

manipulator

The character or object currently using the system to do manipulations

var manipulator: Node

source

The manipulatable node that was selected as the basis for this manipulation

var source: Manipulatable

target

The 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.

var target: Manipulatable

message

The general message sent as part of the manipulation data for whether the manipulation fails or succeeds

var message: String

results

The results of rule check validation on the manipulation.\n\nShould be provided for manipulations that had to evaluate rules and have generated results

var results: ValidationResults

action

The manipulation that is / was attempting to be done

var action: PlacementEnums.Action

status

Status of the action

var status = PlacementEnums.Status.CREATED:

root

var root = target.root

passing

var passing = true

Methods

cleanup_manipulation_objects

func cleanup_manipulation_objects() -> void:

Returns

is_valid

func is_valid() -> bool:

Returns

Events

status_changed

Holds the data for manipulating a Manipulatable object in the game scene Abstract class. Inherit to a [ActionName]Data script Emitted when the status of the action is set to a new value

signal status_changed(status: PlacementEnums.Status)