diff options
Diffstat (limited to 'doc/classes/GraphNode.xml')
| -rw-r--r-- | doc/classes/GraphNode.xml | 183 |
1 files changed, 100 insertions, 83 deletions
diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 173da63a15..009c329ee2 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -17,24 +17,18 @@ Disables all input and output slots of the GraphNode. </description> </method> - <method name="clear_opentype_features"> - <return type="void" /> - <description> - Removes all OpenType features. - </description> - </method> <method name="clear_slot"> <return type="void" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Disables input and output slot whose index is [code]idx[/code]. + Disables input and output slot whose index is [param idx]. </description> </method> <method name="get_connection_input_color"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the [Color] of the input connection [code]idx[/code]. + Returns the [Color] of the input connection [param idx]. </description> </method> <method name="get_connection_input_count"> @@ -43,25 +37,32 @@ Returns the number of enabled input slots (connections) to the GraphNode. </description> </method> + <method name="get_connection_input_height"> + <return type="int" /> + <param index="0" name="idx" type="int" /> + <description> + Returns the height of the input connection [param idx]. + </description> + </method> <method name="get_connection_input_position"> <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the position of the input connection [code]idx[/code]. + Returns the position of the input connection [param idx]. </description> </method> <method name="get_connection_input_type"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the type of the input connection [code]idx[/code]. + Returns the type of the input connection [param idx]. </description> </method> <method name="get_connection_output_color"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the [Color] of the output connection [code]idx[/code]. + Returns the [Color] of the output connection [param idx]. </description> </method> <method name="get_connection_output_count"> @@ -70,144 +71,152 @@ Returns the number of enabled output slots (connections) of the GraphNode. </description> </method> - <method name="get_connection_output_position"> - <return type="Vector2" /> - <argument index="0" name="idx" type="int" /> + <method name="get_connection_output_height"> + <return type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the position of the output connection [code]idx[/code]. + Returns the height of the output connection [param idx]. </description> </method> - <method name="get_connection_output_type"> - <return type="int" /> - <argument index="0" name="idx" type="int" /> + <method name="get_connection_output_position"> + <return type="Vector2" /> + <param index="0" name="idx" type="int" /> <description> - Returns the type of the output connection [code]idx[/code]. + Returns the position of the output connection [param idx]. </description> </method> - <method name="get_opentype_feature" qualifiers="const"> + <method name="get_connection_output_type"> <return type="int" /> - <argument index="0" name="tag" type="String" /> + <param index="0" name="idx" type="int" /> <description> - Returns OpenType feature [code]tag[/code]. + Returns the type of the output connection [param idx]. </description> </method> <method name="get_slot_color_left" qualifiers="const"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the left (input) [Color] of the slot [code]idx[/code]. + Returns the left (input) [Color] of the slot [param idx]. </description> </method> <method name="get_slot_color_right" qualifiers="const"> <return type="Color" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the right (output) [Color] of the slot [code]idx[/code]. + Returns the right (output) [Color] of the slot [param idx]. </description> </method> <method name="get_slot_type_left" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the left (input) type of the slot [code]idx[/code]. + Returns the left (input) type of the slot [param idx]. </description> </method> <method name="get_slot_type_right" qualifiers="const"> <return type="int" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns the right (output) type of the slot [code]idx[/code]. + Returns the right (output) type of the slot [param idx]. </description> </method> - <method name="is_slot_enabled_left" qualifiers="const"> + <method name="is_slot_draw_stylebox" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns [code]true[/code] if left (input) side of the slot [code]idx[/code] is enabled. + Returns true if the background [StyleBox] of the slot [param idx] is drawn. </description> </method> - <method name="is_slot_enabled_right" qualifiers="const"> + <method name="is_slot_enabled_left" qualifiers="const"> <return type="bool" /> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> - Returns [code]true[/code] if right (output) side of the slot [code]idx[/code] is enabled. + Returns [code]true[/code] if left (input) side of the slot [param idx] is enabled. </description> </method> - <method name="set_opentype_feature"> - <return type="void" /> - <argument index="0" name="tag" type="String" /> - <argument index="1" name="value" type="int" /> + <method name="is_slot_enabled_right" qualifiers="const"> + <return type="bool" /> + <param index="0" name="idx" type="int" /> <description> - Sets OpenType feature [code]tag[/code]. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url]. + Returns [code]true[/code] if right (output) side of the slot [param idx] is enabled. </description> </method> <method name="set_slot"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="enable_left" type="bool" /> - <argument index="2" name="type_left" type="int" /> - <argument index="3" name="color_left" type="Color" /> - <argument index="4" name="enable_right" type="bool" /> - <argument index="5" name="type_right" type="int" /> - <argument index="6" name="color_right" type="Color" /> - <argument index="7" name="custom_left" type="Texture2D" default="null" /> - <argument index="8" name="custom_right" type="Texture2D" default="null" /> - <description> - Sets properties of the slot with ID [code]idx[/code]. - If [code]enable_left[/code]/[code]right[/code], a port will appear and the slot will be able to be connected from this side. - [code]type_left[/code]/[code]right[/code] is an arbitrary type of the port. Only ports with the same type values can be connected. - [code]color_left[/code]/[code]right[/code] is the tint of the port's icon on this side. - [code]custom_left[/code]/[code]right[/code] is a custom texture for this side's port. + <param index="0" name="idx" type="int" /> + <param index="1" name="enable_left" type="bool" /> + <param index="2" name="type_left" type="int" /> + <param index="3" name="color_left" type="Color" /> + <param index="4" name="enable_right" type="bool" /> + <param index="5" name="type_right" type="int" /> + <param index="6" name="color_right" type="Color" /> + <param index="7" name="custom_left" type="Texture2D" default="null" /> + <param index="8" name="custom_right" type="Texture2D" default="null" /> + <param index="9" name="enable" type="bool" default="true" /> + <description> + Sets properties of the slot with ID [param idx]. + If [param enable_left]/[param enable_right], a port will appear and the slot will be able to be connected from this side. + [param type_left]/[param type_right] is an arbitrary type of the port. Only ports with the same type values can be connected. + [param color_left]/[param color_right] is the tint of the port's icon on this side. + [param custom_left]/[param custom_right] is a custom texture for this side's port. [b]Note:[/b] This method only sets properties of the slot. To create the slot, add a [Control]-derived child to the GraphNode. Individual properties can be set using one of the [code]set_slot_*[/code] methods. You must enable at least one side of the slot to do so. </description> </method> <method name="set_slot_color_left"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="color_left" type="Color" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="color_left" type="Color" /> <description> - Sets the [Color] of the left (input) side of the slot [code]idx[/code] to [code]color_left[/code]. + Sets the [Color] of the left (input) side of the slot [param idx] to [param color_left]. </description> </method> <method name="set_slot_color_right"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="color_right" type="Color" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="color_right" type="Color" /> <description> - Sets the [Color] of the right (output) side of the slot [code]idx[/code] to [code]color_right[/code]. + Sets the [Color] of the right (output) side of the slot [param idx] to [param color_right]. + </description> + </method> + <method name="set_slot_draw_stylebox"> + <return type="void" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="draw_stylebox" type="bool" /> + <description> + Toggles the background [StyleBox] of the slot [param idx]. </description> </method> <method name="set_slot_enabled_left"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="enable_left" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="enable_left" type="bool" /> <description> - Toggles the left (input) side of the slot [code]idx[/code]. If [code]enable_left[/code] is [code]true[/code], a port will appear on the left side and the slot will be able to be connected from this side. + Toggles the left (input) side of the slot [param idx]. If [param enable_left] is [code]true[/code], a port will appear on the left side and the slot will be able to be connected from this side. </description> </method> <method name="set_slot_enabled_right"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="enable_right" type="bool" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="enable_right" type="bool" /> <description> - Toggles the right (output) side of the slot [code]idx[/code]. If [code]enable_right[/code] is [code]true[/code], a port will appear on the right side and the slot will be able to be connected from this side. + Toggles the right (output) side of the slot [param idx]. If [param enable_right] is [code]true[/code], a port will appear on the right side and the slot will be able to be connected from this side. </description> </method> <method name="set_slot_type_left"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="type_left" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="type_left" type="int" /> <description> - Sets the left (input) type of the slot [code]idx[/code] to [code]type_left[/code]. + Sets the left (input) type of the slot [param idx] to [param type_left]. </description> </method> <method name="set_slot_type_right"> <return type="void" /> - <argument index="0" name="idx" type="int" /> - <argument index="1" name="type_right" type="int" /> + <param index="0" name="idx" type="int" /> + <param index="1" name="type_right" type="int" /> <description> - Sets the right (output) type of the slot [code]idx[/code] to [code]type_right[/code]. + Sets the right (output) type of the slot [param idx] to [param type_right]. </description> </method> </methods> @@ -251,8 +260,8 @@ </description> </signal> <signal name="dragged"> - <argument index="0" name="from" type="Vector2" /> - <argument index="1" name="to" type="Vector2" /> + <param index="0" name="from" type="Vector2" /> + <param index="1" name="to" type="Vector2" /> <description> Emitted when the GraphNode is dragged. </description> @@ -268,13 +277,13 @@ </description> </signal> <signal name="resize_request"> - <argument index="0" name="new_minsize" type="Vector2" /> + <param index="0" name="new_minsize" type="Vector2" /> <description> Emitted when the GraphNode is requested to be resized. Happens on dragging the resizer handle (see [member resizable]). </description> </signal> <signal name="slot_updated"> - <argument index="0" name="idx" type="int" /> + <param index="0" name="idx" type="int" /> <description> Emitted when any GraphNode's slot is updated. </description> @@ -301,6 +310,8 @@ <theme_item name="title_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)"> Color of the title text. </theme_item> + <theme_item name="close_h_offset" data_type="constant" type="int" default="22"> + </theme_item> <theme_item name="close_offset" data_type="constant" type="int" default="22"> The vertical offset of the close button. </theme_item> @@ -310,6 +321,9 @@ <theme_item name="separation" data_type="constant" type="int" default="2"> The vertical distance between ports. </theme_item> + <theme_item name="title_h_offset" data_type="constant" type="int" default="0"> + Horizontal offset of the title text. + </theme_item> <theme_item name="title_offset" data_type="constant" type="int" default="26"> Vertical offset of the title text. </theme_item> @@ -343,5 +357,8 @@ <theme_item name="selected_frame" data_type="style" type="StyleBox"> The background used when the [GraphNode] is selected. </theme_item> + <theme_item name="slot" data_type="style" type="StyleBox"> + The [StyleBox] used for each slot of the [GraphNode]. + </theme_item> </theme_items> </class> |