godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/AnimationNodeStateMachinePl...

71 lines
2.1 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
doc: Drop unused 'category' property from header We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-26 15:01:49 +00:00
<class name="AnimationNodeStateMachinePlayback" inherits="Resource" version="3.2">
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]
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback]
2019-05-21 02:45:23 +00:00
[codeblock]
var state_machine = $AnimationTree.get("parameters/playback")
state_machine.travel("some_state")
[/codeblock]
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
<tutorials>
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 13:55:33 +00:00
<link>https://docs.godotengine.org/en/3.2/tutorials/animation/animation_tree.html</link>
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</tutorials>
<methods>
<method name="get_current_node" qualifiers="const">
<return type="String">
</return>
<description>
[DOCS] Add descriptions to AnimationNodeStateMachine[Playback]
2019-05-21 02:45:23 +00:00
Returns the currently playing animation state.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name="get_travel_path" qualifiers="const">
<return type="PoolStringArray">
</return>
<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
Returns the current travel path as computed internally by the A* algorithm.
doc: Sync classref with current source
2018-08-20 22:35:30 +00:00
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
<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">
<return type="void">
</return>
<argument index="0" name="node" type="String">
</argument>
<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">
<return type="void">
</return>
<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">
<return type="void">
</return>
<argument index="0" name="to_node" type="String">
</argument>
<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>
doc: Fix parsing of self-closing XML tags Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
2019-09-24 11:34:03 +00:00
<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" override="true" 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
<constants>
</constants>
</class>