From 8d03cafd7ca9037eb6137ab2d9bf7bf06306070f Mon Sep 17 00:00:00 2001 From: Rémi Verschelde Date: Wed, 3 Jan 2018 13:45:03 +0100 Subject: doc: Sync classref with current source --- doc/classes/@GlobalScope.xml | 60 +++++++++++++++++++++++++ doc/classes/ARVRServer.xml | 2 +- doc/classes/AStar.xml | 2 +- doc/classes/BakedLightmap.xml | 28 ++++-------- doc/classes/Camera.xml | 3 -- doc/classes/Image.xml | 78 ++++++++++++++++++++------------- doc/classes/Input.xml | 36 ++++++++++++++- doc/classes/InputEvent.xml | 15 ------- doc/classes/MenuButton.xml | 8 ++++ doc/classes/Physics2DServer.xml | 6 +++ doc/classes/SceneTree.xml | 16 +++++-- doc/classes/ScriptEditor.xml | 16 +++---- doc/classes/Spatial.xml | 46 ++++++++++++------- doc/classes/TextEdit.xml | 2 +- doc/classes/TileMap.xml | 2 +- doc/classes/TileSet.xml | 6 +-- doc/classes/Tree.xml | 2 + modules/gridmap/doc_classes/GridMap.xml | 42 ++++++++++++++++++ 18 files changed, 268 insertions(+), 102 deletions(-) diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index de5dc18702..6e8b760966 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -93,6 +93,14 @@ Bottom margin, used usually for [Control] or [StyleBox] derived classes. + + + + + + + + General vertical alignment, used usually for [Separator], [ScrollBar], [Slider], etc. @@ -1385,5 +1393,57 @@ Marker for end of type constants. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index ffe6c35240..7f9eedce50 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -14,7 +14,7 @@ - + diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index e0e3261edf..08ac12736a 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -171,7 +171,7 @@ - + Returns an array with the ids of the points that form the connect with the given point. diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index b351aeac05..b23b608589 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -27,38 +27,28 @@ - + - + + + - + - + - + - + - + - - - - - - - - - - - - diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index 91c9ecc774..c2ae9101e1 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -150,9 +150,6 @@ The horizontal (Y) offset of the Camear viewport. - - A boolean representation of [member keep_aspect] in which [code]true[/code] is equivalent to [code]KEEP_WIDTH[/code]. - diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 54eaf6cc7a..230978950b 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -314,6 +314,22 @@ Loads an image from file [code]path[/code]. + + + + + + + + + + + + + + + + @@ -430,65 +446,67 @@ - + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 53a2d48347..79dc45fa1f 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -275,7 +275,7 @@ - + @@ -350,5 +350,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/InputEvent.xml b/doc/classes/InputEvent.xml index cc31da0627..a8abe60f78 100644 --- a/doc/classes/InputEvent.xml +++ b/doc/classes/InputEvent.xml @@ -28,13 +28,6 @@ Returns a [String] representation of the event. - - - - - Returns the event's ID. - - @@ -83,14 +76,6 @@ Returns [code]true[/code] if this input event is pressed. Not relevant for the event types [code]MOUSE_MOTION[/code], [code]SCREEN_DRAG[/code] or [code]NONE[/code]. - - - - - - - - diff --git a/doc/classes/MenuButton.xml b/doc/classes/MenuButton.xml index 22231cfdf3..af681c9456 100644 --- a/doc/classes/MenuButton.xml +++ b/doc/classes/MenuButton.xml @@ -18,6 +18,14 @@ Return the [PopupMenu] contained in this button. + + + + + + + + diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 9a4bfe141b..8bad396b84 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -1135,6 +1135,12 @@ Constant to create damped spring joints. + + + + + + Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index a78fe03cab..3a4b843b06 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -302,6 +302,14 @@ + + + + + + + + @@ -402,13 +410,13 @@ - + - + - + - + diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 81b0b3d0c3..1e1a8d516e 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -12,11 +12,11 @@ - + - + - + @@ -24,11 +24,11 @@ - + - + - + @@ -43,9 +43,9 @@ - + - + diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 7940e4065e..d0addcf9f9 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -34,7 +34,7 @@ Returns the current [World] resource this Spatial node is registered to. - + @@ -42,27 +42,15 @@ - Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system. + Rotates the global (world) transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in global coordinate system. - + - Scales the local transformation by given 3D scale factors in object-local coordinate system. - - - - - - - - - - - Rotates the global (world) transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in global coordinate system. @@ -151,6 +139,17 @@ Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. + + + + + + + + + Rotates the local transformation around axis, a unit [Vector3], by specified angle in radians. The rotation axis is in object-local coordinate system. + + @@ -178,6 +177,15 @@ Rotates the local transformation around the Z axis by angle in radians. + + + + + + + Scales the local transformation by given 3D scale factors in object-local coordinate system. + + @@ -264,6 +272,14 @@ Changes the node's position by given offset [Vector3]. + + + + + + + + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index ab722a24c3..f4d80c46b4 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -213,7 +213,7 @@ - + diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index a09f6b6dc3..daba0a0fc1 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -185,7 +185,7 @@ - + Applies autotiling rules to the cell (and its adjacent cells) referenced by its grid-based X and Y coordinates. diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 3dbf172c5a..716f89eab6 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -39,7 +39,7 @@ - + @@ -47,9 +47,9 @@ - + - + diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 11bd3b3b86..e26082c47e 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -41,6 +41,8 @@ + + Create an item in the tree and add it as the last child of [code]parent[/code]. If parent is not given, it will be added as the root's last child, or it'll the be the root itself if the tree is empty. diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index e9bb90631d..c30c6d77b9 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -95,6 +95,22 @@ Returns whether or not grid items are centered on the Z axis. + + + + + + + + + + + + + + + + @@ -222,6 +238,26 @@ + + + + + + + + + + + + + + + + + + + + @@ -249,6 +285,12 @@ + + + + + + Invalid cell item that can be used in [method set_cell_item] to clear cells (or represent an empty cell in [method get_cell_item]). -- cgit v1.2.3