From 2fad317498f2b8e5ecd64401d0cbd19721b1d276 Mon Sep 17 00:00:00 2001 From: Chris Bradfield Date: Sat, 1 Sep 2018 11:07:51 -0700 Subject: [PATCH] [DOCS] Classref additions and corrections (cherry picked from commit c049c8fbb9907fc7048b06c2a5c4be67a1e62dda) --- doc/classes/RID.xml | 4 ++-- doc/classes/ResourceSaver.xml | 8 ++++---- doc/classes/Script.xml | 17 +++++++++-------- doc/classes/Shape.xml | 2 +- doc/classes/Spatial.xml | 8 ++++---- doc/classes/VisualServer.xml | 28 ++++++++++++++-------------- 6 files changed, 34 insertions(+), 33 deletions(-) diff --git a/doc/classes/RID.xml b/doc/classes/RID.xml index faaeaf9efb1..fbe78497ab0 100644 --- a/doc/classes/RID.xml +++ b/doc/classes/RID.xml @@ -17,14 +17,14 @@ - Create a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0. + Creates a new RID instance with the ID of a given resource. When not handed a valid resource, silently stores the unused ID 0. - Retrieve the ID of the referenced resource. + Returns the ID of the referenced resource. diff --git a/doc/classes/ResourceSaver.xml b/doc/classes/ResourceSaver.xml index 44bb3158032..c8d2f317381 100644 --- a/doc/classes/ResourceSaver.xml +++ b/doc/classes/ResourceSaver.xml @@ -1,10 +1,10 @@ - Resource Saving Interface. + Resource saving interface. - Resource Saving Interface. This interface is used for saving resources to disk. + Resource saving interface, used for saving resources to disk. @@ -17,7 +17,7 @@ - Return the list of extensions available for saving a resource of a given type. + Returns the list of extensions available for saving a resource of a given type. @@ -30,7 +30,7 @@ - Save a resource to disk, to a given path. + Saves a resource to disk. diff --git a/doc/classes/Script.xml b/doc/classes/Script.xml index 837020e1cbc..a3d421e57e6 100644 --- a/doc/classes/Script.xml +++ b/doc/classes/Script.xml @@ -4,8 +4,8 @@ A class stored as a resource. - A class stored as a resource. The script exends the functionality of all objects that instance it. - The 'new' method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. + A class stored as a resource. A script exends the functionality of all objects that instance it. + The [code]new[/code] method of a script subclass creates a new instance. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. http://docs.godotengine.org/en/3.0/getting_started/step_by_step/scripting.html @@ -17,7 +17,7 @@ - Returns true if the script can be instanced. + Returns [code]true[/code] if the script can be instanced. @@ -31,6 +31,7 @@ + Returns the script's base type. @@ -39,14 +40,14 @@ - Returns true if the script, or a base class, defines a signal with the given name. + Returns [code]true[/code] if the script, or a base class, defines a signal with the given name. - Returns true if the script contains non-empty source code. + Returns [code]true[/code] if the script contains non-empty source code. @@ -55,14 +56,14 @@ - Returns true if 'base_object' is an instance of this script. + Returns [code]true[/code] if [code]base_object[/code] is an instance of this script. - Returns true if the script is a tool script. A tool script can run in the editor. + Returns [code]true[/code] if the script is a tool script. A tool script can run in the editor. @@ -77,7 +78,7 @@ - The script source code, or an empty string if source code is not available. When set, does not reload the class implementation automatically. + The script source code or an empty string if source code is not available. When set, does not reload the class implementation automatically. diff --git a/doc/classes/Shape.xml b/doc/classes/Shape.xml index 99377fb2414..825a3cd4ddd 100644 --- a/doc/classes/Shape.xml +++ b/doc/classes/Shape.xml @@ -4,7 +4,7 @@ Base class for all 3D shape resources. - Base class for all 3D shape resources. All 3D shapes that inherit from this can be set into a [PhysicsBody] or [Area]. + Base class for all 3D shape resources. Nodes that inherit from this can be used as shapes for a [PhysicsBody] or [Area] objects. http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 0d1972304d7..3c7f7920b4c 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -282,11 +282,11 @@ World space (global) [Transform] of this node. - Rotation part of the local transformation, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle), in radians. - Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three indepdent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. + Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). + Note that in the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a [Vector3] data structure not because the rotation is a vector, but only because [Vector3] exists as a convenient data-structure to store 3 floating point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful. - Rotation part of the local transformation, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle), in degrees. + Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X-angle, Y-angle, Z-angle). Scale part of the local transformation. @@ -298,7 +298,7 @@ Local translation of this node. - Visibility of this node. Toggles if this node is rendered. + If [code]true[/code] this node is drawn. Default value: [code]true[/code]. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index df61d8b87f7..3beba3e64c6 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1541,7 +1541,7 @@ - Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, + Returns [code]true[/code] if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc, @@ -3025,7 +3025,7 @@ - Sets a boot image. The color defines the background color and if scale is [code]true[/code], the image will be scaled to fit the screen size. + Sets a boot image. The color defines the background color and if scale is [code]true[/code] the image will be scaled to fit the screen size. @@ -3354,7 +3354,7 @@ - If [code]true[/code], sets internal processes to shrink all image data to half the size. + If [code]true[/code] sets internal processes to shrink all image data to half the size. @@ -3376,7 +3376,7 @@ - If [code]true[/code], the image will be stored in the texture's images array if overwritten. + If [code]true[/code] the image will be stored in the texture's images array if overwritten. @@ -3469,7 +3469,7 @@ - If [code]true[/code], sets the viewport active, else sets it inactive. + If [code]true[/code] sets the viewport active, else sets it inactive. @@ -3528,7 +3528,7 @@ - If [code]true[/code] a viewport's 3D rendering should be disabled. + If [code]true[/code] a viewport's 3D rendering is disabled. @@ -3539,7 +3539,7 @@ - If [code]true[/code] rendering of a viewport's environment should be disabled. + If [code]true[/code] rendering of a viewport's environment is disabled. @@ -3561,7 +3561,7 @@ - If [code]true[/code] the viewport should render to hdr. + If [code]true[/code] the viewport renders to hdr. @@ -3572,7 +3572,7 @@ - If [code]true[/code] the viewport's canvas should not be rendered. + If [code]true[/code] the viewport's canvas is not rendered. @@ -3664,7 +3664,7 @@ - If [code]true[/code] the viewport should render its background as transparent. + If [code]true[/code] the viewport renders its background as transparent. @@ -3675,7 +3675,7 @@ - Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE_* constants for options. + Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options. @@ -3686,7 +3686,7 @@ - Sets what should be rendered in the viewport. See VIEWPORT_USAGE_* constants for options. + Sets the viewport's 2D/3D mode. See [enum ViewportUsage] constants for options. @@ -3697,7 +3697,7 @@ - If [code]true[/code] the viewport should use augmented or virtual reality technologies. See [ARVRInterface]. + If [code]true[/code] the viewport uses augmented or virtual reality technologies. See [ARVRInterface]. @@ -3708,7 +3708,7 @@ - If [code]true[/code] the viewport's rendering should be flipped vertically. + If [code]true[/code] the viewport's rendering is flipped vertically.