virtualx-engine/doc/classes/AnimationNodeBlendSpace1D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeBlendSpace1D" inherits="AnimationRootNode" version="4.0">
	<brief_description>
		Blends linearly between two of any number of [AnimationNode] of any type placed on a virtual axis.
	</brief_description>
	<description>
		A resource to add to an [AnimationNodeBlendTree].
		This is a virtual axis on which you can add any type of [AnimationNode] using [method add_blend_point].
		Outputs the linear blend of the two [AnimationNode]s closest to the node's current value.
		You can set the extents of the axis using the [member min_space] and [member max_space].
	</description>
	<tutorials>
		<link title="AnimationTree">https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html</link>
	</tutorials>
	<methods>
		<method name="add_blend_point">
			<return type="void" />
			<argument index="0" name="node" type="AnimationRootNode" />
			<argument index="1" name="pos" type="float" />
			<argument index="2" name="at_index" type="int" default="-1" />
			<description>
				Adds a new point that represents a [code]node[/code] on the virtual axis at a given position set by [code]pos[/code]. You can insert it at a specific index using the [code]at_index[/code] argument. If you use the default value for [code]at_index[/code], the point is inserted at the end of the blend points array.
			</description>
		</method>
		<method name="get_blend_point_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of points on the blend axis.
			</description>
		</method>
		<method name="get_blend_point_node" qualifiers="const">
			<return type="AnimationRootNode" />
			<argument index="0" name="point" type="int" />
			<description>
				Returns the [AnimationNode] referenced by the point at index [code]point[/code].
			</description>
		</method>
		<method name="get_blend_point_position" qualifiers="const">
			<return type="float" />
			<argument index="0" name="point" type="int" />
			<description>
				Returns the position of the point at index [code]point[/code].
			</description>
		</method>
		<method name="remove_blend_point">
			<return type="void" />
			<argument index="0" name="point" type="int" />
			<description>
				Removes the point at index [code]point[/code] from the blend axis.
			</description>
		</method>
		<method name="set_blend_point_node">
			<return type="void" />
			<argument index="0" name="point" type="int" />
			<argument index="1" name="node" type="AnimationRootNode" />
			<description>
				Changes the [AnimationNode] referenced by the point at index [code]point[/code].
			</description>
		</method>
		<method name="set_blend_point_position">
			<return type="void" />
			<argument index="0" name="point" type="int" />
			<argument index="1" name="pos" type="float" />
			<description>
				Updates the position of the point at index [code]point[/code] on the blend axis.
			</description>
		</method>
	</methods>
	<members>
		<member name="max_space" type="float" setter="set_max_space" getter="get_max_space" default="1.0">
			The blend space's axis's upper limit for the points' position. See [method add_blend_point].
		</member>
		<member name="min_space" type="float" setter="set_min_space" getter="get_min_space" default="-1.0">
			The blend space's axis's lower limit for the points' position. See [method add_blend_point].
		</member>
		<member name="snap" type="float" setter="set_snap" getter="get_snap" default="0.1">
			Position increment to snap to when moving a point on the axis.
		</member>
		<member name="value_label" type="String" setter="set_value_label" getter="get_value_label" default="&quot;value&quot;">
			Label of the virtual axis of the blend space.
		</member>
	</members>
	<constants>
	</constants>
</class>