summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-12-16 08:26:43 +0100
committerGitHub <noreply@github.com>2019-12-16 08:26:43 +0100
commit6ec42b7507e0fb14e86068ba3809148b371c481f (patch)
tree0ea710799b2fcac11cfa6df1deb1a4b632aa6eca
parentb72e4079f343d440d6721f6bd4066f26a33a743a (diff)
parent078e9c04d2c0c03009ab67749742267717fcba2e (diff)
Merge pull request #34372 from KoBeWi/how_to_graphnode
Mention how to add slots to GraphNode
-rw-r--r--doc/classes/GraphNode.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml
index 8470a346ff..77b3eb1ca0 100644
--- a/doc/classes/GraphNode.xml
+++ b/doc/classes/GraphNode.xml
@@ -5,6 +5,7 @@
</brief_description>
<description>
A GraphNode is a container defined by a title. It can have one or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections.
+ To add a slot to GraphNode, add any [Control]-derived child node to it.
</description>
<tutorials>
</tutorials>
@@ -169,6 +170,12 @@
<argument index="8" name="custom_right" type="Texture" default="null">
</argument>
<description>
+ Sets properties of the slot with id [code]idx[/code].
+ If [code]enable_left[/code]/[code]right[/code], a port will appear and the slot will be able to be connected from this side.
+ [code]type_left[/code]/[code]right[/code] is an arbitrary type of the port. Only ports with the same type values can be connected.
+ [code]color_left[/code]/[code]right[/code] is the tint of the port's icon on this side.
+ [code]custom_left[/code]/[code]right[/code] is a custom texture for this side's port.
+ [b]Note:[/b] this method only sets properties of the slot. To create the slot, add a [Control]-derived child to the GraphNode.
</description>
</method>
</methods>