mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-01-18 20:40:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #30119 from akien-mga/doc-misc-updates

Browse Source 
doc: Complete and harmonize all _MAX constant descriptions, fix scoped hyperlinks
This commit is contained in:
Rémi Verschelde 2019-06-27 12:33:39 +02:00 committed by GitHub
commit 560f55da51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
46 changed files with 129 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/@GlobalScope.xml
View File

@ -968,7 +968,7 @@
Joypad Button 15
</constant>
<constant name="JOY_BUTTON_MAX" value="16" enum="JoystickList">
Joypad Button 16
Represents the maximum number of joystick buttons supported.
</constant>
<constant name="JOY_SONY_CIRCLE" value="1" enum="JoystickList">
DUALSHOCK circle button
@ -1090,6 +1090,7 @@
<constant name="JOY_AXIS_9" value="9" enum="JoystickList">
</constant>
<constant name="JOY_AXIS_MAX" value="10" enum="JoystickList">
Represents the maximum number of joystick axes supported.
</constant>
<constant name="JOY_ANALOG_LX" value="0" enum="JoystickList">
Joypad Left Stick Horizontal Axis
@ -1449,7 +1450,7 @@
Variable is of type [PoolColorArray].
</constant>
<constant name="TYPE_MAX" value="27" enum="Variant.Type">
Marker for end of type constants.
Represents the size of the [enum Variant.Type] enum.
</constant>
<constant name="OP_EQUAL" value="0" enum="Variant.Operator">
</constant>
@ -1502,6 +1503,7 @@
<constant name="OP_IN" value="24" enum="Variant.Operator">
</constant>
<constant name="OP_MAX" value="25" enum="Variant.Operator">
Represents the size of the [enum Variant.Operator] enum.
</constant>
</constants>
</class>

2
doc/classes/AStar.xml
View File

@ -5,7 +5,7 @@
</brief_description>
<description>
A* (A star) is a computer algorithm that is widely used in pathfinding and graph traversal, the process of plotting an efficiently directed path between multiple points. It enjoys widespread use due to its performance and accuracy. Godot's A* implementation make use of vectors as points.
You must add points manually with [method AStar.add_point] and create segments manually with [method AStar.connect_points]. So you can test if there is a path between two points with the [method AStar.are_points_connected] function, get the list of existing ids in the found path with [method AStar.get_id_path], or the points list with [method AStar.get_point_path].
You must add points manually with [method add_point] and create segments manually with [method connect_points]. So you can test if there is a path between two points with the [method are_points_connected] function, get the list of existing ids in the found path with [method get_id_path], or the points list with [method get_point_path].
</description>
<tutorials>
</tutorials>

2
doc/classes/Area.xml
View File

@ -136,7 +136,7 @@
The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.
</member>
<member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area.SpaceOverride">
Override mode for gravity and damping calculations within this area. See [enum Area.SpaceOverride] for possible values.
Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values.
</member>
</members>
<signals>

2
doc/classes/Area2D.xml
View File

@ -124,7 +124,7 @@
The area's priority. Higher priority areas are processed first. Default value: 0.
</member>
<member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area2D.SpaceOverride">
Override mode for gravity and damping calculations within this area. See [enum Area2D.SpaceOverride] for possible values.
Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values.
</member>
</members>
<signals>

1
doc/classes/ArrayMesh.xml
View File

@ -225,6 +225,7 @@
For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line.
</constant>
<constant name="ARRAY_MAX" value="9" enum="ArrayType">
Represents the size of the [enum ArrayType] enum.
</constant>
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat">
Array format will include vertices (mandatory).

1
doc/classes/AudioEffectPitchShift.xml
View File

@ -32,6 +32,7 @@
<constant name="FFT_SIZE_4096" value="4" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_MAX" value="5" enum="FFT_Size">
Represents the size of the [enum FFT_Size] enum.
</constant>
</constants>
</class>

1
doc/classes/AudioEffectSpectrumAnalyzer.xml
View File

@ -28,6 +28,7 @@
<constant name="FFT_SIZE_4096" value="4" enum="FFT_Size">
</constant>
<constant name="FFT_SIZE_MAX" value="5" enum="FFT_Size">
Represents the size of the [enum FFT_Size] enum.
</constant>
</constants>
</class>

2
doc/classes/AudioEffectSpectrumAnalyzerInstance.xml
View File

@ -22,8 +22,10 @@
</methods>
<constants>
<constant name="MAGNITUDE_AVERAGE" value="0" enum="MagnitudeMode">
Use the average value as magnitude.
</constant>
<constant name="MAGNITUDE_MAX" value="1" enum="MagnitudeMode">
Use the maximum value as magnitude.
</constant>
</constants>
</class>

6
doc/classes/ConeTwistJoint.xml
View File

@ -25,7 +25,7 @@
</member>
<member name="swing_span" type="float" setter="_set_swing_span" getter="_get_swing_span">
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
The swing span defines, how much rotation will not get corrected allong the swing axis.
The swing span defines, how much rotation will not get corrected along the swing axis.
Could be defined as looseness in the [ConeTwistJoint].
If below 0.05, this behavior is locked. Default value: [code]PI/4[/code].
</member>
@ -37,7 +37,7 @@
<constants>
<constant name="PARAM_SWING_SPAN" value="0" enum="Param">
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
The swing span defines, how much rotation will not get corrected allong the swing axis.
The swing span defines, how much rotation will not get corrected along the swing axis.
Could be defined as looseness in the [ConeTwistJoint].
If below 0.05, this behavior is locked. Default value: [code]PI/4[/code].
</constant>
@ -56,7 +56,7 @@
Defines, how fast the swing- and twist-speed-difference on both sides gets synced.
</constant>
<constant name="PARAM_MAX" value="5" enum="Param">
End flag of PARAM_* constants, used internally.
Represents the size of the [enum Param] enum.
</constant>
</constants>
</class>

1
doc/classes/EditorFeatureProfile.xml
View File

@ -124,6 +124,7 @@
<constant name="FEATURE_FILESYSTEM_DOCK" value="6" enum="Feature">
</constant>
<constant name="FEATURE_MAX" value="7" enum="Feature">
Represents the size of the [enum Feature] enum.
</constant>
</constants>
</class>

7
doc/classes/EditorPlugin.xml
View File

@ -292,7 +292,7 @@
<argument index="0" name="object" type="Object">
</argument>
<description>
Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method EditorPlugin.edit] and [method EditorPlugin.make_visible] called when the editor requests them. If you have declared the methods [method forward_canvas_gui_input] and [method forward_spatial_gui_input] these will be called too.
Implement this function if your plugin edits a specific type of object (Resource or Node). If you return [code]true[/code], then you will get the functions [method edit] and [method make_visible] called when the editor requests them. If you have declared the methods [method forward_canvas_gui_input] and [method forward_spatial_gui_input] these will be called too.
</description>
</method>
<method name="has_main_screen" qualifiers="virtual">
@ -455,7 +455,7 @@
<argument index="0" name="state" type="Dictionary">
</argument>
<description>
Restore the state saved by [method EditorPlugin.get_state].
Restore the state saved by [method get_state].
</description>
</method>
<method name="set_window_layout" qualifiers="virtual">
@ -464,7 +464,7 @@
<argument index="0" name="layout" type="ConfigFile">
</argument>
<description>
Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout].
Restore the plugin GUI layout saved by [method get_window_layout].
</description>
</method>
<method name="update_overlays" qualifiers="const">
@ -546,6 +546,7 @@
<constant name="DOCK_SLOT_RIGHT_BR" value="7" enum="DockSlot">
</constant>
<constant name="DOCK_SLOT_MAX" value="8" enum="DockSlot">
Represents the size of the [enum DockSlot] enum.
</constant>
</constants>
</class>

2
doc/classes/Environment.xml
View File

@ -273,7 +273,7 @@
Display a camera feed in the background.
</constant>
<constant name="BG_MAX" value="7" enum="BGMode">
Helper constant keeping track of the enum's size, has no direct usage in API calls.
Represents the size of the [enum BGMode] enum.
</constant>
<constant name="GLOW_BLEND_MODE_ADDITIVE" value="0" enum="GlowBlendMode">
Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.

1
doc/classes/GIProbe.xml
View File

@ -57,6 +57,7 @@
<constant name="SUBDIV_512" value="3" enum="Subdiv">
</constant>
<constant name="SUBDIV_MAX" value="4" enum="Subdiv">
Represents the size of the [enum Subdiv] enum.
</constant>
</constants>
</class>

4
doc/classes/Generic6DOFJoint.xml
View File

@ -293,7 +293,7 @@
Maximum acceleration for the motor at the axes.
</constant>
<constant name="PARAM_MAX" value="22" enum="Param">
End flag of PARAM_* constants, used internally.
Represents the size of the [enum Param] enum.
</constant>
<constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0" enum="Flag">
If [code]set[/code] there is linear motion possible within the given limits.
@ -311,7 +311,7 @@
<constant name="FLAG_ENABLE_LINEAR_MOTOR" value="5" enum="Flag">
</constant>
<constant name="FLAG_MAX" value="6" enum="Flag">
End flag of FLAG_* constants, used internally.
Represents the size of the [enum Flag] enum.
</constant>
</constants>
</class>

18
doc/classes/Geometry.xml
View File

@ -68,7 +68,7 @@
</argument>
<description>
Clips [code]polygon_a[/code] against [code]polygon_b[/code] and returns an array of clipped polygons. This performs [code]OPERATION_DIFFERENCE[/code] between polygons. Returns an empty array if [code]polygon_b[/code] completely overlaps [code]polygon_a[/code].
If [code]polygon_b[/code] is enclosed by [code]polygon_a[/code], returns an outer polygon (boundary) and inner polygon (hole) which could be distiguished by calling [method is_polygon_clockwise].
If [code]polygon_b[/code] is enclosed by [code]polygon_a[/code], returns an outer polygon (boundary) and inner polygon (hole) which could be distinguished by calling [method is_polygon_clockwise].
</description>
</method>
<method name="clip_polyline_with_polygon_2d">
@ -100,7 +100,7 @@
</argument>
<description>
Mutually excludes common area defined by intersection of [code]polygon_a[/code] and [code]polygon_b[/code] (see [method intersect_polygons_2d]) and returns an array of excluded polygons. This performs [code]OPERATION_XOR[/code] between polygons. In other words, returns all but common area between polygons.
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise].
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise].
</description>
</method>
<method name="get_closest_point_to_segment">
@ -202,7 +202,7 @@
</argument>
<description>
Intersects [code]polygon_a[/code] with [code]polygon_b[/code] and returns an array of intersected polygons. This performs [code]OPERATION_INTERSECTION[/code] between polygons. In other words, returns common area shared by polygons. Returns an empty array if no intersection occurs.
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise].
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise].
</description>
</method>
<method name="intersect_polyline_with_polygon_2d">
@ -269,7 +269,7 @@
</argument>
<description>
Merges (combines) [code]polygon_a[/code] and [code]polygon_b[/code] and returns an array of merged polygons. This performs [code]OPERATION_UNION[/code] between polygons.
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise].
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise].
</description>
</method>
<method name="offset_polygon_2d">
@ -283,8 +283,8 @@
</argument>
<description>
Inflates or deflates [code]polygon[/code] by [code]delta[/code] units (pixels). If [code]delta[/code] is positive, makes the polygon grow outward. If [code]delta[/code] is negative, shrinks the polygon inward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. Returns an empty array if [code]delta[/code] is negative and the absolute value of it approximately exceeds the minimum bounding rectangle dimensions of the polygon.
Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum Geometry.PolyJoinType].
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise].
Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType].
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise].
</description>
</method>
<method name="offset_polyline_2d">
@ -300,9 +300,9 @@
</argument>
<description>
Inflates or deflates [code]polyline[/code] by [code]delta[/code] units (pixels), producing polygons. If [code]delta[/code] is positive, makes the polyline grow outward. Returns an array of polygons because inflating/deflating may result in multiple discrete polygons. If [code]delta[/code] is negative, returns an empty array.
Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum Geometry.PolyJoinType].
Each polygon's endpoints will be rounded as determined by [code]end_type[/code], see [enum Geometry.PolyEndType].
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distiguished by calling [method is_polygon_clockwise].
Each polygon's vertices will be rounded as determined by [code]join_type[/code], see [enum PolyJoinType].
Each polygon's endpoints will be rounded as determined by [code]end_type[/code], see [enum PolyEndType].
The operation may result in an outer polygon (boundary) and inner polygon (hole) produced which could be distinguished by calling [method is_polygon_clockwise].
</description>
</method>
<method name="point_is_inside_triangle" qualifiers="const">

11
doc/classes/GeometryInstance.xml
View File

@ -15,13 +15,13 @@
<argument index="0" name="aabb" type="AABB">
</argument>
<description>
Overrides the bounding box of this node with a custom one. To remove it, set an AABB with all fields set to zero.
Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero.
</description>
</method>
</methods>
<members>
<member name="cast_shadow" type="int" setter="set_cast_shadows_setting" getter="get_cast_shadows_setting" enum="GeometryInstance.ShadowCastingSetting">
The selected shadow casting flag. See SHADOW_CASTING_SETTING_* constants for values.
The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.
</member>
<member name="extra_cull_margin" type="float" setter="set_extra_cull_margin" getter="get_extra_cull_margin">
The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.
@ -40,7 +40,7 @@
</member>
<member name="material_override" type="Material" setter="set_material_override" getter="get_material_override">
The material override for the whole geometry.
If there is a material in material_override, it will be used instead of any material set in any material slot of the mesh.
If there is a material in [code]material_override[/code], it will be used instead of any material set in any material slot of the mesh.
</member>
<member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag">
If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] and/or any other form of baked lighting.
@ -64,9 +64,12 @@
</constant>
<constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags">
Will allow the GeometryInstance to be used when baking lights using a [GIProbe] and/or any other form of baked lighting.
Added documentation for GeometryInstance and VisualInstance
</constant>
<constant name="FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="Flags">
Unused in this class, exposed for consistency with [enum VisualServer.InstanceFlags].
</constant>
<constant name="FLAG_MAX" value="2" enum="Flags">
Represents the size of the [enum Flags] enum.
</constant>
</constants>
</class>

2
doc/classes/HTTPClient.xml
View File

@ -211,7 +211,7 @@
HTTP PATCH method. The PATCH method is used to apply partial modifications to a resource.
</constant>
<constant name="METHOD_MAX" value="9" enum="Method">
Marker for end of [code]METHOD_*[/code] enum. Not used.
Represents the size of the [enum Method] enum.
</constant>
<constant name="STATUS_DISCONNECTED" value="0" enum="Status">
Status: Disconnected from the server.

4
doc/classes/HingeJoint.xml
View File

@ -66,7 +66,7 @@
Maximum acceleration for the motor.
</constant>
<constant name="PARAM_MAX" value="8" enum="Param">
End flag of PARAM_* constants, used internally.
Represents the size of the [enum Param] enum.
</constant>
<constant name="FLAG_USE_LIMIT" value="0" enum="Flag">
If [code]true[/code], the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects.
@ -75,7 +75,7 @@
When activated, a motor turns the hinge.
</constant>
<constant name="FLAG_MAX" value="2" enum="Flag">
End flag of FLAG_* constants, used internally.
Represents the size of the [enum Flag] enum.
</constant>
</constants>
</class>

1
doc/classes/Image.xml
View File

@ -590,6 +590,7 @@
Ericsson Texture Compression format 2 variant RGB8_PUNCHTHROUGH_ALPHA1, which compresses RGBA data to make alpha either fully transparent or fully opaque. Note that when creating an [ImageTexture], an sRGB to linear color space conversion is performed.
</constant>
<constant name="FORMAT_MAX" value="37" enum="Format">
Represents the size of the [enum Format] enum.
</constant>
<constant name="INTERPOLATE_NEAREST" value="0" enum="Interpolation">
</constant>

1
doc/classes/Light.xml
View File

@ -83,6 +83,7 @@
<constant name="PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14" enum="Param">
</constant>
<constant name="PARAM_MAX" value="15" enum="Param">
Represents the size of the [enum Param] enum.
</constant>
<constant name="BAKE_DISABLED" value="0" enum="BakeMode">
Light is ignored when baking. Note: hiding a light does [i]not[/i] affect baking.

2
doc/classes/Light2D.xml
View File

@ -58,7 +58,7 @@
If [code]true[/code], the Light2D will cast shadows. Default value: [code]false[/code].
</member>
<member name="shadow_filter" type="int" setter="set_shadow_filter" getter="get_shadow_filter" enum="Light2D.ShadowFilter">
Shadow filter type. Use [enum Light2D.ShadowFilter] constants as values. Default value: [code]SHADOW_FILTER_NONE[/code].
Shadow filter type. Use [enum ShadowFilter] constants as values. Default value: [constant SHADOW_FILTER_NONE].
</member>
<member name="shadow_filter_smooth" type="float" setter="set_shadow_smooth" getter="get_shadow_smooth">
Smoothing value for shadows.

3
doc/classes/LineEdit.xml
View File

@ -108,7 +108,7 @@
If [code]true[/code], the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened.
</member>
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" enum="Control.FocusMode">
Defines how the [LineEdit] can grab focus (Keyboard and mouse, only keyboard, or none). See [enum Control.FocusMode] in [Control] for details.
Defines how the [LineEdit] can grab focus (Keyboard and mouse, only keyboard, or none). See [enum Control.FocusMode] for details.
</member>
<member name="max_length" type="int" setter="set_max_length" getter="get_max_length">
Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit.
@ -181,6 +181,7 @@
Reverse the last undo action.
</constant>
<constant name="MENU_MAX" value="7" enum="MenuItems">
Represents the size of the [enum MenuItems] enum.
</constant>
</constants>
<theme_items>

2
doc/classes/Material.xml
View File

@ -18,8 +18,10 @@
</members>
<constants>
<constant name="RENDER_PRIORITY_MAX" value="127">
Maximum value for the [member render_priority] parameter.
</constant>
<constant name="RENDER_PRIORITY_MIN" value="-128">
Minimum value for the [member render_priority] parameter.
</constant>
</constants>
</class>

1
doc/classes/Mesh.xml
View File

@ -194,6 +194,7 @@
Array of indices.
</constant>
<constant name="ARRAY_MAX" value="9" enum="ArrayType">
Represents the size of the [enum ArrayType] enum.
</constant>
</constants>
</class>

2
doc/classes/Node.xml
View File

@ -163,7 +163,7 @@
</argument>
<description>
Duplicates the node, returning a new node.
You can fine-tune the behavior using the [code]flags[/code] (see [enum Node.DuplicateFlags]).
You can fine-tune the behavior using the [code]flags[/code] (see [enum DuplicateFlags]).
</description>
</method>
<method name="find_node" qualifiers="const">

6
doc/classes/OS.xml
View File

@ -163,7 +163,7 @@
<return type="int" enum="OS.VideoDriver">
</return>
<description>
Returns the currently used video driver, using one of the values from [enum OS.VideoDriver].
Returns the currently used video driver, using one of the values from [enum VideoDriver].
</description>
</method>
<method name="get_date" qualifiers="const">
@ -380,7 +380,7 @@
<argument index="0" name="dir" type="int" enum="OS.SystemDir">
</argument>
<description>
Returns the actual path to commonly used folders across different platforms. Available locations are specified in [enum OS.SystemDir].
Returns the actual path to commonly used folders across different platforms. Available locations are specified in [enum SystemDir].
</description>
</method>
<method name="get_system_time_msecs" qualifiers="const">
@ -477,7 +477,7 @@
<argument index="0" name="driver" type="int" enum="OS.VideoDriver">
</argument>
<description>
Returns the name of the video driver matching the given [code]driver[/code] index. This index is a value from [enum OS.VideoDriver], and you can use [method get_current_video_driver] to get the current backend's index.
Returns the name of the video driver matching the given [code]driver[/code] index. This index is a value from [enum VideoDriver], and you can use [method get_current_video_driver] to get the current backend's index.
</description>
</method>
<method name="get_virtual_keyboard_height">

34
doc/classes/Physics2DServer.xml
View File

@ -86,7 +86,7 @@
<argument index="1" name="param" type="int" enum="Physics2DServer.AreaParameter">
</argument>
<description>
Returns an area parameter value. A list of available parameters is on the AREA_PARAM_* constants.
Returns an area parameter value. See [enum AreaParameter] for a list of available parameters.
</description>
</method>
<method name="area_get_shape" qualifiers="const">
@ -230,7 +230,7 @@
<argument index="2" name="value" type="Variant">
</argument>
<description>
Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants.
Sets the value for an area parameter. See [enum AreaParameter] for a list of available parameters.
</description>
</method>
<method name="area_set_shape">
@ -291,7 +291,7 @@
<argument index="1" name="mode" type="int" enum="Physics2DServer.AreaSpaceOverrideMode">
</argument>
<description>
Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*.
Sets the space override mode for the area. See [enum AreaSpaceOverrideMode] for a list of available modes.
</description>
</method>
<method name="area_set_transform">
@ -431,7 +431,7 @@
<return type="RID">
</return>
<description>
Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time.
Creates a physics body.
</description>
</method>
<method name="body_get_canvas_instance_id" qualifiers="const">
@ -513,7 +513,7 @@
<argument index="1" name="param" type="int" enum="Physics2DServer.BodyParameter">
</argument>
<description>
Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM_* constants.
Returns the value of a body parameter. See [enum BodyParameter] for a list of available parameters.
</description>
</method>
<method name="body_get_shape" qualifiers="const">
@ -650,7 +650,7 @@
<argument index="1" name="mode" type="int" enum="Physics2DServer.CCDMode">
</argument>
<description>
Sets the continuous collision detection mode from any of the CCD_MODE_* constants.
Sets the continuous collision detection mode using one of the [enum CCDMode] constants.
Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided.
</description>
</method>
@ -688,7 +688,7 @@
<argument index="1" name="mode" type="int" enum="Physics2DServer.BodyMode">
</argument>
<description>
Sets the body mode, from one of the constants BODY_MODE*.
Sets the body mode using one of the [enum BodyMode] constants.
</description>
</method>
<method name="body_set_omit_force_integration">
@ -712,7 +712,7 @@
<argument index="2" name="value" type="float">
</argument>
<description>
Sets a body parameter. A list of available parameters is on the BODY_PARAM_* constants.
Sets a body parameter. See [enum BodyParameter] for a list of available parameters.
</description>
</method>
<method name="body_set_shape">
@ -803,7 +803,7 @@
<argument index="2" name="value" type="Variant">
</argument>
<description>
Sets a body state (see BODY_STATE* constants).
Sets a body state using one of the [enum BodyState] constants.
</description>
</method>
<method name="body_test_motion">
@ -885,7 +885,7 @@
<argument index="2" name="value" type="float">
</argument>
<description>
Sets a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants.
Sets a damped spring joint parameter. See [enum DampedStringParam] for a list of available parameters.
</description>
</method>
<method name="free_rid">
@ -903,7 +903,7 @@
<argument index="0" name="process_info" type="int" enum="Physics2DServer.ProcessInfo">
</argument>
<description>
Returns information about the current state of the 2D physics engine. The states are listed under the INFO_* constants.
Returns information about the current state of the 2D physics engine. See [enum ProcessInfo] for a list of available states.
</description>
</method>
<method name="groove_joint_create">
@ -920,7 +920,7 @@
<argument index="4" name="body_b" type="RID">
</argument>
<description>
Creates a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself.
Creates a groove joint between two bodies. If not specified, the bodies are assumed to be the joint itself.
</description>
</method>
<method name="joint_get_param" qualifiers="const">
@ -940,7 +940,7 @@
<argument index="0" name="joint" type="RID">
</argument>
<description>
Returns the type of a joint (see JOINT_* constants).
Returns the type of a joint (see [enum JointType]).
</description>
</method>
<method name="joint_set_param">
@ -953,7 +953,7 @@
<argument index="2" name="value" type="float">
</argument>
<description>
Sets a joint parameter. Parameters are explained in the JOINT_PARAM* constants.
Sets a joint parameter. See [enum JointParam] for a list of available parameters.
</description>
</method>
<method name="line_shape_create">
@ -1017,7 +1017,7 @@
<argument index="0" name="shape" type="RID">
</argument>
<description>
Returns the type of shape (see SHAPE_* constants).
Returns the type of shape (see [enum ShapeType]).
</description>
</method>
<method name="shape_set_data">
@ -1088,7 +1088,7 @@
<argument index="2" name="value" type="float">
</argument>
<description>
Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants.
Sets the value for a space parameter. See [enum SpaceParameter] for a list of available parameters.
</description>
</method>
</methods>
@ -1215,7 +1215,7 @@
Constant to set/get a body's angular dampening factor.
</constant>
<constant name="BODY_PARAM_MAX" value="7" enum="BodyParameter">
This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0.
Represents the size of the [enum BodyParameter] enum.
</constant>
<constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState">
Constant to set/get the current transform matrix of the body.

6
doc/classes/PhysicsServer.xml
View File

@ -910,7 +910,7 @@
<argument index="0" name="process_info" type="int" enum="PhysicsServer.ProcessInfo">
</argument>
<description>
Returns an Info defined by the [enum PhysicsServer.ProcessInfo] input given.
Returns an Info defined by the [enum ProcessInfo] input given.
</description>
</method>
<method name="hinge_joint_get_flag" qualifiers="const">
@ -1384,7 +1384,7 @@
The amount of damping of the rotation across axes orthogonal to the slider.
</constant>
<constant name="SLIDER_JOINT_MAX" value="22" enum="SliderJointParam">
End flag of SLIDER_JOINT_* constants, used internally.
Represents the size of the [enum SliderJointParam] enum.
</constant>
<constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0" enum="ConeTwistJointParam">
Swing is rotation from side to side, around the axis perpendicular to the twist axis.
@ -1566,7 +1566,7 @@
Constant to set/get a body's angular dampening factor.
</constant>
<constant name="BODY_PARAM_MAX" value="6" enum="BodyParameter">
This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0.
Represents the size of the [enum BodyParameter] enum.
</constant>
<constant name="BODY_STATE_TRANSFORM" value="0" enum="BodyState">
Constant to set/get the current transform matrix of the body.

5
doc/classes/ProceduralSky.xml
View File

@ -46,7 +46,7 @@
Color of the sun.
</member>
<member name="sun_curve" type="float" setter="set_sun_curve" getter="get_sun_curve">
How quickly the sun fades away between [member sun_angle_min] and [member sun_angle_max]
How quickly the sun fades away between [member sun_angle_min] and [member sun_angle_max].
</member>
<member name="sun_energy" type="float" setter="set_sun_energy" getter="get_sun_energy">
Amount of energy contribution from the sun.
@ -58,7 +58,7 @@
The direction of the sun using polar coordinates.
</member>
<member name="texture_size" type="int" setter="set_texture_size" getter="get_texture_size" enum="ProceduralSky.TextureSize">
Size of [Texture] that the ProceduralSky will generate.
Size of [Texture] that the ProceduralSky will generate. The size is set using [enum TextureSize].
</member>
</members>
<constants>
@ -73,6 +73,7 @@
<constant name="TEXTURE_SIZE_4096" value="4" enum="TextureSize">
</constant>
<constant name="TEXTURE_SIZE_MAX" value="5" enum="TextureSize">
Represents the size of the [enum TextureSize] enum.
</constant>
</constants>
</class>

13
doc/classes/ResourceImporter.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceImporter" inherits="Reference" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

8
doc/classes/Sky.xml
View File

@ -12,9 +12,9 @@
</methods>
<members>
<member name="radiance_size" type="int" setter="set_radiance_size" getter="get_radiance_size" enum="Sky.RadianceSize">
The Sky's radiance map size.
The higher the radiance map size, the more detailed the lighting from the Sky will be.
See RADIANCE_SIZE_* constants for values. Default size is RADIANCE_SIZE_512.
The [Sky]'s radiance map size.
The higher the radiance map size, the more detailed the lighting from the [Sky] will be.
See [enum RadianceSize] constants for values. Default size is [constant RADIANCE_SIZE_512].
</member>
</members>
<constants>
@ -40,7 +40,7 @@
Radiance texture size is 2048x2048 pixels.
</constant>
<constant name="RADIANCE_SIZE_MAX" value="7" enum="RadianceSize">
Radiance texture size is the largest size it can be.
Represents the size of the [enum RadianceSize] enum.
</constant>
</constants>
</class>

2
doc/classes/SliderJoint.xml
View File

@ -149,7 +149,7 @@
The amount of damping of the rotation across axes orthogonal to the slider.
</constant>
<constant name="PARAM_MAX" value="22" enum="Param">
End flag of PARAM_* constants, used internally.
Represents the size of the [enum Param] enum.
</constant>
</constants>
</class>

3
doc/classes/SpatialMaterial.xml
View File

@ -295,6 +295,7 @@
<constant name="TEXTURE_DETAIL_NORMAL" value="15" enum="TextureParam">
</constant>
<constant name="TEXTURE_MAX" value="16" enum="TextureParam">
Represents the size of the [enum TextureParam] enum.
</constant>
<constant name="DETAIL_UV_1" value="0" enum="DetailUV">
</constant>
@ -325,6 +326,7 @@
<constant name="FEATURE_DETAIL" value="11" enum="Feature">
</constant>
<constant name="FEATURE_MAX" value="12" enum="Feature">
Represents the size of the [enum Feature] enum.
</constant>
<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
Default blend mode.
@ -395,6 +397,7 @@
<constant name="FLAG_USE_SHADOW_TO_OPACITY" value="18" enum="Flags">
</constant>
<constant name="FLAG_MAX" value="19" enum="Flags">
Represents the size of the [enum Flags] enum.
</constant>
<constant name="DIFFUSE_BURLEY" value="0" enum="DiffuseMode">
Default diffuse scattering algorithm.

2
doc/classes/SpriteBase3D.xml
View File

@ -70,7 +70,7 @@
If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind.
</constant>
<constant name="FLAG_MAX" value="3" enum="DrawFlags">
Used internally to mark the end of the Flags section.
Represents the size of the [enum DrawFlags] enum.
</constant>
<constant name="ALPHA_CUT_DISABLED" value="0" enum="AlphaCutMode">
</constant>

2
doc/classes/StreamPeerTCP.xml
View File

@ -45,7 +45,7 @@
<return type="int" enum="StreamPeerTCP.Status">
</return>
<description>
Returns the status of the connection, see [enum StreamPeerTCP.Status].
Returns the status of the connection, see [enum Status].
</description>
</method>
<method name="is_connected_to_host" qualifiers="const">

2
doc/classes/Tabs.xml
View File

@ -234,6 +234,7 @@
Align the tabs to the right.
</constant>
<constant name="ALIGN_MAX" value="3" enum="TabAlign">
Represents the size of the [enum TabAlign] enum.
</constant>
<constant name="CLOSE_BUTTON_SHOW_NEVER" value="0" enum="CloseButtonDisplayPolicy">
</constant>
@ -242,6 +243,7 @@
<constant name="CLOSE_BUTTON_SHOW_ALWAYS" value="2" enum="CloseButtonDisplayPolicy">
</constant>
<constant name="CLOSE_BUTTON_MAX" value="3" enum="CloseButtonDisplayPolicy">
Represents the size of the [enum CloseButtonDisplayPolicy] enum.
</constant>
</constants>
<theme_items>

12
doc/classes/TileSet.xml
View File

@ -64,7 +64,7 @@
</argument>
<description>
Returns the bitmask of the subtile from an autotile given its coordinates.
The value is the sum of the values in [enum TileSet.AutotileBindings] present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right).
The value is the sum of the values in [enum AutotileBindings] present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right).
</description>
</method>
<method name="autotile_get_bitmask_mode" qualifiers="const">
@ -73,7 +73,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
Returns the [enum TileSet.BitmaskMode] of the autotile.
Returns the [enum BitmaskMode] of the autotile.
</description>
</method>
<method name="autotile_get_icon_coordinate" qualifiers="const">
@ -160,7 +160,7 @@
</argument>
<description>
Sets the bitmask of the subtile from an autotile given its coordinates.
The value is the sum of the values in [enum TileSet.AutotileBindings] present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right).
The value is the sum of the values in [enum AutotileBindings] present in the subtile (e.g. a value of 5 means the bitmask has bindings in both the top left and top right).
</description>
</method>
<method name="autotile_set_bitmask_mode">
@ -171,7 +171,7 @@
<argument index="1" name="mode" type="int" enum="TileSet.BitmaskMode">
</argument>
<description>
Sets the [enum TileSet.BitmaskMode] of the autotile.
Sets the [enum BitmaskMode] of the autotile.
</description>
</method>
<method name="autotile_set_icon_coordinate">
@ -503,7 +503,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
Returns the tile's [enum TileSet.TileMode].
Returns the tile's [enum TileMode].
</description>
</method>
<method name="tile_get_z_index" qualifiers="const">
@ -719,7 +719,7 @@
<argument index="1" name="tilemode" type="int" enum="TileSet.TileMode">
</argument>
<description>
Sets the tile's [enum TileSet.TileMode].
Sets the tile's [enum TileMode].
</description>
</method>
<method name="tile_set_z_index">

4
doc/classes/Viewport.xml
View File

@ -331,7 +331,7 @@
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_1024" value="6" enum="ShadowAtlasQuadrantSubdiv">
</constant>
<constant name="SHADOW_ATLAS_QUADRANT_SUBDIV_MAX" value="7" enum="ShadowAtlasQuadrantSubdiv">
Enum limiter. Do not use it directly.
Represents the size of the [enum ShadowAtlasQuadrantSubdiv] enum.
</constant>
<constant name="RENDER_INFO_OBJECTS_IN_FRAME" value="0" enum="RenderInfo">
Amount of objects in frame.
@ -352,7 +352,7 @@
Amount of draw calls in frame.
</constant>
<constant name="RENDER_INFO_MAX" value="6" enum="RenderInfo">
Enum limiter. Do not use it directly.
Represents the size of the [enum RenderInfo] enum.
</constant>
<constant name="DEBUG_DRAW_DISABLED" value="0" enum="DebugDraw">
Objects are displayed normally.

1
doc/classes/VisibilityEnabler.xml
View File

@ -26,6 +26,7 @@
This enabler will freeze [RigidBody] nodes.
</constant>
<constant name="ENABLER_MAX" value="2" enum="Enabler">
Represents the size of the [enum Enabler] enum.
</constant>
</constants>
</class>

1
doc/classes/VisibilityEnabler2D.xml
View File

@ -49,6 +49,7 @@
<constant name="ENABLER_PAUSE_ANIMATED_SPRITES" value="5" enum="Enabler">
</constant>
<constant name="ENABLER_MAX" value="6" enum="Enabler">
Represents the size of the [enum Enabler] enum.
</constant>
</constants>
</class>

20
doc/classes/VisualServer.xml
View File

@ -1951,7 +1951,7 @@
<argument index="2" name="scenario" type="RID">
</argument>
<description>
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDscript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query.
Returns an array of object IDs intersecting with the provided 3D ray. Only visual 3D nodes are considered, such as [MeshInstance] or [DirectionalLight]. Use [method @GDScript.instance_from_id] to obtain the actual nodes. A scenario RID must be provided, which is available in the [World] you want to query.
Warning: this function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
</description>
</method>
@ -3710,7 +3710,7 @@
<argument index="1" name="clear_mode" type="int" enum="VisualServer.ViewportClearMode">
</argument>
<description>
Sets the clear mode of a viewport. See [enum VisualServer.ViewportClearMode] for options.
Sets the clear mode of a viewport. See [enum ViewportClearMode] for options.
</description>
</method>
<method name="viewport_set_debug_draw">
@ -3721,7 +3721,7 @@
<argument index="1" name="draw" type="int" enum="VisualServer.ViewportDebugDraw">
</argument>
<description>
Sets the debug draw mode of a viewport. See [enum VisualServer.ViewportDebugDraw] for options.
Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options.
</description>
</method>
<method name="viewport_set_disable_3d">
@ -4020,7 +4020,7 @@
Shader is a particle shader.
</constant>
<constant name="SHADER_MAX" value="3" enum="ShaderMode">
Marks maximum of the shader types array. used internally.
Represents the size of the [enum ShaderMode] enum.
</constant>
<constant name="ARRAY_VERTEX" value="0" enum="ArrayType">
Array is a vertex array.
@ -4050,7 +4050,7 @@
Array is index array.
</constant>
<constant name="ARRAY_MAX" value="9" enum="ArrayType">
Marks the maximum of the array types. Used internally.
Represents the size of the [enum ArrayType] enum.
</constant>
<constant name="ARRAY_FORMAT_VERTEX" value="1" enum="ArrayFormat">
Flag used to mark a vertex array.
@ -4135,7 +4135,7 @@
Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle).
</constant>
<constant name="PRIMITIVE_MAX" value="7" enum="PrimitiveType">
Marks the primitive types endpoint. used internally.
Represents the size of the [enum PrimitiveType] enum.
</constant>
<constant name="BLEND_SHAPE_MODE_NORMALIZED" value="0" enum="BlendShapeMode">
</constant>
@ -4186,7 +4186,7 @@
<constant name="LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE" value="14" enum="LightParam">
</constant>
<constant name="LIGHT_PARAM_MAX" value="15" enum="LightParam">
The light parameters endpoint. Used internally.
Represents the size of the [enum LightParam] enum.
</constant>
<constant name="LIGHT_OMNI_SHADOW_DUAL_PARABOLOID" value="0" enum="LightOmniShadowMode">
</constant>
@ -4263,7 +4263,7 @@
<constant name="VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME" value="5" enum="ViewportRenderInfo">
</constant>
<constant name="VIEWPORT_RENDER_INFO_MAX" value="6" enum="ViewportRenderInfo">
Marks end of VIEWPORT_RENDER_INFO* constants. Used internally.
Represents the size of the [enum ViewportRenderInfo] enum.
</constant>
<constant name="VIEWPORT_DEBUG_DRAW_DISABLED" value="0" enum="ViewportDebugDraw">
Debug draw is disabled. Default setting.
@ -4310,7 +4310,7 @@
<constant name="INSTANCE_LIGHTMAP_CAPTURE" value="8" enum="InstanceType">
</constant>
<constant name="INSTANCE_MAX" value="9" enum="InstanceType">
The max value for INSTANCE_* constants, used internally.
Represents the size of the [enum InstanceType] enum.
</constant>
<constant name="INSTANCE_GEOMETRY_MASK" value="30" enum="InstanceType">
A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
@ -4320,6 +4320,7 @@
<constant name="INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="InstanceFlags">
</constant>
<constant name="INSTANCE_FLAG_MAX" value="2" enum="InstanceFlags">
Represents the size of the [enum InstanceFlags] enum.
</constant>
<constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting">
</constant>
@ -4444,6 +4445,7 @@
<constant name="ENV_BG_KEEP" value="5" enum="EnvironmentBG">
</constant>
<constant name="ENV_BG_MAX" value="7" enum="EnvironmentBG">
Represents the size of the [enum EnvironmentBG] enum.
</constant>
<constant name="ENV_DOF_BLUR_QUALITY_LOW" value="0" enum="EnvironmentDOFBlurQuality">
</constant>

1
doc/classes/VisualShader.xml
View File

@ -194,6 +194,7 @@
<constant name="TYPE_LIGHT" value="2" enum="Type">
</constant>
<constant name="TYPE_MAX" value="3" enum="Type">
Represents the size of the [enum Type] enum.
</constant>
<constant name="NODE_ID_INVALID" value="-1">
</constant>

2
modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
View File

@ -213,7 +213,7 @@
[/codeblock]
</constant>
<constant name="FUNC_MAX" value="65" enum="BuiltinFunc">
The maximum value the [member function] property can have.
Represents the size of the [enum BuiltinFunc] enum.
</constant>
</constants>
</class>

1
modules/visual_script/doc_classes/VisualScriptMathConstant.xml
View File

@ -45,6 +45,7 @@
Not a number: [code]nan[/code]
</constant>
<constant name="MATH_CONSTANT_MAX" value="8" enum="MathConstant">
Represents the size of the [enum MathConstant] enum.
</constant>
</constants>
</class>

2
modules/webrtc/doc_classes/WebRTCDataChannel.xml
View File

@ -56,7 +56,7 @@
<return type="int" enum="WebRTCDataChannel.ChannelState">
</return>
<description>
Returns the current state of this channel, see [enum WebRTCDataChannel.ChannelState].
Returns the current state of this channel, see [enum ChannelState].
</description>
</method>
<method name="is_negotiated" qualifiers="const">

1
scene/3d/visual_instance.cpp
View File

@ -326,6 +326,7 @@ void GeometryInstance::_bind_methods() {
BIND_ENUM_CONSTANT(SHADOW_CASTING_SETTING_SHADOWS_ONLY);
BIND_ENUM_CONSTANT(FLAG_USE_BAKED_LIGHT);
BIND_ENUM_CONSTANT(FLAG_DRAW_NEXT_FRAME_IF_VISIBLE);
BIND_ENUM_CONSTANT(FLAG_MAX);
}