diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/AcceptDialog.xml | 4 | ||||
| -rw-r--r-- | doc/classes/AnimationTree.xml | 2 | ||||
| -rw-r--r-- | doc/classes/AudioStreamPlaybackPolyphonic.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Color.xml | 2 | ||||
| -rw-r--r-- | doc/classes/ConfirmationDialog.xml | 4 | ||||
| -rw-r--r-- | doc/classes/Curve3D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Light3D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Marshalls.xml | 2 | ||||
| -rw-r--r-- | doc/classes/OS.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Object.xml | 2 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 2 | ||||
| -rw-r--r-- | doc/classes/TextEdit.xml | 2 | ||||
| -rw-r--r-- | doc/classes/TileSet.xml | 2 |
13 files changed, 15 insertions, 15 deletions
diff --git a/doc/classes/AcceptDialog.xml b/doc/classes/AcceptDialog.xml index 4da9e41ca8..c0e5d6ad07 100644 --- a/doc/classes/AcceptDialog.xml +++ b/doc/classes/AcceptDialog.xml @@ -53,7 +53,7 @@ <return type="void" /> <param index="0" name="button" type="Control" /> <description> - Removes the [param button] from the dialog. Does NOT free the [param button]. The [param button] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [param button] will no longer emit this dialog's [signal custom_action] or [signal cancelled] signals. + Removes the [param button] from the dialog. Does NOT free the [param button]. The [param button] must be a [Button] added with [method add_button] or [method add_cancel_button] method. After removal, pressing the [param button] will no longer emit this dialog's [signal custom_action] or [signal canceled] signals. </description> </method> </methods> @@ -81,7 +81,7 @@ <member name="wrap_controls" type="bool" setter="set_wrap_controls" getter="is_wrapping_controls" overrides="Window" default="true" /> </members> <signals> - <signal name="cancelled"> + <signal name="canceled"> <description> Emitted when the dialog is closed or the button created with [method add_cancel_button] is pressed. </description> diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index a17a727d7e..49bc4ee6af 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -104,7 +104,7 @@ </member> <member name="root_motion_track" type="NodePath" setter="set_root_motion_track" getter="get_root_motion_track" default="NodePath("")"> The path to the Animation track used for root motion. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. To specify a track that controls properties or bones, append its name after the path, separated by [code]":"[/code]. For example, [code]"character/skeleton:ankle"[/code] or [code]"character/mesh:transform/local"[/code]. - If the track has type [constant Animation.TYPE_POSITION_3D], [constant Animation.TYPE_ROTATION_3D] or [constant Animation.TYPE_SCALE_3D] the transformation will be cancelled visually, and the animation will appear to stay in place. See also [method get_root_motion_position], [method get_root_motion_rotation], [method get_root_motion_scale] and [RootMotionView]. + If the track has type [constant Animation.TYPE_POSITION_3D], [constant Animation.TYPE_ROTATION_3D] or [constant Animation.TYPE_SCALE_3D] the transformation will be canceled visually, and the animation will appear to stay in place. See also [method get_root_motion_position], [method get_root_motion_rotation], [method get_root_motion_scale] and [RootMotionView]. </member> <member name="tree_root" type="AnimationNode" setter="set_tree_root" getter="get_tree_root"> The root animation node of this [AnimationTree]. See [AnimationNode]. diff --git a/doc/classes/AudioStreamPlaybackPolyphonic.xml b/doc/classes/AudioStreamPlaybackPolyphonic.xml index 35ab05058a..8b0951153b 100644 --- a/doc/classes/AudioStreamPlaybackPolyphonic.xml +++ b/doc/classes/AudioStreamPlaybackPolyphonic.xml @@ -24,7 +24,7 @@ <param index="3" name="pitch_scale" type="float" default="1.0" /> <description> Play an [AudioStream] at a given offset, volume and pitch scale. Playback starts immediately. - The return value is an unique integer ID that is associated to this playback stream and which can be used to controll it. + The return value is an unique integer ID that is associated to this playback stream and which can be used to control it. This ID becomes invalid when the stream ends (if it does not loop), when the [AudioStreamPlaybackPolyphonic] is stopped, or when [method stop_stream] is called. This function returns [constant INVALID_ID] if the amount of streams currently playing equals [member AudioStreamPolyphonic.polyphony]. If you need a higher amount of maximum polyphony, raise this value. </description> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index d1387d088d..57278d9241 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -101,7 +101,7 @@ <return type="Color" /> <param index="0" name="over" type="Color" /> <description> - Returns a new color resulting from overlaying this color over the given color. In a painting program, you can imagine it as the [param over] color painted over this colour (including alpha). + Returns a new color resulting from overlaying this color over the given color. In a painting program, you can imagine it as the [param over] color painted over this color (including alpha). [codeblocks] [gdscript] var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50% diff --git a/doc/classes/ConfirmationDialog.xml b/doc/classes/ConfirmationDialog.xml index 48b4df9126..ac2ea5be17 100644 --- a/doc/classes/ConfirmationDialog.xml +++ b/doc/classes/ConfirmationDialog.xml @@ -8,10 +8,10 @@ To get cancel action, you can use: [codeblocks] [gdscript] - get_cancel_button().pressed.connect(self.cancelled) + get_cancel_button().pressed.connect(self.canceled) [/gdscript] [csharp] - GetCancelButton().Pressed += Cancelled; + GetCancelButton().Pressed += Canceled; [/csharp] [/codeblocks] </description> diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index 362d792b39..72ac95a700 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -198,7 +198,7 @@ <param index="1" name="tolerance_length" type="float" default="0.2" /> <description> Returns a list of points along the curve, with almost uniform density. [param max_stages] controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care! - [param tolerance_length] controls the maximal distance between two neighbouring points, before the segment has to be subdivided. + [param tolerance_length] controls the maximal distance between two neighboring points, before the segment has to be subdivided. </description> </method> </methods> diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml index fe7756faaf..95c39d535e 100644 --- a/doc/classes/Light3D.xml +++ b/doc/classes/Light3D.xml @@ -80,7 +80,7 @@ A typical household lightbulb can range from around 600 lumens to 1,200 lumens, a candle is about 13 lumens, while a streetlight can be approximately 60,000 lumens. </member> <member name="light_intensity_lux" type="float" setter="set_param" getter="get_param"> - Used by [DirectionalLight3D]s when [member ProjectSettings.rendering/lights_and_shadows/use_physical_light_units] is [code]true[/code]. Sets the intensity of the light source measured in Lux. Lux is a measure pf luminous flux per unit area, it is equal to one lumen per square metre. Lux is the measure of how much light hits a surface at a given time. + Used by [DirectionalLight3D]s when [member ProjectSettings.rendering/lights_and_shadows/use_physical_light_units] is [code]true[/code]. Sets the intensity of the light source measured in Lux. Lux is a measure of luminous flux per unit area, it is equal to one lumen per square meter. Lux is the measure of how much light hits a surface at a given time. On a clear sunny day a surface in direct sunlight may be approximately 100,000 lux, a typical room in a home may be approximately 50 lux, while the moonlit ground may be approximately 0.1 lux. </member> <member name="light_negative" type="bool" setter="set_negative" getter="is_negative" default="false"> diff --git a/doc/classes/Marshalls.xml b/doc/classes/Marshalls.xml index 102e4b75ed..1eeb0be7ce 100644 --- a/doc/classes/Marshalls.xml +++ b/doc/classes/Marshalls.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Marshalls" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - Data transformation (marshalling) and encoding helpers. + Data transformation (marshaling) and encoding helpers. </brief_description> <description> Provides data transformation and encoding utility functions. diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 1bc81ffb42..0058bf8a2f 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -566,7 +566,7 @@ <method name="open_midi_inputs"> <return type="void" /> <description> - Initialises the singleton for the system MIDI driver. + Initializes the singleton for the system MIDI driver. [b]Note:[/b] This method is implemented on Linux, macOS and Windows. </description> </method> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index a9e17f4666..1a805007e6 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -883,7 +883,7 @@ <param index="0" name="name" type="StringName" /> <param index="1" name="value" type="Variant" /> <description> - Adds or changes the entry [param name] inside the object's metadata. The metadata [param value] can be any [Variant], although some types cannot be serialised correctly. + Adds or changes the entry [param name] inside the object's metadata. The metadata [param value] can be any [Variant], although some types cannot be serialized correctly. If [param value] is [code]null[/code], the entry is removed. This is the equivalent of using [method remove_meta]. See also [method has_meta] and [method get_meta]. [b]Note:[/b] Metadata that has a [param name] starting with an underscore ([code]_[/code]) is considered editor-only. Editor-only metadata is not displayed in the Inspector dock and should not be edited. </description> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index be272976f4..ec05be368c 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -385,7 +385,7 @@ When set to [code]warn[/code] or [code]error[/code], produces a warning or an error respectively when an [code]assert[/code] call always evaluates to true. </member> <member name="debug/gdscript/warnings/confusable_identifier" type="int" setter="" getter="" default="1"> - When set to [code]warn[/code] or [code]error[/code], produces a warning or an error respectively when an indentifier contains characters that can be confused with something else, like when mixing different alphabets. + When set to [code]warn[/code] or [code]error[/code], produces a warning or an error respectively when an identifier contains characters that can be confused with something else, like when mixing different alphabets. </member> <member name="debug/gdscript/warnings/constant_used_as_function" type="int" setter="" getter="" default="1"> When set to [code]warn[/code] or [code]error[/code], produces a warning or an error respectively when a constant is used as a function. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 1efd0f9326..ccd79cd170 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -696,7 +696,7 @@ <method name="merge_overlapping_carets"> <return type="void" /> <description> - Merges any overlapping carets. Will favour the newest caret, or the caret with a selection. + Merges any overlapping carets. Will favor the newest caret, or the caret with a selection. [b]Note:[/b] This is not called when a caret changes position but after certain actions, so it is possible to get into a state where carets overlap. </description> </method> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 7fc6ba8161..a812b52307 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -589,7 +589,7 @@ <param index="0" name="terrain_set" type="int" /> <param index="1" name="mode" type="int" enum="TileSet.TerrainMode" /> <description> - Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighbouring tiles' terrains. + Sets a terrain mode. Each mode determines which bits of a tile shape is used to match the neighboring tiles' terrains. </description> </method> </methods> |