From 4c716f362378c18db05dc5c09f878d2aa3c7dd98 Mon Sep 17 00:00:00 2001 From: Andreas Haas Date: Sat, 14 Oct 2017 12:45:26 +0200 Subject: [PATCH] [DOCS] Fix a few typos. --- doc/classes/ARVRInterface.xml | 2 +- doc/classes/ARVRServer.xml | 2 +- doc/classes/AudioEffectDistortion.xml | 2 +- doc/classes/AudioStreamPlayer3D.xml | 4 ++-- doc/classes/CheckBox.xml | 2 +- doc/classes/EditorImportPlugin.xml | 2 +- doc/classes/EditorResourcePreview.xml | 2 +- doc/classes/EditorSelection.xml | 2 +- doc/classes/EditorSpatialGizmo.xml | 2 +- doc/classes/FileDialog.xml | 6 +++--- doc/classes/HTTPRequest.xml | 2 +- doc/classes/ItemList.xml | 4 ++-- doc/classes/JSONParseResult.xml | 2 +- doc/classes/NinePatchRect.xml | 2 +- doc/classes/Object.xml | 4 ++-- doc/classes/Physics2DShapeQueryParameters.xml | 2 +- doc/classes/RayCast.xml | 2 +- doc/classes/RayCast2D.xml | 2 +- doc/classes/Spatial.xml | 8 ++++---- doc/classes/StyleBoxFlat.xml | 6 +++--- doc/classes/Transform.xml | 4 ++-- doc/classes/Transform2D.xml | 2 +- doc/classes/Tween.xml | 8 ++++---- doc/classes/VideoPlayer.xml | 4 ++-- doc/classes/Viewport.xml | 4 ++-- doc/classes/VisualScript.xml | 2 +- doc/classes/WeakRef.xml | 2 +- scene/resources/style_box.cpp | 2 +- 28 files changed, 44 insertions(+), 44 deletions(-) diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index 1c2e761b578..9aed6c96ef7 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -94,7 +94,7 @@ - Initialise/uninitilise this interface (same effect as calling intialize/uninitialize). + Initialize/uninitialize this interface (same effect as calling initialize/uninitialize). diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 86bfe88ea9a..5e1055d568c 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -178,7 +178,7 @@ Used internally to filter trackers of any known type. - Used interally to select all trackers. + Used internally to select all trackers. diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index 1a6aa1d2b64..8b970e675ef 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -5,7 +5,7 @@ Modify the sound to make it dirty. - Modify the sound and make it dirty. Differents types available : clip, tan, lofi (bit crushing), overdrive, or waveshape. + Modify the sound and make it dirty. Different types are available : clip, tan, lofi (bit crushing), overdrive, or waveshape. By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently. diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 52914af9fc5..84f6792ef0f 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -310,7 +310,7 @@ Sets the absolute maximum of the soundlevel, in dB. - Sets the distance from wich the 'out_of_range_mode' takes effect. Has no effect if set to 0. + Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. Decides if audio should pause when source is outside of 'max_distance' range. @@ -355,7 +355,7 @@ Disables doppler tracking. - Executes doppler trackin in idle step. + Executes doppler tracking in idle step. Executes doppler tracking in physics step. diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index 6258eb503fb..50b431e00cf 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -4,7 +4,7 @@ Binary choice user interface widget - A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'. + A checkbox allows the user to make a binary choice (choosing only one of two possible options), for example Answer 'yes' or 'no'. diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 05319e926ce..da8f0f235b6 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -35,7 +35,7 @@ func get_preset_name(i): return "Default" - func get_import_optons(i): + func get_import_options(i): return [{"name": "my_option", "default_value": false}] func load(src, dst, opts, r_platform_variants, r_gen_files): diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index acf36b6a089..5174d9243b3 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -1,7 +1,7 @@ - Helper to generate previews of reources or files. + Helper to generate previews of resources or files. This object is used to generate previews for resources of files. diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index 8d9bdd2c053..a6dc60ee7b5 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -31,7 +31,7 @@ - Get the list of selectes nodes. + Get the list of selected nodes. diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index baab995fab6..545eadeed24 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -96,7 +96,7 @@ - Commit a handle being edited (handles must have been prevously added by [method add_handles]). + Commit a handle being edited (handles must have been previously added by [method add_handles]). If the cancel parameter is true, an option to restore the edited value to the original is provided. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index d7a08368a5f..b3d131ca407 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -86,7 +86,7 @@ - Return true if the diaog allows show hidden files. + Return true if the dialog allows show hidden files. @@ -205,10 +205,10 @@ The dialog allows the selection of file and directory. - The dialog allows ascess files under [Resource] path(res://) . + The dialog allows access files under [Resource] path(res://) . - The dialog allows ascess files in whole file system. + The dialog allows access files in whole file system. diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index c2839890cf8..b780d29d0e8 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -166,7 +166,7 @@ Request does not have a response(yet). - Request exceded its maximum size limit, see [method set_body_size_limit]. + Request exceeded its maximum size limit, see [method set_body_size_limit]. Request failed. (unused) diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index a8d879888f3..37c1db51f5c 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -217,7 +217,7 @@ - Returns whether the tooptip is enabled for specified item index. + Returns whether the tooltip is enabled for specified item index. @@ -511,7 +511,7 @@ - Fired when a multiple selection is altered on a list allowing mutliple selection. + Fired when a multiple selection is altered on a list allowing multiple selection. diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 86edaaf1e6b..db9a681896e 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -79,7 +79,7 @@ The error message if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants. - A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For exemple, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned. + A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned. [i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.[/i] [codeblock] p = JSON.parse('["hello", "world", "!"]') diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 6829b36e141..c74f3c5a68a 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -111,7 +111,7 @@ If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code] - The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values indivually to create panels with non-uniform borders. + The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. The height of the 9-slice's left column. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 67421487f17..d30ebfaef82 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -6,7 +6,7 @@ Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [method free] function from the script or delete from C++). - Some derivates add memory management, such as [Reference] (which keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. + Some derivatives add memory management, such as [Reference] (which keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [method _set]. However, scripting languages and C++ have simpler means to export them. Objects also receive notifications ([method _notification]). Notifications are a simple way to notify the object about simple events, so they can all be handled together. @@ -165,7 +165,7 @@ - Returns an [Array] of dictionaries with informations about signals that are connected to this object. + Returns an [Array] of dictionaries with information about signals that are connected to this object. Inside each [Dictionary] there are 3 fields: - "source" is a reference to signal emitter. - "signal_name" is name of connected signal. diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 78d12e0b732..d838ff23177 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -129,7 +129,7 @@ - Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. + Set the transformation matrix of the shape. This is necessary to set its position/rotation/scale. diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index b75b72b2182..3782a98e3e3 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -180,7 +180,7 @@ The ray's destination point, relative to the RayCast's [code]position[/code]. - The RayCast's collison layer(s). Only bodies in the same collision layer(s) will be detected. + The RayCast's collision layer(s). Only bodies in the same collision layer(s) will be detected. If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index a42d2ab5870..74ee0a8911b 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -195,7 +195,7 @@ The ray's destination point, relative to the RayCast's [code]position[/code]. - The RayCast2D's collison layer(s). Only bodies in the same collision layer(s) will be detected. + The RayCast2D's collision layer(s). Only bodies in the same collision layer(s) will be detected. If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 54eb82fbffc..abb0bfa246c 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -209,7 +209,7 @@ - Makes the node ignore its parents tranformations. Node tranformations are only in global space. + Makes the node ignore its parents transformations. Node transformations are only in global space. @@ -234,7 +234,7 @@ - Reset all tranformations for this node. Set its [Transform3D] to identity matrix. + Reset all transformations for this node. Set its [Transform3D] to identity matrix. @@ -329,7 +329,7 @@ - Tranforms [Vector3] "local_point" from this node's local space to world space. + Transforms [Vector3] "local_point" from this node's local space to world space. @@ -338,7 +338,7 @@ - Tranforms [Vector3] "global_point" from world space to this node's local space. + Transforms [Vector3] "global_point" from world space to this node's local space. diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index b09b9f0679f..756b7f92254 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -14,12 +14,12 @@ [codeblock] height = 30 corner_radius_top_left = 50 - corner_raidus_bottom_left = 100 + corner_radius_bottom_left = 100 [/codeblock] The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will [b]never[/b] be more than the height. Result: [codeblock] corner_radius_top_left: 10 - corner_raidus_bottom_left: 20 + corner_radius_bottom_left: 20 [/codeblock] @@ -268,7 +268,7 @@ - Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticable when using rounded corners. + Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners. This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 6780de19432..cd80d568e78 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -68,7 +68,7 @@ - Returns the inverse of the transfrom, under the assumption that the transformation is composed of rotation, scaling and translation. + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. @@ -104,7 +104,7 @@ - Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. + Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 0e39505ac38..76b9b0e8459 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -112,7 +112,7 @@ - Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. + Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index c90ac095574..23229aec4a7 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -12,7 +12,7 @@ tween.start() [/codeblock] Some of the methods of this class require a property name. You can get the property name by hovering over the property in the inspector of the editor. - Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the beginning, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best. + Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best. @@ -135,7 +135,7 @@ - Call [code]callback[/code] of [code]object[/code] after [code]duration[/code] on the main thread (similar to [methog Object.call_deferred). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + Call [code]callback[/code] of [code]object[/code] after [code]duration[/code] on the main thread (similar to [method Object.call_deferred]). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. @@ -158,7 +158,7 @@ - Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. + Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. @@ -346,7 +346,7 @@ - Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. + Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index bac7d1e3b05..5387ec30b37 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -22,7 +22,7 @@ - Get the amount of miliseconds to store in buffer while playing. + Get the amount of milliseconds to store in buffer while playing. @@ -126,7 +126,7 @@ - Set the amount of miliseconds to buffer during playback. + Set the amount of milliseconds to buffer during playback. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 2cf36ba69bb..58626356bfa 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -192,14 +192,14 @@ - Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. + Returns the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. - Returs whether there are shown modals on-screen. + Returns whether there are shown modals on-screen. diff --git a/doc/classes/VisualScript.xml b/doc/classes/VisualScript.xml index e44547cd8ff..8961ff1564f 100644 --- a/doc/classes/VisualScript.xml +++ b/doc/classes/VisualScript.xml @@ -4,7 +4,7 @@ A script implemented in the Visual Script programming environment. - A script implemented in the Visual Script programming environment. The script exends the functionality of all objects that instance it. + A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. You are most likely to use this class via the Visual Script editor or when writing plugins for it. diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml index 1071a40c3b1..23629881d38 100644 --- a/doc/classes/WeakRef.xml +++ b/doc/classes/WeakRef.xml @@ -4,7 +4,7 @@ Holds an [Object], but does not contribute to the reference count if the object is a reference. - A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. + A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. diff --git a/scene/resources/style_box.cpp b/scene/resources/style_box.cpp index b8a0a7864ef..f4a9abc1ead 100644 --- a/scene/resources/style_box.cpp +++ b/scene/resources/style_box.cpp @@ -765,7 +765,7 @@ void StyleBoxFlat::_bind_methods() { ClassDB::bind_method(D_METHOD("set_border_blend", "blend"), &StyleBoxFlat::set_border_blend); ClassDB::bind_method(D_METHOD("get_border_blend"), &StyleBoxFlat::get_border_blend); - ClassDB::bind_method(D_METHOD("set_corner_radius_individual", "radius_top_left", "radius_top_right", "radius_botton_right", "radius_bottom_left"), &StyleBoxFlat::set_corner_radius_individual); + ClassDB::bind_method(D_METHOD("set_corner_radius_individual", "radius_top_left", "radius_top_right", "radius_bottom_right", "radius_bottom_left"), &StyleBoxFlat::set_corner_radius_individual); ClassDB::bind_method(D_METHOD("set_corner_radius_all", "radius"), &StyleBoxFlat::set_corner_radius_all); ClassDB::bind_method(D_METHOD("set_corner_radius", "corner", "radius"), &StyleBoxFlat::set_corner_radius);