Browse Source

Merge pull request #64344 from asmaloney/doc-animation-node-virtuals

[doc] Clarify that AnimationNode virtual methods need to be implemented rather than called directly
Max Hilbrunner 3 years ago
parent
commit
dbd1524362
1 changed files with 7 additions and 7 deletions
  1. 7 7
      doc/classes/AnimationNode.xml

+ 7 - 7
doc/classes/AnimationNode.xml

@@ -14,39 +14,39 @@
 		<method name="_get_caption" qualifiers="virtual const">
 		<method name="_get_caption" qualifiers="virtual const">
 			<return type="String" />
 			<return type="String" />
 			<description>
 			<description>
-				Gets the text caption for this node (used by some editors).
+				When inheriting from [AnimationRootNode], implement this virtual method to override the text caption for this node.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="_get_child_by_name" qualifiers="virtual const">
 		<method name="_get_child_by_name" qualifiers="virtual const">
 			<return type="AnimationNode" />
 			<return type="AnimationNode" />
 			<param index="0" name="name" type="StringName" />
 			<param index="0" name="name" type="StringName" />
 			<description>
 			<description>
-				Gets a child node by index (used by editors inheriting from [AnimationRootNode]).
+				When inheriting from [AnimationRootNode], implement this virtual method to return a child node by its [param name].
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="_get_child_nodes" qualifiers="virtual const">
 		<method name="_get_child_nodes" qualifiers="virtual const">
 			<return type="Dictionary" />
 			<return type="Dictionary" />
 			<description>
 			<description>
-				Gets all children nodes in order as a [code]name: node[/code] dictionary. Only useful when inheriting [AnimationRootNode].
+				When inheriting from [AnimationRootNode], implement this virtual method to return all children nodes in order as a [code]name: node[/code] dictionary.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="_get_parameter_default_value" qualifiers="virtual const">
 		<method name="_get_parameter_default_value" qualifiers="virtual const">
 			<return type="Variant" />
 			<return type="Variant" />
 			<param index="0" name="parameter" type="StringName" />
 			<param index="0" name="parameter" type="StringName" />
 			<description>
 			<description>
-				Gets the default value of a parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
+				When inheriting from [AnimationRootNode], implement this virtual method to return the default value of a [param parameter]. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="_get_parameter_list" qualifiers="virtual const">
 		<method name="_get_parameter_list" qualifiers="virtual const">
 			<return type="Array" />
 			<return type="Array" />
 			<description>
 			<description>
-				Gets the property information for parameter. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list].
+				When inheriting from [AnimationRootNode], implement this virtual method to return a list of the properties on this node. Parameters are custom local memory used for your nodes, given a resource can be reused in multiple trees. Format is similar to [method Object.get_property_list].
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="_has_filter" qualifiers="virtual const">
 		<method name="_has_filter" qualifiers="virtual const">
 			<return type="bool" />
 			<return type="bool" />
 			<description>
 			<description>
-				Returns whether you want the blend tree editor to display filter editing on this node.
+				When inheriting from [AnimationRootNode], implement this virtual method to return whether the blend tree editor should display filter editing on this node.
 			</description>
 			</description>
 		</method>
 		</method>
 		<method name="_process" qualifiers="virtual const">
 		<method name="_process" qualifiers="virtual const">
@@ -55,7 +55,7 @@
 			<param index="1" name="seek" type="bool" />
 			<param index="1" name="seek" type="bool" />
 			<param index="2" name="seek_root" type="bool" />
 			<param index="2" name="seek_root" type="bool" />
 			<description>
 			<description>
-				User-defined callback called when a custom node is processed. The [param time] parameter is a relative delta, unless [param seek] is [code]true[/code], in which case it is absolute.
+				When inheriting from [AnimationRootNode], implement this virtual method to run some code when this node is processed. The [param time] parameter is a relative delta, unless [param seek] is [code]true[/code], in which case it is absolute.
 				Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory.
 				Here, call the [method blend_input], [method blend_node] or [method blend_animation] functions. You can also use [method get_parameter] and [method set_parameter] to modify local memory.
 				This function should return the time left for the current animation to finish (if unsure, pass the value from the main blend being called).
 				This function should return the time left for the current animation to finish (if unsure, pass the value from the main blend being called).
 			</description>
 			</description>