From 5267099a87a3dce9d9899b7535bdc4bada907aa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Wed, 29 Aug 2018 22:25:11 +0200 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/Array.xml | 16 +- doc/classes/CPUParticles2D.xml | 193 ++++++++++++++++++ doc/classes/ClippedCamera.xml | 87 ++++++++ doc/classes/EditorPlugin.xml | 16 +- doc/classes/OS.xml | 12 ++ doc/classes/Physics2DDirectSpaceState.xml | 18 +- doc/classes/Physics2DShapeQueryParameters.xml | 4 + doc/classes/PhysicsDirectSpaceState.xml | 14 +- doc/classes/PhysicsShapeQueryParameters.xml | 4 + doc/classes/Plane.xml | 6 +- doc/classes/ProjectSettings.xml | 6 +- doc/classes/RayCast.xml | 4 + doc/classes/RayCast2D.xml | 4 + doc/classes/Shape.xml | 4 + doc/classes/SpatialMaterial.xml | 12 +- doc/classes/Sprite.xml | 8 + doc/classes/TileMap.xml | 10 - doc/classes/TileSet.xml | 22 ++ doc/classes/UndoRedo.xml | 0 doc/classes/Viewport.xml | 6 + modules/gridmap/doc_classes/GridMap.xml | 5 +- 21 files changed, 416 insertions(+), 35 deletions(-) create mode 100644 doc/classes/CPUParticles2D.xml create mode 100644 doc/classes/ClippedCamera.xml mode change 100755 => 100644 doc/classes/UndoRedo.xml diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 9c5ae8ebd07..162e2d3e05f 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -216,7 +216,7 @@ - Insert a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()). + Insert a new element at a given position in the array. The position must be valid, or at the end of the array ([code]pos == size()[/code]). @@ -224,6 +224,20 @@ Reverse the order of the elements in the array (so first element will now be the last) and return reference to the array. + + + + + Return maximum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned. + + + + + + + Return minimum value contained in the array if all elements are of comparable types. If the elements can't be compared, [code]null[/code] is returned. + + diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml new file mode 100644 index 00000000000..6d115e26503 --- /dev/null +++ b/doc/classes/CPUParticles2D.xml @@ -0,0 +1,193 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/ClippedCamera.xml b/doc/classes/ClippedCamera.xml new file mode 100644 index 00000000000..509ddb01fce --- /dev/null +++ b/doc/classes/ClippedCamera.xml @@ -0,0 +1,87 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 62fc56e9900..5d2407adce4 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -470,17 +470,21 @@ - + - + - + - + - + - + + + + + diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index cf861760868..c41084f8536 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -43,6 +43,12 @@ Centers the window on the screen if in windowed mode. + + + + + + @@ -593,6 +599,12 @@ Resumes native video playback. + + + + + + diff --git a/doc/classes/Physics2DDirectSpaceState.xml b/doc/classes/Physics2DDirectSpaceState.xml index f0fee77a5a9..483c71b2c03 100644 --- a/doc/classes/Physics2DDirectSpaceState.xml +++ b/doc/classes/Physics2DDirectSpaceState.xml @@ -19,7 +19,7 @@ Checks how far the shape can travel toward a point. Note that both the shape and the motion are supplied through a [Physics2DShapeQueryParameters] object. The method will return an array with two floats between 0 and 1, both representing a fraction of [code]motion[/code]. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be [1, 1]. - If the shape can not move, the array will be empty ([code]dir.empty()==true[/code]). + If the shape can not move, the array will be empty. @@ -47,7 +47,7 @@ [code]point[/code]: The intersection point. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. - If the shape did not intersect anything, then an empty dictionary ([code]dir.empty()==true[/code]) is returned instead. + If the shape did not intersect anything, then an empty dictionary is returned instead. @@ -61,6 +61,10 @@ + + + + Checks whether a point is inside any shape. The shapes the point is inside of are returned in an array containing dictionaries with the following fields: [code]collider[/code]: The colliding object. @@ -68,7 +72,7 @@ [code]metadata[/code]: The intersecting shape's metadata. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data]. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. - Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. + Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with [PhysicsBody]s or [Area]s, respectively. @@ -82,6 +86,10 @@ + + + + Intersects a ray in a given space. The returned object is a dictionary with the following fields: [code]collider[/code]: The colliding object. @@ -91,8 +99,8 @@ [code]position[/code]: The intersection point. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. - If the ray did not intersect anything, then an empty dictionary ([code]dir.empty()==true[/code]) is returned instead. - Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. + If the ray did not intersect anything, then an empty dictionary is returned instead. + Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with [PhysicsBody]s or [Area]s, respectively. diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 391ad6276f6..f9e0c5e3deb 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -22,6 +22,10 @@ + + + + The physics layer the query should be made on. diff --git a/doc/classes/PhysicsDirectSpaceState.xml b/doc/classes/PhysicsDirectSpaceState.xml index 3f0e1a4f70b..2f7cf5a8f33 100644 --- a/doc/classes/PhysicsDirectSpaceState.xml +++ b/doc/classes/PhysicsDirectSpaceState.xml @@ -21,7 +21,7 @@ Checks whether the shape can travel to a point. The method will return an array with two floats between 0 and 1, both representing a fraction of [code]motion[/code]. The first is how far the shape can move without triggering a collision, and the second is the point at which a collision will occur. If no collision is detected, the returned array will be [1, 1]. - If the shape can not move, the array will be empty ([code]dir.empty()==true[/code]). + If the shape can not move, the array will be empty. @@ -48,7 +48,7 @@ [code]point[/code]: The intersection point. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. - If the shape did not intersect anything, then an empty dictionary ([code]dir.empty()==true[/code]) is returned instead. + If the shape did not intersect anything, then an empty dictionary is returned instead. @@ -60,7 +60,11 @@ - + + + + + Intersects a ray in a given space. The returned object is a dictionary with the following fields: @@ -70,8 +74,8 @@ [code]position[/code]: The intersection point. [code]rid[/code]: The intersecting object's [RID]. [code]shape[/code]: The shape index of the colliding shape. - If the ray did not intersect anything, then an empty dictionary ([code]dir.empty()==true[/code]) is returned instead. - Additionally, the method can take an array of objects or [RID]s that are to be excluded from collisions, or a bitmask representing the physics layers to check in. + If the ray did not intersect anything, then an empty dictionary is returned instead. + Additionally, the method can take an [code]exclude[/code] array of objects or [RID]s that are to be excluded from collisions, a [code]collision_mask[/code] bitmask representing the physics layers to check in, or booleans to determine if the ray should collide with [PhysicsBody]s or [Area]s, respectively. diff --git a/doc/classes/PhysicsShapeQueryParameters.xml b/doc/classes/PhysicsShapeQueryParameters.xml index 2f36e81e27e..7cca231ad20 100644 --- a/doc/classes/PhysicsShapeQueryParameters.xml +++ b/doc/classes/PhysicsShapeQueryParameters.xml @@ -19,6 +19,10 @@ + + + + diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index 62e4fc5d9d6..3d5eada066c 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -157,11 +157,11 @@ - + - + - + diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 5f828550b9c..0bda5909edd 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -656,11 +656,11 @@ - - Whether to allow falling back to other graphics drivers if the preferred driver is not available. Best means use the best working driver (this is the default). Never means never fall back to another driver even if it does not work. This means the project will not run if the preferred driver does not function. + + Maximum Anisotropic filter level used for textures when anisotropy enabled. @@ -726,6 +726,8 @@ Thread model for rendering. Rendering on a thread can vastly improve performance, but syncinc to the main thread can cause a bit more jitter. + + If the project uses this compression (usually low end mobile), texture importer will import these. diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index dce73d9c29a..910f5c8ad41 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -135,6 +135,10 @@ The ray's destination point, relative to the RayCast's [code]position[/code]. + + + + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index 79e733bcdc3..8ba9ee2bcf6 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -134,6 +134,10 @@ The ray's destination point, relative to the RayCast's [code]position[/code]. + + + + The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml index fcd01bc25ae..d31da20f071 100644 --- a/doc/classes/Shape.xml +++ b/doc/classes/Shape.xml @@ -13,6 +13,10 @@ + + + + diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index 4f48889531a..354c6686bb4 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -64,12 +64,12 @@ - - + + @@ -376,5 +376,13 @@ + + + + + + + + diff --git a/doc/classes/Sprite.xml b/doc/classes/Sprite.xml index dd7fe010bad..52650c73004 100644 --- a/doc/classes/Sprite.xml +++ b/doc/classes/Sprite.xml @@ -18,6 +18,14 @@ Returns a Rect2 representing the Sprite's boundary relative to its local coordinates. + + + + + + + + diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index 73d60e49b78..49549a98926 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -157,16 +157,6 @@ If you need these to be immediately updated, you can call [method update_dirty_quadrants]. - - - - - - - - - - diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 56bb33c5e14..a30d12d6b76 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -215,6 +215,16 @@ + + + + + + + + + + @@ -389,6 +399,18 @@ + + + + + + + + + + + + diff --git a/doc/classes/UndoRedo.xml b/doc/classes/UndoRedo.xml old mode 100755 new mode 100644 diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 05649193a6c..2f5710da511 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -104,6 +104,12 @@ Returns [code]true[/code] if there are visible modals on-screen. + + + + + + diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index d5f95636002..09e8e397964 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -212,9 +212,12 @@ - + The assigned [MeshLibrary]. + + Deprecated, use [member mesh_library] instead. +