Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history 
[ci skip]
  • Loading branch information
@bojidar-bg
bojidar-bg committed Jan 11, 2018
1 parent 9b8e8b2 commit ad79c70
Show file tree
Hide file tree
Showing 71 changed files with 695 additions and 3,092 deletions.
5 changes: 1 addition & 4 deletions doc/classes/@GlobalScope.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@
<member name="Geometry" type="Geometry" setter="" getter="">
[Geometry] singleton
</member>
<member name="GodotSharp" type="GodotSharp" setter="" getter="">
[GodotSharp] singleton
</member>
<member name="IP" type="IP" setter="" getter="">
[IP] singleton
</member>
Expand Down Expand Up @@ -1285,7 +1282,7 @@
</constant>
<constant name="PROPERTY_USAGE_DEFAULT_INTL" value="71" enum="PropertyUsageFlags">
</constant>
<constant name="PROPERTY_USAGE_NOEDITOR" value="1048581" enum="PropertyUsageFlags">
<constant name="PROPERTY_USAGE_NOEDITOR" value="5" enum="PropertyUsageFlags">
</constant>
<constant name="METHOD_FLAG_NORMAL" value="1" enum="MethodFlags">
Flag for normal method
Expand Down
59 changes: 11 additions & 48 deletions doc/classes/Animation.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,34 +50,13 @@
Return the index of the specified track. If the track is not found, return -1.
</description>
</method>
<method name="get_length" qualifiers="const">
<return type="float">
</return>
<description>
Return the total length of the animation (in seconds).
</description>
</method>
<method name="get_step" qualifiers="const">
<return type="float">
</return>
<description>
Get the animation step value.
</description>
</method>
<method name="get_track_count" qualifiers="const">
<return type="int">
</return>
<description>
Return the amount of tracks in the animation.
</description>
</method>
<method name="has_loop" qualifiers="const">
<return type="bool">
</return>
<description>
Return whether the animation has the loop flag set.
</description>
</method>
<method name="method_track_get_key_indices" qualifiers="const">
<return type="PoolIntArray">
</return>
Expand Down Expand Up @@ -122,33 +101,6 @@
Remove a track by specifying the track index.
</description>
</method>
<method name="set_length">
<return type="void">
</return>
<argument index="0" name="time_sec" type="float">
</argument>
<description>
Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
</description>
</method>
<method name="set_loop">
<return type="void">
</return>
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
</description>
</method>
<method name="set_step">
<return type="void">
</return>
<argument index="0" name="size_sec" type="float">
</argument>
<description>
Set the animation step value.
</description>
</method>
<method name="track_find_key" qualifiers="const">
<return type="int">
</return>
Expand Down Expand Up @@ -456,6 +408,17 @@
</description>
</method>
</methods>
<members>
<member name="length" type="float" setter="set_length" getter="get_length">
The total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
</member>
<member name="loop" type="bool" setter="set_loop" getter="has_loop">
A flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
</member>
<member name="step" type="float" setter="set_step" getter="get_step">
The animation step value.
</member>
</members>
<constants>
<constant name="TYPE_VALUE" value="0" enum="TrackType">
Value tracks set values in node properties, but only those which can be Interpolated.
Expand Down
96 changes: 18 additions & 78 deletions doc/classes/AnimationPlayer.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,6 @@
Returns the list of stored animation names.
</description>
</method>
<method name="get_autoplay" qualifiers="const">
<return type="String">
</return>
<description>
Returns the name of the animation that will be automatically played when the scene is loaded.
</description>
</method>
<method name="get_blend_time" qualifiers="const">
<return type="float">
</return>
Expand All @@ -108,34 +101,6 @@
Get the blend time (in seconds) between two animations, referenced by their names.
</description>
</method>
<method name="get_current_animation" qualifiers="const">
<return type="String">
</return>
<description>
Returns the name of the animation being played.
</description>
</method>
<method name="get_current_animation_length" qualifiers="const">
<return type="float">
</return>
<description>
Get the length (in seconds) of the currently being played animation.
</description>
</method>
<method name="get_current_animation_position" qualifiers="const">
<return type="float">
</return>
<description>
Get the position (in seconds) of the currently playing animation.
</description>
</method>
<method name="get_speed_scale" qualifiers="const">
<return type="float">
</return>
<description>
Returns the speed scaling ratio of the current animation channel. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed.
</description>
</method>
<method name="has_animation" qualifiers="const">
<return type="bool">
</return>
Expand All @@ -145,13 +110,6 @@
Returns [code]true[/code] if the [code]AnimationPlayer[/code] stores an [Animation] with key [code]name[/code].
</description>
</method>
<method name="is_active" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the player is active.
</description>
</method>
<method name="is_playing" qualifiers="const">
<return type="bool">
</return>
Expand Down Expand Up @@ -226,24 +184,6 @@
Seek the animation to the [code]seconds[/code] point in time (in seconds). If [code]update[/code] is [code]true[/code], the animation updates too, otherwise it updates at process time.
</description>
</method>
<method name="set_active">
<return type="void">
</return>
<argument index="0" name="active" type="bool">
</argument>
<description>
Sets the player as active (playing). If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code].
</description>
</method>
<method name="set_autoplay">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<description>
Defines the name of the animation to play when the scene loads. Default value: [code]""[/code].
</description>
</method>
<method name="set_blend_time">
<return type="void">
</return>
Expand All @@ -257,24 +197,6 @@
Specify a blend time (in seconds) between two animations, referenced by their names.
</description>
</method>
<method name="set_current_animation">
<return type="void">
</return>
<argument index="0" name="anim" type="String">
</argument>
<description>
Sets the name of the current animation. If already playing, restarts the animation. Ensure [member active] is [code]true[/code] to simulate [method play]. Default value: [code]""[/code].
</description>
</method>
<method name="set_speed_scale">
<return type="void">
</return>
<argument index="0" name="speed" type="float">
</argument>
<description>
Sets the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default value: [code]1[/code].
</description>
</method>
<method name="stop">
<return type="void">
</return>
Expand All @@ -286,12 +208,30 @@
</method>
</methods>
<members>
<member name="autoplay" type="String" setter="set_autoplay" getter="get_autoplay">
The name of the animation to play when the scene loads. Default value: [code]""[/code].
</member>
<member name="current_animation" type="String" setter="set_current_animation" getter="get_current_animation">
The name of the current animation, "" if not playing anything. When being set, does not restart the animation. See also [method play]. Default value: [code]""[/code].
</member>
<member name="current_animation_length" type="float" setter="" getter="get_current_animation_length">
The length (in seconds) of the currently being played animation.
</member>
<member name="current_animation_position" type="float" setter="" getter="get_current_animation_position">
The position (in seconds) of the currently playing animation.
</member>
<member name="playback_active" type="bool" setter="set_active" getter="is_active">
If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code].
</member>
<member name="playback_default_blend_time" type="float" setter="set_default_blend_time" getter="get_default_blend_time">
The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. Default value: [code]0[/code].
</member>
<member name="playback_process_mode" type="int" setter="set_animation_process_mode" getter="get_animation_process_mode" enum="AnimationPlayer.AnimationProcessMode">
The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE].
</member>
<member name="playback_speed" type="float" setter="set_speed_scale" getter="get_speed_scale">
The speed scaling ratio. For instance, if this value is 1 then the animation plays at normal speed. If it's 0.5 then it plays at half speed. If it's 2 then it plays at double speed. Default value: [code]1[/code].
</member>
<member name="root_node" type="NodePath" setter="set_root" getter="get_root">
The node from which node path references will travel. Default value: [code]".."[/code].
</member>
Expand Down
34 changes: 6 additions & 28 deletions doc/classes/ArrayMesh.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,6 @@
<description>
</description>
</method>
<method name="get_blend_shape_mode" qualifiers="const">
<return type="int" enum="Mesh.BlendShapeMode">
</return>
<description>
</description>
</method>
<method name="get_blend_shape_name" qualifiers="const">
<return type="String">
</return>
Expand All @@ -65,12 +59,6 @@
<description>
</description>
</method>
<method name="get_custom_aabb" qualifiers="const">
<return type="AABB">
</return>
<description>
</description>
</method>
<method name="get_surface_count" qualifiers="const">
<return type="int">
</return>
Expand All @@ -84,22 +72,6 @@
<description>
</description>
</method>
<method name="set_blend_shape_mode">
<return type="void">
</return>
<argument index="0" name="mode" type="int" enum="Mesh.BlendShapeMode">
</argument>
<description>
</description>
</method>
<method name="set_custom_aabb">
<return type="void">
</return>
<argument index="0" name="aabb" type="AABB">
</argument>
<description>
</description>
</method>
<method name="surface_get_array_index_len" qualifiers="const">
<return type="int">
</return>
Expand Down Expand Up @@ -212,6 +184,12 @@
</description>
</method>
</methods>
<members>
<member name="blend_shape_mode" type="int" setter="set_blend_shape_mode" getter="get_blend_shape_mode" enum="Mesh.BlendShapeMode">
</member>
<member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb">
</member>
</members>
<constants>
<constant name="NO_INDEX_ARRAY" value="-1">
Default value used for index_array_len when no indices are present.
Expand Down
14 changes: 0 additions & 14 deletions doc/classes/AudioEffectReverb.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,6 @@
<demos>
</demos>
<methods>
<method name="get_predelay_feedback" qualifiers="const">
<return type="float">
</return>
<description>
</description>
</method>
<method name="set_predelay_feedback">
<return type="void">
</return>
<argument index="0" name="feedback" type="float">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="damping" type="float" setter="set_damping" getter="get_damping">
Expand Down
14 changes: 0 additions & 14 deletions doc/classes/AudioStreamSample.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,6 @@
<demos>
</demos>
<methods>
<method name="get_data" qualifiers="const">
<return type="PoolByteArray">
</return>
<description>
</description>
</method>
<method name="set_data">
<return type="void">
</return>
<argument index="0" name="data" type="PoolByteArray">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format">
Expand Down
Loading

0 comments on commit ad79c70

Please sign in to comment.