mirror of
https://github.com/godotengine/godot
synced 2024-09-05 17:19:44 +00:00
[doc] Fix grammar in class docs: amount vs. number
Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
This commit is contained in:
parent
dbd1524362
commit
28e66882e5
|
@ -139,7 +139,7 @@
|
|||
<return type="AABB" />
|
||||
<param index="0" name="by" type="float" />
|
||||
<description>
|
||||
Returns a copy of the [AABB] grown a given amount of units towards all the sides.
|
||||
Returns a copy of the [AABB] grown a given number of units towards all the sides.
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_no_surface" qualifiers="const">
|
||||
|
|
|
@ -349,7 +349,7 @@
|
|||
<return type="int" />
|
||||
<param index="0" name="track_idx" type="int" />
|
||||
<description>
|
||||
Returns the amount of keys in a given track.
|
||||
Returns the number of keys in a given track.
|
||||
</description>
|
||||
</method>
|
||||
<method name="track_get_key_time" qualifiers="const">
|
||||
|
|
|
@ -166,7 +166,7 @@
|
|||
The voice's filter rate.
|
||||
</member>
|
||||
<member name="voice_count" type="int" setter="set_voice_count" getter="get_voice_count" default="2">
|
||||
The amount of voices in the effect.
|
||||
The number of voices in the effect.
|
||||
</member>
|
||||
<member name="wet" type="float" setter="set_wet" getter="get_wet" default="0.5">
|
||||
The effect's processed signal.
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
<return type="int" />
|
||||
<param index="0" name="bus_idx" type="int" />
|
||||
<description>
|
||||
Returns the amount of channels of the bus at index [param bus_idx].
|
||||
Returns the number of channels of the bus at index [param bus_idx].
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bus_effect">
|
||||
|
|
|
@ -46,7 +46,7 @@
|
|||
<method name="get_true_bit_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of bitmap elements that are set to [code]true[/code].
|
||||
Returns the number of bitmap elements that are set to [code]true[/code].
|
||||
</description>
|
||||
</method>
|
||||
<method name="grow_mask">
|
||||
|
|
|
@ -86,7 +86,7 @@
|
|||
<param index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
|
||||
<param index="3" name="texture" type="Texture2D" default="null" />
|
||||
<description>
|
||||
Draws a colored polygon of any amount of points, convex or concave. Unlike [method draw_polygon], a single color must be specified for the whole polygon.
|
||||
Draws a colored polygon of any number of points, convex or concave. Unlike [method draw_polygon], a single color must be specified for the whole polygon.
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_dashed_line">
|
||||
|
@ -211,7 +211,7 @@
|
|||
<param index="2" name="uvs" type="PackedVector2Array" default="PackedVector2Array()" />
|
||||
<param index="3" name="texture" type="Texture2D" default="null" />
|
||||
<description>
|
||||
Draws a solid polygon of any amount of points, convex or concave. Unlike [method draw_colored_polygon], each point's color can be changed individually. See also [method draw_polyline] and [method draw_polyline_colors].
|
||||
Draws a solid polygon of any number of points, convex or concave. Unlike [method draw_colored_polygon], each point's color can be changed individually. See also [method draw_polyline] and [method draw_polyline_colors].
|
||||
</description>
|
||||
</method>
|
||||
<method name="draw_polyline">
|
||||
|
|
|
@ -482,7 +482,7 @@
|
|||
Prefixes to trigger an automatic indent.
|
||||
</member>
|
||||
<member name="indent_size" type="int" setter="set_indent_size" getter="get_indent_size" default="4">
|
||||
Size of tabs, if [code]indent_use_spaces[/code] is enabled the amount of spaces to use.
|
||||
Size of tabs, if [code]indent_use_spaces[/code] is enabled the number of spaces to use.
|
||||
</member>
|
||||
<member name="indent_use_spaces" type="bool" setter="set_indent_using_spaces" getter="is_indent_using_spaces" default="false">
|
||||
Use spaces instead of tabs for indentation.
|
||||
|
|
|
@ -176,7 +176,7 @@
|
|||
<method name="get_downloaded_bytes" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of bytes this HTTPRequest downloaded.
|
||||
Returns the number of bytes this HTTPRequest downloaded.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_http_client_status" qualifiers="const">
|
||||
|
|
|
@ -101,7 +101,7 @@
|
|||
<method name="get_surface_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of surfaces that the mesh holds.
|
||||
Returns the number of surfaces that the mesh holds.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_surface_format" qualifiers="const">
|
||||
|
@ -115,7 +115,7 @@
|
|||
<return type="int" />
|
||||
<param index="0" name="surface_idx" type="int" />
|
||||
<description>
|
||||
Returns the amount of lods that the mesh holds on a given surface.
|
||||
Returns the number of lods that the mesh holds on a given surface.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_surface_lod_indices" qualifiers="const">
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
<method name="get_line_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of lines of text the Label has.
|
||||
Returns the number of lines of text the Label has.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_line_height" qualifiers="const">
|
||||
|
@ -62,7 +62,7 @@
|
|||
</member>
|
||||
<member name="mouse_filter" type="int" setter="set_mouse_filter" getter="get_mouse_filter" overrides="Control" enum="Control.MouseFilter" default="2" />
|
||||
<member name="percent_visible" type="float" setter="set_percent_visible" getter="get_percent_visible" default="1.0">
|
||||
Limits the amount of visible characters. If you set [code]percent_visible[/code] to 0.5, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box.
|
||||
Limits the number of visible characters. If you set [code]percent_visible[/code] to 0.5, only up to half of the text's characters will display on screen. Useful to animate the text in a dialog box.
|
||||
[b]Note:[/b] Setting this property updates [member visible_characters] based on current [method get_total_character_count].
|
||||
</member>
|
||||
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" overrides="Control" default="4" />
|
||||
|
|
|
@ -29,7 +29,7 @@
|
|||
<method name="get_point_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of points in the line.
|
||||
Returns the number of points in the line.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_point_position" qualifiers="const">
|
||||
|
|
|
@ -183,7 +183,7 @@
|
|||
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
|
||||
</member>
|
||||
<member name="max_length" type="int" setter="set_max_length" getter="get_max_length" default="0">
|
||||
Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit.
|
||||
Maximum number of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit.
|
||||
When a limit is defined, characters that would exceed [member max_length] are truncated. This happens both for existing [member text] contents when setting the max length, or for new text inserted in the [LineEdit], including pasting. If any input text is truncated, the [signal text_change_rejected] signal is emitted with the truncated substring as parameter.
|
||||
[b]Example:[/b]
|
||||
[codeblocks]
|
||||
|
@ -417,7 +417,7 @@
|
|||
The caret's width in pixels. Greater values can be used to improve accessibility by ensuring the caret is easily visible, or to ensure consistency with a large font size.
|
||||
</theme_item>
|
||||
<theme_item name="minimum_character_width" data_type="constant" type="int" default="4">
|
||||
Minimum horizontal space for the text (not counting the clear button and content margins). This value is measured in count of 'M' characters (i.e. this amount of 'M' characters can be displayed without scrolling).
|
||||
Minimum horizontal space for the text (not counting the clear button and content margins). This value is measured in count of 'M' characters (i.e. this number of 'M' characters can be displayed without scrolling).
|
||||
</theme_item>
|
||||
<theme_item name="outline_size" data_type="constant" type="int" default="0">
|
||||
The size of the text outline.
|
||||
|
|
|
@ -103,7 +103,7 @@
|
|||
<description>
|
||||
Calculate a [ConvexPolygonShape3D] from the mesh.
|
||||
If [param clean] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed.
|
||||
If [param simplify] is [code]true[/code], the geometry can be further simplified to reduce the amount of vertices. Disabled by default.
|
||||
If [param simplify] is [code]true[/code], the geometry can be further simplified to reduce the number of vertices. Disabled by default.
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_outline" qualifiers="const">
|
||||
|
@ -142,7 +142,7 @@
|
|||
<method name="get_surface_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of surfaces that the [Mesh] holds.
|
||||
Returns the number of surfaces that the [Mesh] holds.
|
||||
</description>
|
||||
</method>
|
||||
<method name="surface_get_arrays" qualifiers="const">
|
||||
|
|
|
@ -20,7 +20,7 @@
|
|||
<description>
|
||||
This helper creates a [StaticBody3D] child node with a [ConvexPolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing.
|
||||
If [param clean] is [code]true[/code] (default), duplicate and interior vertices are removed automatically. You can set it to [code]false[/code] to make the process faster if not needed.
|
||||
If [param simplify] is [code]true[/code], the geometry can be further simplified to reduce the amount of vertices. Disabled by default.
|
||||
If [param simplify] is [code]true[/code], the geometry can be further simplified to reduce the number of vertices. Disabled by default.
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_debug_tangents">
|
||||
|
|
|
@ -5,7 +5,7 @@
|
|||
</brief_description>
|
||||
<description>
|
||||
[MultiMeshInstance3D] is a specialized node to instance [GeometryInstance3D]s based on a [MultiMesh] resource.
|
||||
This is useful to optimize the rendering of a high amount of instances of a given mesh (for example trees in a forest or grass strands).
|
||||
This is useful to optimize the rendering of a high number of instances of a given mesh (for example trees in a forest or grass strands).
|
||||
</description>
|
||||
<tutorials>
|
||||
<link title="Animating thousands of fish with MultiMeshInstance">$DOCS_URL/tutorials/performance/vertex_animation/animating_thousands_of_fish.html</link>
|
||||
|
|
|
@ -6,7 +6,7 @@
|
|||
<description>
|
||||
This class is responsible for creating and clearing 3D navigation meshes used as [NavigationMesh] resources inside [NavigationRegion3D]. The [NavigationMeshGenerator] has very limited to no use for 2D as the navigation mesh baking process expects 3D node types and 3D source geometry to parse.
|
||||
The entire navigation mesh baking is best done in a separate thread as the voxelization, collision tests and mesh optimization steps involved are very performance and time hungry operations.
|
||||
Navigation mesh baking happens in multiple steps and the result depends on 3D source geometry and properties of the [NavigationMesh] resource. In the first step, starting from a root node and depending on [NavigationMesh] properties all valid 3D source geometry nodes are collected from the [SceneTree]. Second, all collected nodes are parsed for their relevant 3D geometry data and a combined 3D mesh is build. Due to the many different types of parsable objects, from normal [MeshInstance3D]s to [CSGShape3D]s or various [CollisionObject3D]s, some operations to collect geometry data can trigger [RenderingServer] and [PhysicsServer3D] synchronizations. Server synchronization can have a negative effect on baking time or framerate as it often involves [Mutex] locking for thread security. Many parsable objects and the continuous synchronization with other threaded Servers can increase the baking time significantly. On the other hand only a few but very large and complex objects will take some time to prepare for the Servers which can noticeably stall the next frame render. As a general rule the total amount of parsable objects and their individual size and complexity should be balanced to avoid framerate issues or very long baking times. The combined mesh is then passed to the Recast Navigation Object to test the source geometry for walkable terrain suitable to [NavigationMesh] agent properties by creating a voxel world around the meshes bounding area.
|
||||
Navigation mesh baking happens in multiple steps and the result depends on 3D source geometry and properties of the [NavigationMesh] resource. In the first step, starting from a root node and depending on [NavigationMesh] properties all valid 3D source geometry nodes are collected from the [SceneTree]. Second, all collected nodes are parsed for their relevant 3D geometry data and a combined 3D mesh is build. Due to the many different types of parsable objects, from normal [MeshInstance3D]s to [CSGShape3D]s or various [CollisionObject3D]s, some operations to collect geometry data can trigger [RenderingServer] and [PhysicsServer3D] synchronizations. Server synchronization can have a negative effect on baking time or framerate as it often involves [Mutex] locking for thread security. Many parsable objects and the continuous synchronization with other threaded Servers can increase the baking time significantly. On the other hand only a few but very large and complex objects will take some time to prepare for the Servers which can noticeably stall the next frame render. As a general rule the total number of parsable objects and their individual size and complexity should be balanced to avoid framerate issues or very long baking times. The combined mesh is then passed to the Recast Navigation Object to test the source geometry for walkable terrain suitable to [NavigationMesh] agent properties by creating a voxel world around the meshes bounding area.
|
||||
The finalized navigation mesh is then returned and stored inside the [NavigationMesh] for use as a resource inside [NavigationRegion3D] nodes.
|
||||
[b]Note:[/b] Using meshes to not only define walkable surfaces but also obstruct navigation baking does not always work. The navigation baking has no concept of what is a geometry "inside" when dealing with mesh source geometry and this is intentional. Depending on current baking parameters, as soon as the obstructing mesh is large enough to fit a navigation mesh area inside, the baking will generate navigation mesh areas that are inside the obstructing source geometry mesh.
|
||||
</description>
|
||||
|
|
|
@ -553,7 +553,7 @@
|
|||
<param index="0" name="body" type="RID" />
|
||||
<param index="1" name="amount" type="int" />
|
||||
<description>
|
||||
Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
|
||||
Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies. This is enabled by setting the maximum number of contacts reported to a number greater than 0.
|
||||
</description>
|
||||
</method>
|
||||
<method name="body_set_mode">
|
||||
|
@ -882,7 +882,7 @@
|
|||
Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision.
|
||||
</constant>
|
||||
<constant name="SPACE_PARAM_SOLVER_ITERATIONS" value="8" enum="SpaceParameter">
|
||||
Constant to set/get the number of solver iterations for all contacts and constraints. The greater the amount of iterations, the more accurate the collisions will be. However, a greater amount of iterations requires more CPU power, which can decrease performance.
|
||||
Constant to set/get the number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance.
|
||||
</constant>
|
||||
<constant name="SHAPE_WORLD_BOUNDARY" value="0" enum="ShapeType">
|
||||
This is the constant for creating world boundary shapes. A world boundary shape is an [i]infinite[/i] line with an origin point, and a normal. Thus, it can be used for front/behind checks.
|
||||
|
|
|
@ -549,7 +549,7 @@
|
|||
<param index="0" name="body" type="RID" />
|
||||
<param index="1" name="amount" type="int" />
|
||||
<description>
|
||||
Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0.
|
||||
Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies. This is enabled by setting the maximum number of contacts reported to a number greater than 0.
|
||||
</description>
|
||||
</method>
|
||||
<method name="body_set_mode">
|
||||
|
@ -1422,7 +1422,7 @@
|
|||
Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time.
|
||||
</constant>
|
||||
<constant name="SPACE_PARAM_SOLVER_ITERATIONS" value="7" enum="SpaceParameter">
|
||||
Constant to set/get the number of solver iterations for contacts and constraints. The greater the amount of iterations, the more accurate the collisions and constraints will be. However, a greater amount of iterations requires more CPU power, which can decrease performance.
|
||||
Constant to set/get the number of solver iterations for contacts and constraints. The greater the number of iterations, the more accurate the collisions and constraints will be. However, a greater number of iterations requires more CPU power, which can decrease performance.
|
||||
</constant>
|
||||
<constant name="BODY_AXIS_LINEAR_X" value="1" enum="BodyAxis">
|
||||
</constant>
|
||||
|
|
|
@ -344,7 +344,7 @@
|
|||
Path to logs within the project. Using an [code]user://[/code] path is recommended.
|
||||
</member>
|
||||
<member name="debug/file_logging/max_log_files" type="int" setter="" getter="" default="5">
|
||||
Specifies the maximum amount of log files allowed (used for rotation).
|
||||
Specifies the maximum number of log files allowed (used for rotation).
|
||||
</member>
|
||||
<member name="debug/gdscript/warnings/assert_always_false" type="int" setter="" getter="" default="1">
|
||||
If [code]enabled[/code], prints a warning or an error when an [code]assert[/code] call always returns false.
|
||||
|
@ -466,7 +466,7 @@
|
|||
Maximum call stack allowed for debugging GDScript.
|
||||
</member>
|
||||
<member name="debug/settings/profiler/max_functions" type="int" setter="" getter="" default="16384">
|
||||
Maximum amount of functions per frame allowed when profiling.
|
||||
Maximum number of functions per frame allowed when profiling.
|
||||
</member>
|
||||
<member name="debug/settings/stdout/print_fps" type="bool" setter="" getter="" default="false">
|
||||
Print frames per second to standard output every second.
|
||||
|
@ -1468,13 +1468,13 @@
|
|||
Default edge connection margin for 3D navigation maps. See [method NavigationServer3D.map_set_edge_connection_margin].
|
||||
</member>
|
||||
<member name="network/limits/debugger/max_chars_per_second" type="int" setter="" getter="" default="32768">
|
||||
Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
|
||||
Maximum number of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
|
||||
</member>
|
||||
<member name="network/limits/debugger/max_errors_per_second" type="int" setter="" getter="" default="400">
|
||||
Maximum number of errors allowed to be sent from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
|
||||
</member>
|
||||
<member name="network/limits/debugger/max_queued_messages" type="int" setter="" getter="" default="2048">
|
||||
Maximum amount of messages in the debugger queue. Over this value, content is dropped. This helps to limit the debugger memory usage.
|
||||
Maximum number of messages in the debugger queue. Over this value, content is dropped. This helps to limit the debugger memory usage.
|
||||
</member>
|
||||
<member name="network/limits/debugger/max_warnings_per_second" type="int" setter="" getter="" default="400">
|
||||
Maximum number of warnings allowed to be sent from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
|
||||
|
@ -1565,7 +1565,7 @@
|
|||
Individual shapes can have a specific bias value (see [member Shape2D.custom_solver_bias]).
|
||||
</member>
|
||||
<member name="physics/2d/solver/solver_iterations" type="int" setter="" getter="" default="16">
|
||||
Number of solver iterations for all contacts and constraints. The greater the amount of iterations, the more accurate the collisions will be. However, a greater amount of iterations requires more CPU power, which can decrease performance. See [constant PhysicsServer2D.SPACE_PARAM_SOLVER_ITERATIONS].
|
||||
Number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance. See [constant PhysicsServer2D.SPACE_PARAM_SOLVER_ITERATIONS].
|
||||
</member>
|
||||
<member name="physics/2d/time_before_sleep" type="float" setter="" getter="" default="0.5">
|
||||
Time (in seconds) of inactivity before which a 2D physics body will put to sleep. See [constant PhysicsServer2D.SPACE_PARAM_BODY_TIME_TO_SLEEP].
|
||||
|
@ -1633,7 +1633,7 @@
|
|||
Individual shapes can have a specific bias value (see [member Shape3D.custom_solver_bias]).
|
||||
</member>
|
||||
<member name="physics/3d/solver/solver_iterations" type="int" setter="" getter="" default="16">
|
||||
Number of solver iterations for all contacts and constraints. The greater the amount of iterations, the more accurate the collisions will be. However, a greater amount of iterations requires more CPU power, which can decrease performance. See [constant PhysicsServer3D.SPACE_PARAM_SOLVER_ITERATIONS].
|
||||
Number of solver iterations for all contacts and constraints. The greater the number of iterations, the more accurate the collisions will be. However, a greater number of iterations requires more CPU power, which can decrease performance. See [constant PhysicsServer3D.SPACE_PARAM_SOLVER_ITERATIONS].
|
||||
</member>
|
||||
<member name="physics/3d/time_before_sleep" type="float" setter="" getter="" default="0.5">
|
||||
Time (in seconds) of inactivity before which a 3D physics body will put to sleep. See [constant PhysicsServer3D.SPACE_PARAM_BODY_TIME_TO_SLEEP].
|
||||
|
@ -1836,7 +1836,7 @@
|
|||
Max number of omnilights and spotlights renderable per object. At the default value of 8, this means that each surface can be affected by up to 8 omnilights and 8 spotlights. This is further limited by hardware support and [member rendering/limits/opengl/max_renderable_lights]. Setting this low will slightly reduce memory usage, may decrease shader compile times, and may result in faster rendering on low-end, mobile, or web devices.
|
||||
</member>
|
||||
<member name="rendering/limits/opengl/max_renderable_elements" type="int" setter="" getter="" default="65536">
|
||||
Max amount of elements renderable in a frame. If more elements than this are visible per frame, they will not be drawn. Keep in mind elements refer to mesh surfaces and not meshes themselves. Setting this low will slightly reduce memory usage and may decrease shader compile times, particularly on web. For most uses, the default value is suitable, but consider lowering as much as possible on web export.
|
||||
Max number of elements renderable in a frame. If more elements than this are visible per frame, they will not be drawn. Keep in mind elements refer to mesh surfaces and not meshes themselves. Setting this low will slightly reduce memory usage and may decrease shader compile times, particularly on web. For most uses, the default value is suitable, but consider lowering as much as possible on web export.
|
||||
</member>
|
||||
<member name="rendering/limits/opengl/max_renderable_lights" type="int" setter="" getter="" default="32">
|
||||
Max number of positional lights renderable in a frame. If more lights than this number are used, they will be ignored. Setting this low will slightly reduce memory usage and may decrease shader compile times, particularly on web. For most uses, the default value is suitable, but consider lowering as much as possible on web export.
|
||||
|
|
|
@ -71,7 +71,7 @@
|
|||
<param index="0" name="to" type="Quaternion" />
|
||||
<description>
|
||||
Returns the angle between this quaternion and [param to]. This is the magnitude of the angle you would need to rotate by to get from one to the other.
|
||||
[b]Note:[/b] This method has an abnormally high amount of floating-point error, so methods such as [code]is_zero_approx[/code] will not work reliably.
|
||||
[b]Note:[/b] This method has an abnormally high number of floating-point errors, so methods such as [code]is_zero_approx[/code] will not work reliably.
|
||||
</description>
|
||||
</method>
|
||||
<method name="dot" qualifiers="const">
|
||||
|
|
|
@ -50,7 +50,7 @@
|
|||
[b]Note:[/b] [member mesh_lod_threshold] does not affect [GeometryInstance3D] visibility ranges (also known as "manual" LOD or hierarchical LOD).
|
||||
</member>
|
||||
<member name="origin_offset" type="Vector3" setter="set_origin_offset" getter="get_origin_offset" default="Vector3(0, 0, 0)">
|
||||
Sets the origin offset to be used when this [ReflectionProbe] is in [member box_projection] mode. This can be set to a non-zero value to ensure a reflection fits a rectangle-shaped room, while reducing the amount of objects that "get in the way" of the reflection.
|
||||
Sets the origin offset to be used when this [ReflectionProbe] is in [member box_projection] mode. This can be set to a non-zero value to ensure a reflection fits a rectangle-shaped room, while reducing the number of objects that "get in the way" of the reflection.
|
||||
</member>
|
||||
<member name="update_mode" type="int" setter="set_update_mode" getter="get_update_mode" enum="ReflectionProbe.UpdateMode" default="0">
|
||||
Sets how frequently the [ReflectionProbe] is updated. Can be [constant UPDATE_ONCE] or [constant UPDATE_ALWAYS].
|
||||
|
|
|
@ -1801,7 +1801,7 @@
|
|||
<param index="1" name="longitudes" type="int" />
|
||||
<param index="2" name="radius" type="float" />
|
||||
<description>
|
||||
Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
|
||||
Returns a mesh of a sphere with the given number of horizontal and vertical subdivisions.
|
||||
</description>
|
||||
</method>
|
||||
<method name="material_create">
|
||||
|
|
|
@ -90,7 +90,7 @@
|
|||
<method name="get_bone_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of bones in the skeleton.
|
||||
Returns the number of bones in the skeleton.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_bone_global_pose" qualifiers="const">
|
||||
|
|
|
@ -121,7 +121,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="ccdik_data_chain_length" type="int" setter="set_ccdik_data_chain_length" getter="get_ccdik_data_chain_length" default="0">
|
||||
The amount of CCDIK joints in the CCDIK modification.
|
||||
The number of CCDIK joints in the CCDIK modification.
|
||||
</member>
|
||||
<member name="target_nodepath" type="NodePath" setter="set_target_node" getter="get_target_node" default="NodePath("")">
|
||||
The NodePath to the node that is the target for the CCDIK modification. This node is what the CCDIK chain will attempt to rotate the bone chain to.
|
||||
|
|
|
@ -77,7 +77,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="fabrik_data_chain_length" type="int" setter="set_fabrik_data_chain_length" getter="get_fabrik_data_chain_length" default="0">
|
||||
The amount of FABRIK joints in the FABRIK modification.
|
||||
The number of FABRIK joints in the FABRIK modification.
|
||||
</member>
|
||||
<member name="target_nodepath" type="NodePath" setter="set_target_node" getter="get_target_node" default="NodePath("")">
|
||||
The NodePath to the node that is the target for the FABRIK modification. This node is what the FABRIK chain will attempt to rotate the bone chain to.
|
||||
|
|
|
@ -50,7 +50,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="physical_bone_chain_length" type="int" setter="set_physical_bone_chain_length" getter="get_physical_bone_chain_length" default="0">
|
||||
The amount of [PhysicalBone2D] nodes linked in this modification.
|
||||
The number of [PhysicalBone2D] nodes linked in this modification.
|
||||
</member>
|
||||
</members>
|
||||
</class>
|
||||
|
|
|
@ -121,7 +121,7 @@
|
|||
</methods>
|
||||
<members>
|
||||
<member name="ccdik_data_chain_length" type="int" setter="set_ccdik_data_chain_length" getter="get_ccdik_data_chain_length" default="0">
|
||||
The amount of CCDIK joints in the CCDIK modification.
|
||||
The number of CCDIK joints in the CCDIK modification.
|
||||
</member>
|
||||
<member name="high_quality_solve" type="bool" setter="set_use_high_quality_solve" getter="get_use_high_quality_solve" default="true">
|
||||
When true, the CCDIK algorithm will perform a higher quality solve that returns more natural results. A high quality solve requires more computation power to solve though, and therefore can be disabled to save performance.
|
||||
|
|
|
@ -79,7 +79,7 @@
|
|||
When true, the modification's in the stack will be called. This is handled automatically through the [Skeleton3D] node.
|
||||
</member>
|
||||
<member name="modification_count" type="int" setter="set_modification_count" getter="get_modification_count" default="0">
|
||||
The amount of modifications in the stack.
|
||||
The number of modifications in the stack.
|
||||
</member>
|
||||
<member name="strength" type="float" setter="set_strength" getter="get_strength" default="1.0">
|
||||
The interpolation strength of the modifications in stack. A value of [code]0[/code] will make it where the modifications are not applied, a strength of [code]0.5[/code] will be half applied, and a strength of [code]1[/code] will allow the modifications to be fully applied and override the skeleton bone poses.
|
||||
|
|
|
@ -37,14 +37,14 @@
|
|||
<method name="get_available_bytes" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of bytes this [StreamPeer] has available.
|
||||
Returns the number of bytes this [StreamPeer] has available.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_data">
|
||||
<return type="Array" />
|
||||
<param index="0" name="bytes" type="int" />
|
||||
<description>
|
||||
Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the [param bytes] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array.
|
||||
Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the [param bytes] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_double">
|
||||
|
@ -63,7 +63,7 @@
|
|||
<return type="Array" />
|
||||
<param index="0" name="bytes" type="int" />
|
||||
<description>
|
||||
Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array.
|
||||
Returns a chunk data with the received bytes. The number of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_string">
|
||||
|
|
|
@ -440,7 +440,7 @@
|
|||
<method name="length" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the string's amount of characters.
|
||||
Returns the number of characters in the string.
|
||||
</description>
|
||||
</method>
|
||||
<method name="lpad" qualifiers="const">
|
||||
|
@ -522,7 +522,7 @@
|
|||
# Last digit will be rounded up here, which reduces total digit count since
|
||||
# trailing zeros are removed:
|
||||
String.num(42.129999, 5) # "42.13"
|
||||
# If `decimals` is not specified, the total amount of significant digits is 14:
|
||||
# If `decimals` is not specified, the total number of significant digits is 14:
|
||||
String.num(-0.0000012345432123454321) # "-0.00000123454321"
|
||||
String.num(-10000.0000012345432123454321) # "-10000.0000012345"
|
||||
[/codeblock]
|
||||
|
|
|
@ -161,7 +161,7 @@
|
|||
<method name="get_gutter_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the total amount of gutters registered.
|
||||
Returns the number of gutters registered.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_gutter_name" qualifiers="const">
|
||||
|
@ -189,7 +189,7 @@
|
|||
<return type="int" />
|
||||
<param index="0" name="line" type="int" />
|
||||
<description>
|
||||
Returns the amount of spaces and [code]tab * tab_size[/code] before the first char.
|
||||
Returns the number of spaces and [code]tab * tab_size[/code] before the first char.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_last_full_visible_line" qualifiers="const">
|
||||
|
@ -235,7 +235,7 @@
|
|||
<method name="get_line_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the amount of total lines in the text.
|
||||
Returns the number of lines in the text.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_line_gutter_icon" qualifiers="const">
|
||||
|
@ -329,7 +329,7 @@
|
|||
<method name="get_minimap_visible_lines" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the total amount of lines that can be draw on the minimap.
|
||||
Returns the number of lines that may be drawn on the minimap.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_next_visible_line_index_offset_from" qualifiers="const">
|
||||
|
@ -444,7 +444,7 @@
|
|||
<method name="get_total_visible_line_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the total amount of lines that could be draw.
|
||||
Returns the number of lines that may be drawn.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_version" qualifiers="const">
|
||||
|
|
|
@ -77,7 +77,7 @@
|
|||
<description>
|
||||
Triggers an update of the TileMap. If [param layer] is provided, only updates the given layer.
|
||||
[b]Note:[/b] The TileMap node updates automatically when one of its properties is modified. A manual update is only needed if runtime modifications (implemented in [method _tile_data_runtime_update]) need to be applied.
|
||||
[b]Warning:[/b] Updating the TileMap is a performance demanding task. Limit occurrences of those updates to the minimum and limit the amount tiles they impact (by segregating tiles updated often to a dedicated layer for example).
|
||||
[b]Warning:[/b] Updating the TileMap is computationally expensive and may impact performance. Try to limit the number of updates and the tiles they impact (by placing frequently updated tiles in a dedicated layer for example).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_cell_alternative_tile" qualifiers="const">
|
||||
|
|
|
@ -68,7 +68,7 @@
|
|||
<method name="_get_input_port_count" qualifiers="virtual const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Override this method to define the amount of input ports of the associated custom node.
|
||||
Override this method to define the number of input ports of the associated custom node.
|
||||
Defining this method is [b]required[/b]. If not overridden, the node has no input ports.
|
||||
</description>
|
||||
</method>
|
||||
|
@ -98,7 +98,7 @@
|
|||
<method name="_get_output_port_count" qualifiers="virtual const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Override this method to define the amount of output ports of the associated custom node.
|
||||
Override this method to define the number of output ports of the associated custom node.
|
||||
Defining this method is [b]required[/b]. If not overridden, the node has no output ports.
|
||||
</description>
|
||||
</method>
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
A custom visual shader graph expression written in Godot Shading Language.
|
||||
</brief_description>
|
||||
<description>
|
||||
Custom Godot Shading Language expression, with a custom amount of input and output ports.
|
||||
Custom Godot Shading Language expression, with a custom number of input and output ports.
|
||||
The provided code is directly injected into the graph's matching shader function ([code]vertex[/code], [code]fragment[/code], or [code]light[/code]), so it cannot be used to declare functions, varyings, uniforms, or global constants. See [VisualShaderNodeGlobalExpression] for such global definitions.
|
||||
</description>
|
||||
<tutorials>
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="VisualShaderNodeGroupBase" inherits="VisualShaderNodeResizableBase" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
||||
<brief_description>
|
||||
Base class for a family of nodes with variable amount of input and output ports within the visual shader graph.
|
||||
Base class for a family of nodes with variable number of input and output ports within the visual shader graph.
|
||||
</brief_description>
|
||||
<description>
|
||||
Currently, has no direct usage, use the derived classes instead.
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
<method name="get_attribute_count" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Gets the amount of attributes in the current element.
|
||||
Gets the number of attributes in the current element.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_attribute_name" qualifiers="const">
|
||||
|
|
Loading…
Reference in a new issue