mirror of
https://github.com/godotengine/godot.git
synced 2024-11-22 12:12:28 +00:00
[DOCS] Fix a few typos.
This commit is contained in:
Andreas Haas
parent
9876bad05c
commit
4c716f3623
@ -94,7 +94,7 @@
|
||||
<argument index="0" name="initialized" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
Initialise/uninitilise this interface (same effect as calling intialize/uninitialize).
|
||||
Initialize/uninitialize this interface (same effect as calling initialize/uninitialize).
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_is_primary">
|
||||
|
||||
@ -178,7 +178,7 @@
|
||||
Used internally to filter trackers of any known type.
|
||||
</constant>
|
||||
<constant name="TRACKER_ANY" value="255">
|
||||
Used interally to select all trackers.
|
||||
Used internally to select all trackers.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
Modify the sound to make it dirty.
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<tutorials>
|
||||
|
||||
@ -310,7 +310,7 @@
|
||||
Sets the absolute maximum of the soundlevel, in dB.
|
||||
</member>
|
||||
<member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance">
|
||||
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.
|
||||
</member>
|
||||
<member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode">
|
||||
Decides if audio should pause when source is outside of 'max_distance' range.
|
||||
@ -355,7 +355,7 @@
|
||||
Disables doppler tracking.
|
||||
</constant>
|
||||
<constant name="DOPPLER_TRACKING_IDLE_STEP" value="1">
|
||||
Executes doppler trackin in idle step.
|
||||
Executes doppler tracking in idle step.
|
||||
</constant>
|
||||
<constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2">
|
||||
Executes doppler tracking in physics step.
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
Binary choice user interface widget
|
||||
</brief_description>
|
||||
<description>
|
||||
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'.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
||||
@ -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):
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="EditorResourcePreview" inherits="Node" category="Core" version="3.0.alpha.custom_build">
|
||||
<brief_description>
|
||||
Helper to generate previews of reources or files.
|
||||
Helper to generate previews of resources or files.
|
||||
</brief_description>
|
||||
<description>
|
||||
This object is used to generate previews for resources of files.
|
||||
|
||||
@ -31,7 +31,7 @@
|
||||
<return type="Array">
|
||||
</return>
|
||||
<description>
|
||||
Get the list of selectes nodes.
|
||||
Get the list of selected nodes.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_transformable_selected_nodes">
|
||||
|
||||
@ -96,7 +96,7 @@
|
||||
<argument index="2" name="cancel" type="bool" default="false">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -86,7 +86,7 @@
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Return true if the diaog allows show hidden files.
|
||||
Return true if the dialog allows show hidden files.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_access">
|
||||
@ -205,10 +205,10 @@
|
||||
The dialog allows the selection of file and directory.
|
||||
</constant>
|
||||
<constant name="ACCESS_USERDATA" value="1">
|
||||
The dialog allows ascess files under [Resource] path(res://) .
|
||||
The dialog allows access files under [Resource] path(res://) .
|
||||
</constant>
|
||||
<constant name="ACCESS_FILESYSTEM" value="2">
|
||||
The dialog allows ascess files in whole file system.
|
||||
The dialog allows access files in whole file system.
|
||||
</constant>
|
||||
</constants>
|
||||
<theme_items>
|
||||
|
||||
@ -166,7 +166,7 @@
|
||||
Request does not have a response(yet).
|
||||
</constant>
|
||||
<constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7">
|
||||
Request exceded its maximum size limit, see [method set_body_size_limit].
|
||||
Request exceeded its maximum size limit, see [method set_body_size_limit].
|
||||
</constant>
|
||||
<constant name="RESULT_REQUEST_FAILED" value="8">
|
||||
Request failed. (unused)
|
||||
|
||||
@ -217,7 +217,7 @@
|
||||
<argument index="0" name="idx" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Returns whether the tooptip is enabled for specified item index.
|
||||
Returns whether the tooltip is enabled for specified item index.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_same_column_width" qualifiers="const">
|
||||
@ -511,7 +511,7 @@
|
||||
<argument index="1" name="selected" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</signal>
|
||||
</signals>
|
||||
|
||||
@ -79,7 +79,7 @@
|
||||
The error message if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants.
|
||||
</member>
|
||||
<member name="result" type="Variant" setter="set_result" getter="get_result">
|
||||
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", "!"]')
|
||||
|
||||
@ -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]
|
||||
</member>
|
||||
<member name="patch_margin_bottom" type="int" setter="set_patch_margin" getter="get_patch_margin">
|
||||
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.
|
||||
</member>
|
||||
<member name="patch_margin_left" type="int" setter="set_patch_margin" getter="get_patch_margin">
|
||||
The height of the 9-slice's left column.
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
@ -165,7 +165,7 @@
|
||||
<return type="Array">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
|
||||
@ -129,7 +129,7 @@
|
||||
<argument index="0" name="transform" type="Transform2D">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
@ -180,7 +180,7 @@
|
||||
The ray's destination point, relative to the RayCast's [code]position[/code].
|
||||
</member>
|
||||
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
|
||||
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.
|
||||
</member>
|
||||
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled">
|
||||
If [code]true[/code], collisions will be reported. Default value: [code]false[/code].
|
||||
|
||||
@ -195,7 +195,7 @@
|
||||
The ray's destination point, relative to the RayCast's [code]position[/code].
|
||||
</member>
|
||||
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
|
||||
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.
|
||||
</member>
|
||||
<member name="enabled" type="bool" setter="set_enabled" getter="is_enabled">
|
||||
If [code]true[/code], collisions will be reported. Default value: [code]false[/code].
|
||||
|
||||
@ -209,7 +209,7 @@
|
||||
<argument index="0" name="enable" type="bool">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_gizmo">
|
||||
@ -234,7 +234,7 @@
|
||||
<return type="void">
|
||||
</return>
|
||||
<description>
|
||||
Reset all tranformations for this node. Set its [Transform3D] to identity matrix.
|
||||
Reset all transformations for this node. Set its [Transform3D] to identity matrix.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_ignore_transform_notification">
|
||||
@ -329,7 +329,7 @@
|
||||
<argument index="0" name="local_point" type="Vector3">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="to_local" qualifiers="const">
|
||||
@ -338,7 +338,7 @@
|
||||
<argument index="0" name="global_point" type="Vector3">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="translate">
|
||||
|
||||
@ -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]
|
||||
</description>
|
||||
<tutorials>
|
||||
@ -268,7 +268,7 @@
|
||||
</methods>
|
||||
<members>
|
||||
<member name="anti_aliasing" type="bool" setter="set_anti_aliased" getter="is_anti_aliased">
|
||||
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.
|
||||
</member>
|
||||
<member name="anti_aliasing_size" type="int" setter="set_aa_size" getter="get_aa_size">
|
||||
This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect.
|
||||
|
||||
@ -68,7 +68,7 @@
|
||||
<return type="Transform">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="interpolate_with">
|
||||
@ -104,7 +104,7 @@
|
||||
<return type="Transform">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rotated">
|
||||
|
||||
@ -112,7 +112,7 @@
|
||||
<return type="Transform2D">
|
||||
</return>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="rotated">
|
||||
|
||||
@ -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.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
@ -135,7 +135,7 @@
|
||||
<argument index="7" name="arg5" type="Variant" default="null">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
<method name="interpolate_method">
|
||||
@ -158,7 +158,7 @@
|
||||
<argument index="7" name="delay" type="float" default="0">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
@ -346,7 +346,7 @@
|
||||
<argument index="8" name="delay" type="float" default="0">
|
||||
</argument>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
</method>
|
||||
|
||||
@ -22,7 +22,7 @@
|
||||
<return type="int">
|
||||
</return>
|
||||
<description>
|
||||
Get the amount of miliseconds to store in buffer while playing.
|
||||
Get the amount of milliseconds to store in buffer while playing.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_stream" qualifiers="const">
|
||||
@ -126,7 +126,7 @@
|
||||
<argument index="0" name="msec" type="int">
|
||||
</argument>
|
||||
<description>
|
||||
Set the amount of miliseconds to buffer during playback.
|
||||
Set the amount of milliseconds to buffer during playback.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_expand">
|
||||
|
||||
@ -192,14 +192,14 @@
|
||||
<return type="Variant">
|
||||
</return>
|
||||
<description>
|
||||
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].
|
||||
</description>
|
||||
</method>
|
||||
<method name="gui_has_modal_stack" qualifiers="const">
|
||||
<return type="bool">
|
||||
</return>
|
||||
<description>
|
||||
Returs whether there are shown modals on-screen.
|
||||
Returns whether there are shown modals on-screen.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_transparent_background" qualifiers="const">
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
A script implemented in the Visual Script programming environment.
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
Holds an [Object], but does not contribute to the reference count if the object is a reference.
|
||||
</brief_description>
|
||||
<description>
|
||||
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.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
|
||||
@ -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);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user