virtualx-engine/doc/classes/AnimationNodeTransition.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeTransition" inherits="AnimationNodeSync" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A generic animation transition node for [AnimationTree].
	</brief_description>
	<description>
		Simple state machine for cases which don't require a more advanced [AnimationNodeStateMachine]. Animations can be connected to the inputs and transition times can be specified.
	</description>
	<tutorials>
		<link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>
		<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</tutorials>
	<methods>
		<method name="find_input_caption" qualifiers="const">
			<return type="int" />
			<param index="0" name="caption" type="String" />
			<description>
			</description>
		</method>
		<method name="get_input_caption" qualifiers="const">
			<return type="String" />
			<param index="0" name="input" type="int" />
			<description>
			</description>
		</method>
		<method name="is_input_set_as_auto_advance" qualifiers="const">
			<return type="bool" />
			<param index="0" name="input" type="int" />
			<description>
			</description>
		</method>
		<method name="set_input_as_auto_advance">
			<return type="void" />
			<param index="0" name="input" type="int" />
			<param index="1" name="enable" type="bool" />
			<description>
			</description>
		</method>
		<method name="set_input_caption">
			<return type="void" />
			<param index="0" name="input" type="int" />
			<param index="1" name="caption" type="String" />
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="enabled_inputs" type="int" setter="set_enabled_inputs" getter="get_enabled_inputs" default="0">
			The number of enabled input ports for this node.
		</member>
		<member name="reset" type="bool" setter="set_reset" getter="is_reset" default="true">
			If [code]true[/code], the destination animation is played back from the beginning when switched.
		</member>
		<member name="xfade_curve" type="Curve" setter="set_xfade_curve" getter="get_xfade_curve">
		</member>
		<member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time" default="0.0">
			Cross-fading time (in seconds) between each animation connected to the inputs.
		</member>
	</members>
</class>
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 11:56:21 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
refactor sync in AnimationTree 2022-06-29 08:35:29 +02:00			`<class name="AnimationNodeTransition" inherits="AnimationNodeSync" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 11:56:21 +02:00			`<brief_description>`
Add LOTS of missing docs 2020-03-03 19:21:21 +01:00			`A generic animation transition node for [AnimationTree].`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 11:56:21 +02:00			`</brief_description>`
			`<description>`
Add LOTS of missing docs 2020-03-03 19:21:21 +01:00			`Simple state machine for cases which don't require a more advanced [AnimationNodeStateMachine]. Animations can be connected to the inputs and transition times can be specified.`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 11:56:21 +02:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 10:43:07 +01:00			`<link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>`
Link to demos from within the class reference 2020-10-01 10:34:47 +02:00			`<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>`
			`<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 11:56:21 +02:00			`</tutorials>`
			`<methods>`
Allow AnimationNodes to restart when transitioning to the same state 2023-01-12 13:51:03 +01:00			`<method name="find_input_caption" qualifiers="const">`
			`<return type="int" />`
			`<param index="0" name="caption" type="String" />`
			`<description>`
			`</description>`
			`</method>`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 16:10:09 +02:00			`<method name="get_input_caption" 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="String" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="input" type="int" />`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 16:10:09 +02:00			`<description>`
			`</description>`
			`</method>`
			`<method name="is_input_set_as_auto_advance" 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" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="input" type="int" />`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 16:10:09 +02:00			`<description>`
			`</description>`
			`</method>`
			`<method name="set_input_as_auto_advance">`
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" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="input" type="int" />`
			`<param index="1" name="enable" type="bool" />`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 16:10:09 +02:00			`<description>`
			`</description>`
			`</method>`
			`<method name="set_input_caption">`
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" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="input" type="int" />`
			`<param index="1" name="caption" type="String" />`
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`. 2019-06-27 16:10:09 +02:00			`<description>`
			`</description>`
			`</method>`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 11:56:21 +02:00			`</methods>`
			`<members>`
enhancement: Rename declared property AnimationNodeTransition::input_count to AnimationNodeTransition::enabled_inputs 2022-04-05 19:11:06 +02:00			`<member name="enabled_inputs" type="int" setter="set_enabled_inputs" getter="get_enabled_inputs" default="0">`
			`The number of enabled input ports for this node.`
			`</member>`
Add next/reset function to AnimationStateMachine 2023-01-10 10:15:16 +01:00			`<member name="reset" type="bool" setter="set_reset" getter="is_reset" default="true">`
refactor sync in AnimationTree 2022-06-29 08:35:29 +02:00			`If [code]true[/code], the destination animation is played back from the beginning when switched.`
			`</member>`
added Curve in animation node transition for better control over cros… Co-authored-by: jeronimo-schreyer <jeronimo.schreyer@gmail.com> 2022-07-28 10:31:23 +02:00			`<member name="xfade_curve" type="Curve" setter="set_xfade_curve" getter="get_xfade_curve">`
			`</member>`
			`<member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time" default="0.0">`
Add LOTS of missing docs 2020-03-03 19:21:21 +01:00			`Cross-fading time (in seconds) between each animation connected to the inputs.`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 11:56:21 +02:00			`</member>`
			`</members>`
			`</class>`