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

397 lines
18 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" ?>
Bump version to 4.1-dev Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
<class name="GraphNode" inherits="Container" is_experimental="true" version="4.1" 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>
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
GraphNode is a [Container] control that represents a single data unit in a [GraphEdit] graph. You can customize the number, type, and color of left- and right-side connection ports.
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>
Update GraphEdit configuration warning, mark GraphNode/GraphEdit as experimental
2023-02-09 02:39:55 +01:00
[b]Note:[/b] Please be aware that this node will undergo extensive refactoring in a future 4.x version involving compatibility-breaking API changes.
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
GraphNode allows to create nodes for a [GraphEdit] graph with customizable content based on its child [Control]s. GraphNode is a [Container] and 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. This is similar to how [TabContainer] uses children to create the tabs.
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 input port and the right port is referred to as the output port. 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.
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.
[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 port's index and not slot's index. You can use [method get_connection_input_slot] and [method get_connection_output_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>
<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>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Disables all input and output slots 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
</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>
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
Disables input and output slot whose index is [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_connection_input_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" />
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="port" 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>
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
Returns the [Color] of the input connection [param 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>
<method name="get_connection_input_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>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 04:15:43 +02:00
Returns the number of enabled input slots (connections) to 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>
Improve and fix the GraphNode port hotzones Co-authored-by: Ansraer <jacky2611@gmail.com>
2022-05-30 15:48:58 +02:00
<method name="get_connection_input_height">
<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="port" type="int" />
Improve and fix the GraphNode port hotzones Co-authored-by: Ansraer <jacky2611@gmail.com>
2022-05-30 15:48:58 +02:00
<description>
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
Returns the height of the input connection [param port].
Improve and fix the GraphNode port hotzones Co-authored-by: Ansraer <jacky2611@gmail.com>
2022-05-30 15:48:58 +02:00
</description>
</method>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 15:37:49 +02:00
<method name="get_connection_input_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" />
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="port" 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>
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
Returns the position of the input connection [param port].
</description>
</method>
<method name="get_connection_input_slot">
<return type="int" />
<param index="0" name="port" type="int" />
<description>
Returns the corresponding slot index of the input connection [param 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>
<method name="get_connection_input_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" />
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="port" 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>
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
Returns the type of the input connection [param 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>
<method name="get_connection_output_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" />
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="port" 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>
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
Returns the [Color] of the output connection [param 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>
<method name="get_connection_output_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>
Change "Return" to "Returns" where necessary in XML documentation In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-05-24 04:15:43 +02:00
Returns the number of enabled output slots (connections) 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
</description>
</method>
Improve and fix the GraphNode port hotzones Co-authored-by: Ansraer <jacky2611@gmail.com>
2022-05-30 15:48:58 +02:00
<method name="get_connection_output_height">
<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="port" type="int" />
Improve and fix the GraphNode port hotzones Co-authored-by: Ansraer <jacky2611@gmail.com>
2022-05-30 15:48:58 +02:00
<description>
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
Returns the height of the output connection [param port].
Improve and fix the GraphNode port hotzones Co-authored-by: Ansraer <jacky2611@gmail.com>
2022-05-30 15:48:58 +02:00
</description>
</method>
Rename pos to position in user facing methods and variables Rename user facing methods and variables as well as the corresponding C++ methods according to the folloming changes: * pos -> position * rot -> rotation * loc -> location C++ variables are left as is.
2017-09-10 15:37:49 +02:00
<method name="get_connection_output_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" />
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="port" type="int" />
<description>
Returns the position of the output connection [param port].
</description>
</method>
<method name="get_connection_output_slot">
<return type="int" />
<param index="0" name="port" 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>
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
Returns the corresponding slot index of the output connection [param 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>
<method name="get_connection_output_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" />
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="port" 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>
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
Returns the type of the output connection [param 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>
<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>
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
Returns the left (input) [Color] of the slot [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>
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
Returns the right (output) [Color] of the slot [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>
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
Returns the left (input) type of the slot [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>
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
Returns the right (output) type of the slot [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>
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>
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
Returns true if the background [StyleBox] of the slot [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>
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
Returns [code]true[/code] if left (input) side of the slot [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>
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
Returns [code]true[/code] if right (output) side of the slot [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>
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
Sets properties of the slot with the [param slot_index] index.
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>
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
Sets the [Color] of the left (input) side of the slot [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>
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
Sets the [Color] of the right (output) side of the slot [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>
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
Toggles the background [StyleBox] of the slot [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>
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
Toggles the left (input) side of the slot [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>
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
Toggles the right (output) side of the slot [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>
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
Sets the left (input) type of the slot [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>
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
Sets the right (output) type of the slot [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>
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="comment" type="bool" setter="set_comment" getter="is_comment" default="false">
Add an `editor_description` property to Node for documentation purposes It is implemented using editor-only metadata, in a way similar to edit locking or Position2D gizmo extents. This closes #2082.
2019-08-15 14:50:26 +02:00
If [code]true[/code], the GraphNode is a comment node.
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
Add read-only mode to AnimationTreeEditor plugins
2022-05-04 07:31:53 +02:00
<member name="draggable" type="bool" setter="set_draggable" getter="is_draggable" default="true">
If [code]true[/code], the user can drag the GraphNode.
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
</member>
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="overlay" type="int" setter="set_overlay" getter="get_overlay" enum="GraphNode.Overlay" default="0">
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Sets the overlay shown above the GraphNode. See [enum Overlay].
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02:00
<member name="position_offset" type="Vector2" setter="set_position_offset" getter="get_position_offset" default="Vector2(0, 0)">
Rename Control margin to offset
2020-12-22 17:24:29 +01:00
The offset of the GraphNode, relative to the scroll offset of the [GraphEdit].
[b]Note:[/b] You cannot use position offset directly, as [GraphEdit] is a [Container].
</member>
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="resizable" type="bool" setter="set_resizable" getter="is_resizable" default="false">
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
If [code]true[/code], the user can resize the GraphNode.
Improve Description of GraphNode It mostly fixes issues I have listed in https://github.com/godotengine/godot-docs/issues/3065 where GraphNode description was rather lacking clarity. It was near impossible how to use the them or how to create new slots etc. I improved it quite a bit if anyone has idea how to reword original "A tuple of input and output slots is defined for each GUI element included in the GraphNode." I would love to hear it. I am unsure how to word it in more understandable way.
2020-01-19 00:01:56 +01:00
[b]Note:[/b] Dragging the handle will only emit the [signal resize_request] signal, the GraphNode needs to be resized manually.
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>
Add read-only mode to AnimationTreeEditor plugins
2022-05-04 07:31:53 +02:00
<member name="selectable" type="bool" setter="set_selectable" getter="is_selectable" default="true">
If [code]true[/code], the user can select the GraphNode.
</member>
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="selected" type="bool" setter="set_selected" getter="is_selected" default="false">
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
If [code]true[/code], the GraphNode is selected.
Update docs [ci skip]
2018-01-11 23:38:35 +01:00
</member>
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="show_close" type="bool" setter="set_show_close_button" getter="is_close_button_visible" default="false">
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
If [code]true[/code], the close button will be visible.
Improve Description of GraphNode It mostly fixes issues I have listed in https://github.com/godotengine/godot-docs/issues/3065 where GraphNode description was rather lacking clarity. It was near impossible how to use the them or how to create new slots etc. I improved it quite a bit if anyone has idea how to reword original "A tuple of input and output slots is defined for each GUI element included in the GraphNode." I would love to hear it. I am unsure how to word it in more understandable way.
2020-01-19 00:01:56 +01:00
[b]Note:[/b] Pressing it will only emit the [signal close_request] signal, the GraphNode needs to be removed manually.
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>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 13:49:10 +02:00
<member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" enum="Control.TextDirection" default="0">
Base text writing direction.
</member>
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>
<signal name="close_request">
<description>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when the GraphNode is requested to be closed. Happens on clicking the close button (see [member show_close]).
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>
</signal>
<signal name="dragged">
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="from" type="Vector2" />
<param index="1" name="to" type="Vector2" />
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>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when the GraphNode is dragged.
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>
</signal>
Rename (de)selected signals to node_(de)selected in GraphNode
2023-01-12 04:08:06 +01:00
<signal name="node_deselected">
<description>
Emitted when the GraphNode is deselected.
</description>
</signal>
<signal name="node_selected">
<description>
Emitted when the GraphNode is selected.
</description>
</signal>
Rename Control margin to offset
2020-12-22 17:24:29 +01:00
<signal name="position_offset_changed">
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>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when the GraphNode is moved.
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>
</signal>
<signal name="raise_request">
<description>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) 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>
</signal>
<signal name="resize_request">
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="new_minsize" type="Vector2" />
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>
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]).
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>
</signal>
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">
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="0" name="idx" 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>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="OVERLAY_DISABLED" value="0" enum="Overlay">
Complete docs for GraphEdit/Node and PopupMenu
2020-01-08 02:05:32 +01:00
No overlay is shown.
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
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="OVERLAY_BREAKPOINT" value="1" enum="Overlay">
Add [theme_item] tag to editor help
2021-11-18 15:03:03 +01:00
Show overlay set in the [theme_item breakpoint] theme property.
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
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="OVERLAY_POSITION" value="2" enum="Overlay">
Add [theme_item] tag to editor help
2021-11-18 15:03:03 +01:00
Show overlay set in the [theme_item position] theme property.
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
</constant>
</constants>
<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="close_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The color modulation applied to the close button icon.
General fixes for the AnimationTree editor
2018-12-18 00:03:25 +01:00
</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="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>
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="title_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
Color of the title text.
</theme_item>
Modify the default theme GraphNode close_h_offset Modifies the close_h_offset to be 12 instead of 22. This better aligns the default position.
2023-02-22 11:33:04 +01:00
<theme_item name="close_h_offset" data_type="constant" type="int" default="12">
Improve the VisualShader/VisualScript editor UI
2022-04-30 03:56:57 +02:00
</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="close_offset" data_type="constant" type="int" default="22">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The vertical offset of the close button.
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 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="port_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>
Add missing properties to default theme
2022-08-11 14:15:04 +02:00
<theme_item name="title_h_offset" data_type="constant" type="int" default="0">
Horizontal offset of the title text.
</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="title_offset" data_type="constant" type="int" default="26">
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 19:02:20 +01:00
Vertical offset of the title text.
</theme_item>
<theme_item name="title_font" data_type="font" type="Font">
Font used for the title text.
</theme_item>
<theme_item name="close" data_type="icon" type="Texture2D">
The icon for the close button, visible when [member show_close] is enabled.
</theme_item>
<theme_item name="port" data_type="icon" type="Texture2D">
The icon used for representing ports.
</theme_item>
<theme_item name="resizer" data_type="icon" type="Texture2D">
The icon used for resizer, visible when [member resizable] is enabled.
</theme_item>
<theme_item name="breakpoint" data_type="style" type="StyleBox">
The background used when [member overlay] is set to [constant OVERLAY_BREAKPOINT].
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="comment" data_type="style" type="StyleBox">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The [StyleBox] used when [member comment] 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
</theme_item>
Rename theme properties to include underscores - check_vadjust -> check_v_adjust - close_h_ofs -> close_h_offset - close_v_ofs -> close_v_offset - commentfocus -> comment_focus - hseparation -> h_separation - ofs -> offset - selectedframe -> selected_frame - state_machine_selectedframe -> state_machine_selected_frame - table_hseparation -> table_h_separation - table_vseparation -> table_v_separation - vseparation -> v_separation
2022-04-14 23:20:28 +02:00
<theme_item name="comment_focus" data_type="style" type="StyleBox">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The [StyleBox] used when [member comment] is enabled and the [GraphNode] is focused.
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>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="frame" data_type="style" type="StyleBox">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The default background for [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>
Add theme item descriptions to the online documentation
2021-08-04 18:54:41 +02:00
<theme_item name="position" data_type="style" type="StyleBox">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The background used when [member overlay] is set to [constant OVERLAY_POSITION].
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>
Rename theme properties to include underscores - check_vadjust -> check_v_adjust - close_h_ofs -> close_h_offset - close_v_ofs -> close_v_offset - commentfocus -> comment_focus - hseparation -> h_separation - ofs -> offset - selectedframe -> selected_frame - state_machine_selectedframe -> state_machine_selected_frame - table_hseparation -> table_h_separation - table_vseparation -> table_v_separation - vseparation -> v_separation
2022-04-14 23:20:28 +02:00
<theme_item name="selected_frame" data_type="style" type="StyleBox">
Add LOTS of missing docs
2020-03-03 19:21:21 +01:00
The background used when the [GraphNode] is 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>
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