diff options
| author | Johannes Witt <johawitt@outlook.de> | 2021-07-26 16:31:31 +0200 |
|---|---|---|
| committer | Johannes Witt <johawitt@outlook.de> | 2022-01-06 17:51:40 +0100 |
| commit | 0505b08a5607d2f488ec69cf2bd4e8b83bd97ede (patch) | |
| tree | d189542b2bdba84228bab2a6872e9c31bf72d45e /doc/classes | |
| parent | 4ea309b405f09fb9c1425c688ea3eaeb24cce477 (diff) | |
Add `GraphEdit` drag notifications
This commit adds two signals:
* connection_drag_begun, which is emitted when a connection is started
to be created by the user and
* `connection_drag_ended`, which is emitted when no longer a connection
is created.
Additionally `force_connection_drag_end()` adds the possibility to end
the connection dragging. If called from user code, no other connection
request signals are invoked. This is useful to add `GraphNode`s via
shortcuts while the user is dragging a connection to directly connect
the newly added node.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/GraphEdit.xml | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index c432410d3b..be6d9e07c3 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -109,6 +109,14 @@ Removes the connection between the [code]from_port[/code] slot of the [code]from[/code] GraphNode and the [code]to_port[/code] slot of the [code]to[/code] GraphNode. If the connection does not exist, no connection is removed. </description> </method> + <method name="force_connection_drag_end"> + <return type="void" /> + <description> + Ends the creation of the current connection. In other words, if you are dragging a connection you can use this method to abort the process and remove the line that followed your cursor. + This is best used together with [signal connection_drag_begun] and [signal connection_drag_ended] to add custom behavior like node addition through shortcuts. + [b]Note:[/b] This method suppresses any other connection request signals apart from [signal connection_drag_ended]. + </description> + </method> <method name="get_connection_line"> <return type="PackedVector2Array" /> <argument index="0" name="from" type="Vector2" /> @@ -241,6 +249,19 @@ Emitted at the beginning of a GraphNode movement. </description> </signal> + <signal name="connection_drag_begun"> + <argument index="0" name="from" type="String" /> + <argument index="1" name="slot" type="String" /> + <argument index="2" name="is_output" type="bool" /> + <description> + Emitted at the beginning of a connection drag. + </description> + </signal> + <signal name="connection_drag_ended"> + <description> + Emitted at the end of a connection drag. + </description> + </signal> <signal name="connection_from_empty"> <argument index="0" name="to" type="StringName" /> <argument index="1" name="to_slot" type="int" /> |