virtualx-engine/modules/visual_script/doc_classes/VisualScriptPropertyGet.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualScriptPropertyGet" inherits="VisualScriptNode" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		A Visual Script node returning a value of a property from an [Object].
	</brief_description>
	<description>
		[VisualScriptPropertyGet] can return a value of any property from the current object or other objects.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
			The script to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE].
		</member>
		<member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
			The base type to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE].
		</member>
		<member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
			The type to be used when [member set_mode] is set to [constant CALL_MODE_BASIC_TYPE].
		</member>
		<member name="index" type="String" setter="set_index" getter="get_index">
			The indexed name of the property to retrieve. See [method Object.get_indexed] for details.
		</member>
		<member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
			The node path to use when [member set_mode] is set to [constant CALL_MODE_NODE_PATH].
		</member>
		<member name="property" type="String" setter="set_property" getter="get_property" default="&quot;&quot;">
			The name of the property to retrieve. Changing this will clear [member index].
		</member>
		<member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode" default="0">
			[code]set_mode[/code] determines the target object from which the property will be retrieved. See [enum CallMode] for options.
		</member>
	</members>
	<constants>
		<constant name="CALL_MODE_SELF" value="0" enum="CallMode">
			The property will be retrieved from this [Object].
		</constant>
		<constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode">
			The property will be retrieved from the given [Node] in the scene tree.
		</constant>
		<constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
			The property will be retrieved from an instanced node with the given type and script.
		</constant>
		<constant name="CALL_MODE_BASIC_TYPE" value="3" enum="CallMode">
			The property will be retrieved from a GDScript basic type (e.g. [Vector2]).
		</constant>
	</constants>
</class>