godot/doc/classes/AnimationNodeStateMachinePl...

<?xml version="1.0" encoding="UTF-8" ?>
<class name="AnimationNodeStateMachinePlayback" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Playback control for [AnimationNodeStateMachine].
	</brief_description>
	<description>
		Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code].
		[b]Example:[/b]
		[codeblocks]
		[gdscript]
		var state_machine = $AnimationTree.get("parameters/playback")
		state_machine.travel("some_state")
		[/gdscript]
		[csharp]
		var stateMachine = GetNode&lt;AnimationTree&gt;("AnimationTree").Get("parameters/playback") as AnimationNodeStateMachinePlayback;
		stateMachine.Travel("some_state");
		[/csharp]
		[/codeblocks]
	</description>
	<tutorials>
		<link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>
	</tutorials>
	<methods>
		<method name="get_current_length" qualifiers="const">
			<return type="float" />
			<description>
			</description>
		</method>
		<method name="get_current_node" qualifiers="const">
			<return type="StringName" />
			<description>
				Returns the currently playing animation state.
			</description>
		</method>
		<method name="get_current_play_position" qualifiers="const">
			<return type="float" />
			<description>
				Returns the playback position within the current animation state.
			</description>
		</method>
		<method name="get_travel_path" qualifiers="const">
			<return type="PackedStringArray" />
			<description>
				Returns the current travel path as computed internally by the A* algorithm.
			</description>
		</method>
		<method name="is_playing" qualifiers="const">
			<return type="bool" />
			<description>
				Returns [code]true[/code] if an animation is playing.
			</description>
		</method>
		<method name="start">
			<return type="void" />
			<param index="0" name="node" type="StringName" />
			<description>
				Starts playing the given animation.
			</description>
		</method>
		<method name="stop">
			<return type="void" />
			<description>
				Stops the currently playing animation.
			</description>
		</method>
		<method name="travel">
			<return type="void" />
			<param index="0" name="to_node" type="StringName" />
			<description>
				Transitions from the current state to another one, following the shortest path.
			</description>
		</method>
	</methods>
	<members>
		<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="true" />
	</members>
</class>
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="AnimationNodeStateMachinePlayback" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<brief_description>`
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`. 2020-01-23 10:14:14 +00:00			`Playback control for [AnimationNodeStateMachine].`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</brief_description>`
			`<description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`Allows control of [AnimationTree] state machines created with [AnimationNodeStateMachine]. Retrieve with [code]$AnimationTree.get("parameters/playback")[/code].`
			`[b]Example:[/b]`
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button 2020-07-31 14:07:26 +00:00			`[codeblocks]`
			`[gdscript]`
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback] 2019-05-21 02:45:23 +00:00			`var state_machine = $AnimationTree.get("parameters/playback")`
			`state_machine.travel("some_state")`
Add C# code examples to the docs Only existing GDScript code examples are converted and added to the docs. This is the first batch include classes beginning with A and B. Included classes: * AcceptDialog * AESContext * Animation * AnimationNodeStateMachine * AnimationNodeStateMachinePlayback * AnimationNodeStateMachineTransition * Array * ArrayMesh * AStar * AStar2D * Bool * Button 2020-07-31 14:07:26 +00:00			`[/gdscript]`
			`[csharp]`
			`var stateMachine = GetNode<AnimationTree>("AnimationTree").Get("parameters/playback") as AnimationNodeStateMachinePlayback;`
			`stateMachine.Travel("some_state");`
			`[/csharp]`
			`[/codeblocks]`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 09:43:07 +00:00			`<link title="AnimationTree">$DOCS_URL/tutorials/animation/animation_tree.html</link>`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</tutorials>`
			`<methods>`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`<method name="get_current_length" 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 13:28:05 +00:00			`<return type="float" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
			`</description>`
			`</method>`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`<method name="get_current_node" 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 13:28:05 +00:00			`<return type="StringName" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`Returns the currently playing animation state.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`</method>`
StateMachinePlayback: Added missing bindings to `get_current_play_pos` and `get_current_length`. This allows the user to query the AnimationNodeStateMachinePlayback's current play position and total length of current animation state. These methods are currently used in the editor plugin, but can also be useful for querying general playback state information. Added documentation for AnimationNodeStateMachinePlayback's `get_current_play_position` 2020-09-19 02:59:25 +00:00			`<method name="get_current_play_position" 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 13:28:05 +00:00			`<return type="float" />`
StateMachinePlayback: Added missing bindings to `get_current_play_pos` and `get_current_length`. This allows the user to query the AnimationNodeStateMachinePlayback's current play position and total length of current animation state. These methods are currently used in the editor plugin, but can also be useful for querying general playback state information. Added documentation for AnimationNodeStateMachinePlayback's `get_current_play_position` 2020-09-19 02:59:25 +00:00			`<description>`
			`Returns the playback position within the current animation state.`
			`</description>`
			`</method>`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`<method name="get_travel_path" 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 13:28:05 +00:00			`<return type="PackedStringArray" />`
doc: Sync classref with current source 2021-01-04 13:33:44 +00:00			`<description>`
			`Returns the current travel path as computed internally by the A* algorithm.`
			`</description>`
			`</method>`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<method name="is_playing" 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 13:28:05 +00:00			`<return type="bool" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback] 2019-05-21 02:45:23 +00:00			`Returns [code]true[/code] if an animation is playing.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`</method>`
			`<method name="start">`
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 13:28:05 +00:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="node" type="StringName" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback] 2019-05-21 02:45:23 +00:00			`Starts playing the given animation.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`</method>`
			`<method name="stop">`
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 13:28:05 +00:00			`<return type="void" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback] 2019-05-21 02:45:23 +00:00			`Stops the currently playing animation.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`</method>`
			`<method name="travel">`
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 13:28:05 +00:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 18:11:48 +00:00			`<param index="0" name="to_node" type="StringName" />`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`<description>`
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback] 2019-05-21 02:45:23 +00:00			`Transitions from the current state to another one, following the shortest path.`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</description>`
			`</method>`
			`</methods>`
Run doctool after overridden properties changes 2019-09-03 10:44:58 +00:00			`<members>`
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com> 2021-12-02 19:38:49 +00:00			`<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="true" />`
Run doctool after overridden properties changes 2019-09-03 10:44:58 +00:00			`</members>`
doc: Sync classref with current source 2018-08-20 22:35:30 +00:00			`</class>`