From ce0f894b4844b74b4f423056b5dc13102d89cafb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sun, 10 Dec 2017 00:43:30 +0100 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/Animation.xml | 28 ++++++++ doc/classes/AnimationPlayer.xml | 38 ++++------- doc/classes/AnimationTreePlayer.xml | 60 ++---------------- doc/classes/CanvasItem.xml | 28 ++++++++ doc/classes/EditorPlugin.xml | 22 +++++++ doc/classes/EditorSceneImporter.xml | 95 ++++++++++++++++++++++++++++ doc/classes/KinematicBody.xml | 6 ++ doc/classes/Mesh.xml | 4 ++ doc/classes/MeshInstance.xml | 2 +- doc/classes/PhysicsServer.xml | 19 ++---- doc/classes/Rect2.xml | 6 ++ doc/classes/RigidBody.xml | 15 ++--- doc/classes/SurfaceTool.xml | 2 + doc/classes/TextEdit.xml | 11 ++++ doc/classes/Texture.xml | 2 +- doc/classes/VisualServer.xml | 8 +-- scene/animation/animation_player.cpp | 4 +- scene/resources/surface_tool.cpp | 2 +- 18 files changed, 238 insertions(+), 114 deletions(-) create mode 100644 doc/classes/EditorSceneImporter.xml diff --git a/doc/classes/Animation.xml b/doc/classes/Animation.xml index c3933443a0..93b01a466b 100644 --- a/doc/classes/Animation.xml +++ b/doc/classes/Animation.xml @@ -30,6 +30,16 @@ Clear the animation (clear all tracks and reset all). + + + + + + + + + + @@ -244,6 +254,14 @@ Insert a generic key in a given track. + + + + + + + + @@ -293,6 +311,16 @@ Remove a key by position (seconds) in a given track. + + + + + + + + + + diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 6ae0debc3a..d61211bb6b 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -74,20 +74,6 @@ Returns the name of [code]animation[/code] or empty string if not found. - - - - - Get the length (in seconds) of the currently playing animation. - - - - - - - Get the position (in seconds) of the currently playing animation. - - @@ -115,11 +101,18 @@ Get the blend time (in seconds) between two animations, referenced by their names. - - + + - Returns the name of the currently playing animation. + Get the length (in seconds) of the currently playing animation. + + + + + + + Get the position (in seconds) of the currently playing animation. @@ -217,15 +210,6 @@ Specify a blend time (in seconds) between two animations, referenced by their names. - - - - - - - Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play(). - - @@ -253,6 +237,8 @@ The name of the current animation. Default value: [code]""[/code]. + + The process notification in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. diff --git a/doc/classes/AnimationTreePlayer.xml b/doc/classes/AnimationTreePlayer.xml index 37005c3bd3..ecd1f81951 100644 --- a/doc/classes/AnimationTreePlayer.xml +++ b/doc/classes/AnimationTreePlayer.xml @@ -194,19 +194,6 @@ Disconnects nodes connected to [code]id[/code] at the specified input slot. - - - - - - - - - - - Returns the path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes. - - @@ -214,13 +201,6 @@ Returns a PoolStringArray containing the name of all nodes. - - - - - Returns whether this AnimationTreePlayer is active. - - @@ -473,32 +453,6 @@ Resets this AnimationTreePlayer. - - - - - - - Sets whether this AnimationTreePlayer is active. AnimationTreePlayer will start processing if set to active. - - - - - - - - - Sets base path of this AnimationTreePlayer. - - - - - - - - - - @@ -627,17 +581,17 @@ - - The thread in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. - - - The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes. + + If [code]true[/code] the [code]AnimationTreePlayer[/code] is able to play animations. Default value: [code]false[/code]. The node from which to relatively access other nodes. Default value: [code]".."[/code]. - - If [code]true[/code] the [code]AnimationTreePlayer[/code] is able to play animations. Default value: [code]false[/code]. + + The path to the [AnimationPlayer] from which this [code]AnimationTreePlayer[/code] binds animations to animation nodes. + + + The thread in which to update animations. Default value: [enum ANIMATION_PROCESS_IDLE]. diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml index 4a567981e6..cf0b482b07 100644 --- a/doc/classes/CanvasItem.xml +++ b/doc/classes/CanvasItem.xml @@ -88,6 +88,34 @@ Draw a line from a 2D point to another, with a given color and width. It can be optionally antialiased. + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index edd1f721b5..ada0ee56a8 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -82,6 +82,14 @@ + + + + + + + + @@ -176,6 +184,12 @@ + + + + + + @@ -295,6 +309,14 @@ + + + + + + + + diff --git a/doc/classes/EditorSceneImporter.xml b/doc/classes/EditorSceneImporter.xml new file mode 100644 index 0000000000..69fe4050f4 --- /dev/null +++ b/doc/classes/EditorSceneImporter.xml @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index c5204fd0bf..43db8ed43a 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -102,6 +102,12 @@ + + + + + + If the body is at least this close to another body, this body will consider them to be colliding. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index c681886546..465b68171e 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -49,6 +49,10 @@ + + + + Render array as points (one vertex equals one point). diff --git a/doc/classes/MeshInstance.xml b/doc/classes/MeshInstance.xml index ac26c2946f..9273e87430 100644 --- a/doc/classes/MeshInstance.xml +++ b/doc/classes/MeshInstance.xml @@ -22,7 +22,7 @@ - This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. + This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index eb7c735277..8f3d77d841 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -352,7 +352,7 @@ - + @@ -540,10 +540,11 @@ - + + + - Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. @@ -1519,17 +1520,5 @@ Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. - - The [Body] can rotate and move freely. - - - The [Body] cannot move across x axis can only rotate across x axis. - - - The [Body] cannot move across y axis can only rotate across y axis. - - - The [Body] cannot move across z axis can only rotate across z axis. - diff --git a/doc/classes/Rect2.xml b/doc/classes/Rect2.xml index 1bd2e812e6..4fc9e5bd71 100644 --- a/doc/classes/Rect2.xml +++ b/doc/classes/Rect2.xml @@ -37,6 +37,12 @@ Constructs a [code]Rect2[/code] by x, y, width, and height. + + + + + + diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index cfcd0258e7..77e27cefcc 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -59,8 +59,11 @@ RigidBody's rotational velocity. - - Locks the rotational forces to a particular axis, preventing rotations on other axes. + + + + + RigidBody's bounciness. @@ -168,13 +171,5 @@ Kinematic body. The body behaves like a [KinematicBody], and can only move by user code. - - - - - - - - diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml index 22099a930c..0916d0b928 100644 --- a/doc/classes/SurfaceTool.xml +++ b/doc/classes/SurfaceTool.xml @@ -170,6 +170,8 @@ + + Returns a constructed [ArrayMesh] from current information passed in. If an existing [ArrayMesh] is passed in as an argument, will add an extra surface to the existing [ArrayMesh]. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index df48ba3e23..da30c4c7bd 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -305,6 +305,15 @@ Enable text wrapping when it goes beyond he edge of what is visible. + + + + + + + Toggle the folding of the code block at the given line. + + @@ -428,6 +437,8 @@ + + diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index 52972177bf..bf27bc4768 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -133,7 +133,7 @@ More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. - Converts texture to SRGB color space. + Converts texture to SRGB color space. Repeats texture with alternate sections mirrored. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 6627ba15d5..1a9dc3a669 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -647,7 +647,7 @@ - Sets a canvas light's height. + Sets a canvas light's height. @@ -1495,7 +1495,7 @@ - Returns a list of all the textures and their information. + Returns a list of all the textures and their information. @@ -2022,7 +2022,7 @@ More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases. - Converts texture to SRGB color space. + Converts texture to SRGB color space. Repeat texture with alternate sections mirrored. @@ -2397,4 +2397,4 @@ - \ No newline at end of file + diff --git a/scene/animation/animation_player.cpp b/scene/animation/animation_player.cpp index 91aa069060..e866e665d8 100644 --- a/scene/animation/animation_player.cpp +++ b/scene/animation/animation_player.cpp @@ -1327,7 +1327,7 @@ void AnimationPlayer::_bind_methods() { ClassDB::bind_method(D_METHOD("get_root"), &AnimationPlayer::get_root); ClassDB::bind_method(D_METHOD("seek", "seconds", "update"), &AnimationPlayer::seek, DEFVAL(false)); - ClassDB::bind_method(D_METHOD("get_position"), &AnimationPlayer::get_current_animation_position); + ClassDB::bind_method(D_METHOD("advance", "delta"), &AnimationPlayer::advance); ClassDB::bind_method(D_METHOD("find_animation", "animation"), &AnimationPlayer::find_animation); @@ -1339,8 +1339,6 @@ void AnimationPlayer::_bind_methods() { ClassDB::bind_method(D_METHOD("get_current_animation_position"), &AnimationPlayer::get_current_animation_position); ClassDB::bind_method(D_METHOD("get_current_animation_length"), &AnimationPlayer::get_current_animation_length); - ClassDB::bind_method(D_METHOD("advance", "delta"), &AnimationPlayer::advance); - ADD_GROUP("Playback Options", "playback_"); ADD_PROPERTY(PropertyInfo(Variant::INT, "playback_process_mode", PROPERTY_HINT_ENUM, "Physics,Idle"), "set_animation_process_mode", "get_animation_process_mode"); ADD_PROPERTY(PropertyInfo(Variant::REAL, "playback_default_blend_time", PROPERTY_HINT_RANGE, "0,4096,0.01"), "set_default_blend_time", "get_default_blend_time"); diff --git a/scene/resources/surface_tool.cpp b/scene/resources/surface_tool.cpp index 352418e65c..d8600e041d 100644 --- a/scene/resources/surface_tool.cpp +++ b/scene/resources/surface_tool.cpp @@ -990,7 +990,7 @@ void SurfaceTool::_bind_methods() { ClassDB::bind_method(D_METHOD("create_from", "existing", "surface"), &SurfaceTool::create_from); ClassDB::bind_method(D_METHOD("append_from", "existing", "surface", "transform"), &SurfaceTool::append_from); - ClassDB::bind_method(D_METHOD("commit", "existing"), &SurfaceTool::commit, DEFVAL(Variant()), DEFVAL(Mesh::ARRAY_COMPRESS_DEFAULT)); + ClassDB::bind_method(D_METHOD("commit", "existing", "flags"), &SurfaceTool::commit, DEFVAL(Variant()), DEFVAL(Mesh::ARRAY_COMPRESS_DEFAULT)); } SurfaceTool::SurfaceTool() {