asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/GraphNode.xml

283 lines
13 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<class name="GraphNode" inherits="GraphElement" is_experimental="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 16:26:09 +02:00
A container with connection ports, representing a node in a [GraphEdit].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 16:26:09 +02:00
[GraphNode] allows to create nodes for a [GraphEdit] graph with customizable content based on its child controls. [GraphNode] is derived from [Container] and it is responsible for placing its children on screen. This works similar to [VBoxContainer]. Children, in turn, provide [GraphNode] with so-called slots, each of which can have a connection port on either side.
Each [GraphNode] slot is defined by its index and can provide the node with up to two ports: one on the left, and one on the right. By convention the left port is also referred to as the [b]input port[/b] and the right port is referred to as the [b]output port[/b]. Each port can be enabled and configured individually, using different type and color. The type is an arbitrary value that you can define using your own considerations. The parent [GraphEdit] will receive this information on each connect and disconnect request.
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
Slots can be configured in the Inspector dock once you add at least one child [Control]. The properties are grouped by each slot's index in the "Slot" section.
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
[b]Note:[/b] While GraphNode is set up using slots and slot indices, connections are made between the ports which are enabled. Because of that [GraphEdit] uses the port's index and not the slot's index. You can use [method get_input_port_slot] and [method get_output_port_slot] to get the slot index from the port index.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="_draw_port" qualifiers="virtual">
<return type="void" />
<param index="0" name="slot_index" type="int" />
<param index="1" name="position" type="Vector2i" />
<param index="2" name="left" type="bool" />
<param index="3" name="color" type="Color" />
<description>
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="clear_all_slots">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Disables all slots of the GraphNode. This will remove all input/output ports from the GraphNode.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="clear_slot">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Disables the slot with the given [param slot_index]. This will remove the corresponding input and output port from the GraphNode.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_input_port_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Color" />
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="port_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the [Color] of the input port with the given [param port_idx].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_input_port_count">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the number of slots with an enabled input port.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_input_port_position">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="port_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the position of the input port with the given [param port_idx].
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_input_port_slot">
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<return type="int" />
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="port_idx" type="int" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the corresponding slot index of the input port with the given [param port_idx].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_input_port_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="port_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the type of the input port with the given [param port_idx].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_output_port_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Color" />
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="port_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the [Color] of the output port with the given [param port_idx].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_output_port_count">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the number of slots with an enabled output port.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_output_port_position">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="port_idx" type="int" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the position of the output port with the given [param port_idx].
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_output_port_slot">
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<return type="int" />
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="port_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the corresponding slot index of the output port with the given [param port_idx].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<method name="get_output_port_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="port_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the type of the output port with the given [param port_idx].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="get_slot_color_left" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Color" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the left (input) [Color] of the slot with the given [param slot_index].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="get_slot_color_right" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="Color" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the right (output) [Color] of the slot with the given [param slot_index].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="get_slot_type_left" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the left (input) type of the slot with the given [param slot_index].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="get_slot_type_right" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="int" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns the right (output) type of the slot with the given [param slot_index].
</description>
</method>
<method name="get_titlebar_hbox">
<return type="HBoxContainer" />
<description>
Returns the [HBoxContainer] used for the title bar, only containing a [Label] for displaying the title by default. This can be used to add custom controls to the title bar such as option or close buttons.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
Improve the VisualShader/VisualScript editor UI
2022-04-30 03:56:57 +02:00
<method name="is_slot_draw_stylebox" qualifiers="const">
<return type="bool" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
Improve the VisualShader/VisualScript editor UI
2022-04-30 03:56:57 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns true if the background [StyleBox] of the slot with the given [param slot_index] is drawn.
Improve the VisualShader/VisualScript editor UI
2022-04-30 03:56:57 +02:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<method name="is_slot_enabled_left" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns [code]true[/code] if left (input) side of the slot with the given [param slot_index] is enabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="is_slot_enabled_right" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Returns [code]true[/code] if right (output) side of the slot with the given [param slot_index] is enabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name="set_slot">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
<param index="1" name="enable_left_port" type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="2" name="type_left" type="int" />
<param index="3" name="color_left" type="Color" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="4" name="enable_right_port" type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="5" name="type_right" type="int" />
<param index="6" name="color_right" type="Color" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="7" name="custom_icon_left" type="Texture2D" default="null" />
<param index="8" name="custom_icon_right" type="Texture2D" default="null" />
<param index="9" name="draw_stylebox" type="bool" default="true" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Sets properties of the slot with the given [param slot_index].
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
If [param enable_left_port]/[param enable_right_port] is [code]true[/code], a port will appear and the slot will be able to be connected from this side.
With [param type_left]/[param type_right] an arbitrary type can be assigned to each port. Two ports can be connected if they share the same type, or if the connection between their types is allowed in the parent [GraphEdit] (see [method GraphEdit.add_valid_connection_type]). Keep in mind that the [GraphEdit] has the final say in accepting the connection. Type compatibility simply allows the [signal GraphEdit.connection_request] signal to be emitted.
Ports can be further customized using [param color_left]/[param color_right] and [param custom_icon_left]/[param custom_icon_right]. The color parameter adds a tint to the icon. The custom icon can be used to override the default port dot.
Additionally, [param draw_stylebox] can be used to enable or disable drawing of the background stylebox for each slot. See [theme_item slot].
Individual properties can also be set using one of the [code]set_slot_*[/code] methods.
[b]Note:[/b] This method only sets properties of the slot. To create the slot itself, add a [Control]-derived child to the GraphNode.
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
</description>
</method>
<method name="set_slot_color_left">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
<param index="1" name="color" type="Color" />
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Sets the [Color] of the left (input) side of the slot with the given [param slot_index] to [param color].
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
</description>
</method>
<method name="set_slot_color_right">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
<param index="1" name="color" type="Color" />
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Sets the [Color] of the right (output) side of the slot with the given [param slot_index] to [param color].
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
</description>
</method>
Improve the VisualShader/VisualScript editor UI
2022-04-30 03:56:57 +02:00
<method name="set_slot_draw_stylebox">
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
<param index="1" name="enable" type="bool" />
Improve the VisualShader/VisualScript editor UI
2022-04-30 03:56:57 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Toggles the background [StyleBox] of the slot with the given [param slot_index].
Improve the VisualShader/VisualScript editor UI
2022-04-30 03:56:57 +02:00
</description>
</method>
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
<method name="set_slot_enabled_left">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
<param index="1" name="enable" type="bool" />
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Toggles the left (input) side of the slot with the given [param slot_index]. If [param enable] is [code]true[/code], a port will appear on the left side and the slot will be able to be connected from this side.
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
</description>
</method>
<method name="set_slot_enabled_right">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
<param index="1" name="enable" type="bool" />
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Toggles the right (output) side of the slot with the given [param slot_index]. If [param enable] is [code]true[/code], a port will appear on the right side and the slot will be able to be connected from this side.
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
</description>
</method>
<method name="set_slot_type_left">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
<param index="1" name="type" type="int" />
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Sets the left (input) type of the slot with the given [param slot_index] to [param type]. If the value is negative, all connections will be disallowed to be created via user inputs.
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
</description>
</method>
<method name="set_slot_type_right">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Improve parameter naming and documentation in GraphEdit and GraphNode Co-authored-by: Maganty Rushyendra <mrushyendra@yahoo.com.sg>
2022-09-09 15:29:51 +02:00
<param index="0" name="slot_index" type="int" />
<param index="1" name="type" type="int" />
-Added missing setters to GraphNode. -Improved various GraphNode documentation.
2021-05-11 09:17:47 +02:00
<description>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
Sets the right (output) type of the slot with the given [param slot_index] to [param type]. If the value is negative, all connections will be disallowed to be created via user inputs.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</description>
</method>
</methods>
<members>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 20:38:49 +01:00
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="0" />
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="title" type="String" setter="set_title" getter="get_title" default="&quot;&quot;">
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
The text displayed in the GraphNode's title bar.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</member>
</members>
<signals>
doc: Sync classref with current source And fix various bogus bindings following previous PRs.
2021-02-19 13:35:31 +01:00
<signal name="slot_updated">
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<param index="0" name="slot_index" type="int" />
doc: Sync classref with current source And fix various bogus bindings following previous PRs.
2021-02-19 13:35:31 +01:00
<description>
Emitted when any GraphNode's slot is updated.
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</signals>
<theme_items>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 17:22:06 +01:00
<theme_item name="resizer_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
The color modulation applied to the resizer icon.
</theme_item>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<theme_item name="port_h_offset" data_type="constant" type="int" default="0">
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
Horizontal offset for the ports.
</theme_item>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 17:22:06 +01:00
<theme_item name="separation" data_type="constant" type="int" default="2">
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
The vertical distance between ports.
</theme_item>
<theme_item name="port" data_type="icon" type="Texture2D">
The icon used for representing ports.
</theme_item>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<theme_item name="panel" data_type="style" type="StyleBox">
The default background for the slot area of the [GraphNode].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<theme_item name="panel_selected" data_type="style" type="StyleBox">
The [StyleBox] used for the slot area when selected.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_item>
Improve the VisualShader/VisualScript editor UI
2022-04-30 03:56:57 +02:00
<theme_item name="slot" data_type="style" type="StyleBox">
The [StyleBox] used for each slot of the [GraphNode].
</theme_item>
Clean up/refactor GraphNode and make it more flexible Split GraphNode into GraphElement and GraphNode, add custom titlebar, and adjust theming.
2023-08-09 18:31:15 +02:00
<theme_item name="titlebar" data_type="style" type="StyleBox">
The [StyleBox] used for the title bar of the [GraphNode].
</theme_item>
<theme_item name="titlebar_selected" data_type="style" type="StyleBox">
The [StyleBox] used for the title bar of the [GraphNode] when it is selected.
</theme_item>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 22:42:36 +02:00
</theme_items>
</class>
Reference in a new issue Copy permalink