virtualx-engine/doc/classes/VisualShaderNodeFrame.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeFrame" inherits="VisualShaderNodeResizableBase" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A frame other visual shader nodes can be attached to for better organization.
	</brief_description>
	<description>
		A rectangular frame that can be used to group visual shader nodes together to improve organization.
		Nodes attached to the frame will move with it when it is dragged and it can automatically resize to enclose all attached nodes.
		Its title, description and color can be customized.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_attached_node">
			<return type="void" />
			<param index="0" name="node" type="int" />
			<description>
				Adds a node to the list of nodes attached to the frame. Should not be called directly, use the [method VisualShader.attach_node_to_frame] method instead.
			</description>
		</method>
		<method name="remove_attached_node">
			<return type="void" />
			<param index="0" name="node" type="int" />
			<description>
				Removes a node from the list of nodes attached to the frame. Should not be called directly, use the [method VisualShader.detach_node_from_frame] method instead.
			</description>
		</method>
	</methods>
	<members>
		<member name="attached_nodes" type="PackedInt32Array" setter="set_attached_nodes" getter="get_attached_nodes" default="PackedInt32Array()">
			The list of nodes attached to the frame.
		</member>
		<member name="autoshrink" type="bool" setter="set_autoshrink_enabled" getter="is_autoshrink_enabled" default="true">
			If [code]true[/code], the frame will automatically resize to enclose all attached nodes.
		</member>
		<member name="tint_color" type="Color" setter="set_tint_color" getter="get_tint_color" default="Color(0.3, 0.3, 0.3, 0.75)">
			The color of the frame when [member tint_color_enabled] is [code]true[/code].
		</member>
		<member name="tint_color_enabled" type="bool" setter="set_tint_color_enabled" getter="is_tint_color_enabled" default="false">
			If [code]true[/code], the frame will be tinted with the color specified in [member tint_color].
		</member>
		<member name="title" type="String" setter="set_title" getter="get_title" default="&quot;Title&quot;">
			The title of the node.
		</member>
	</members>
</class>