From 86ed7a988419247479596947ce44279ee8b3528c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 27 Jun 2019 11:10:53 +0200 Subject: doc: Complete and harmonize all _MAX constant descriptions --- doc/classes/@GlobalScope.xml | 6 ++-- doc/classes/ArrayMesh.xml | 1 + doc/classes/AudioEffectPitchShift.xml | 1 + doc/classes/AudioEffectSpectrumAnalyzer.xml | 1 + .../AudioEffectSpectrumAnalyzerInstance.xml | 2 ++ doc/classes/ConeTwistJoint.xml | 6 ++-- doc/classes/EditorFeatureProfile.xml | 1 + doc/classes/EditorPlugin.xml | 1 + doc/classes/Environment.xml | 2 +- doc/classes/GIProbe.xml | 1 + doc/classes/Generic6DOFJoint.xml | 4 +-- doc/classes/GeometryInstance.xml | 11 ++++--- doc/classes/HTTPClient.xml | 2 +- doc/classes/HingeJoint.xml | 4 +-- doc/classes/Image.xml | 1 + doc/classes/Light.xml | 1 + doc/classes/LineEdit.xml | 1 + doc/classes/Material.xml | 2 ++ doc/classes/Mesh.xml | 1 + doc/classes/Physics2DServer.xml | 34 +++++++++++----------- doc/classes/PhysicsServer.xml | 4 +-- doc/classes/ProceduralSky.xml | 5 ++-- doc/classes/ResourceImporter.xml | 13 +++++++++ doc/classes/Sky.xml | 8 ++--- doc/classes/SliderJoint.xml | 2 +- doc/classes/SpatialMaterial.xml | 3 ++ doc/classes/SpriteBase3D.xml | 2 +- doc/classes/Tabs.xml | 2 ++ doc/classes/Viewport.xml | 4 +-- doc/classes/VisibilityEnabler.xml | 1 + doc/classes/VisibilityEnabler2D.xml | 1 + doc/classes/VisualServer.xml | 14 +++++---- doc/classes/VisualShader.xml | 1 + 33 files changed, 93 insertions(+), 50 deletions(-) create mode 100644 doc/classes/ResourceImporter.xml (limited to 'doc/classes') diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index d36a545c56..1c3b6cba70 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -968,7 +968,7 @@ Joypad Button 15 - Joypad Button 16 + Represents the maximum number of joystick buttons supported. DUALSHOCK circle button @@ -1090,6 +1090,7 @@ + Represents the maximum number of joystick axes supported. Joypad Left Stick Horizontal Axis @@ -1449,7 +1450,7 @@ Variable is of type [PoolColorArray]. - Marker for end of type constants. + Represents the size of the [enum Variant.Type] enum. @@ -1502,6 +1503,7 @@ + Represents the size of the [enum Variant.Operator] enum. diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index d44e3c54c9..3e3f040d26 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -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. + Represents the size of the [enum ArrayType] enum. Array format will include vertices (mandatory). diff --git a/doc/classes/AudioEffectPitchShift.xml b/doc/classes/AudioEffectPitchShift.xml index 8c22afb40f..271e1a2a4c 100644 --- a/doc/classes/AudioEffectPitchShift.xml +++ b/doc/classes/AudioEffectPitchShift.xml @@ -32,6 +32,7 @@ + Represents the size of the [enum FFT_Size] enum. diff --git a/doc/classes/AudioEffectSpectrumAnalyzer.xml b/doc/classes/AudioEffectSpectrumAnalyzer.xml index 8a71991437..21d74a8fb0 100644 --- a/doc/classes/AudioEffectSpectrumAnalyzer.xml +++ b/doc/classes/AudioEffectSpectrumAnalyzer.xml @@ -28,6 +28,7 @@ + Represents the size of the [enum FFT_Size] enum. diff --git a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml index f4620f9905..ca068d572d 100644 --- a/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml +++ b/doc/classes/AudioEffectSpectrumAnalyzerInstance.xml @@ -22,8 +22,10 @@ + Use the average value as magnitude. + Use the maximum value as magnitude. diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index f7266aad27..28dee22b7f 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -25,7 +25,7 @@ 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]. @@ -37,7 +37,7 @@ 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]. @@ -56,7 +56,7 @@ Defines, how fast the swing- and twist-speed-difference on both sides gets synced. - End flag of PARAM_* constants, used internally. + Represents the size of the [enum Param] enum. diff --git a/doc/classes/EditorFeatureProfile.xml b/doc/classes/EditorFeatureProfile.xml index 410b71a43e..21da9fd454 100644 --- a/doc/classes/EditorFeatureProfile.xml +++ b/doc/classes/EditorFeatureProfile.xml @@ -124,6 +124,7 @@ + Represents the size of the [enum Feature] enum. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 3d91bff0aa..28b2be75e3 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -546,6 +546,7 @@ + Represents the size of the [enum DockSlot] enum. diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index eb94447529..72993103e8 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -273,7 +273,7 @@ Display a camera feed in the background. - Helper constant keeping track of the enum's size, has no direct usage in API calls. + Represents the size of the [enum BGMode] enum. Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources. diff --git a/doc/classes/GIProbe.xml b/doc/classes/GIProbe.xml index e42d3ed2c4..84cd446ea2 100644 --- a/doc/classes/GIProbe.xml +++ b/doc/classes/GIProbe.xml @@ -57,6 +57,7 @@ + Represents the size of the [enum Subdiv] enum. diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index 53cece21fa..52888e9587 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -293,7 +293,7 @@ Maximum acceleration for the motor at the axes. - End flag of PARAM_* constants, used internally. + Represents the size of the [enum Param] enum. If [code]set[/code] there is linear motion possible within the given limits. @@ -311,7 +311,7 @@ - End flag of FLAG_* constants, used internally. + Represents the size of the [enum Flag] enum. diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index 674f786149..22135a048e 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -15,13 +15,13 @@ - 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. - The selected shadow casting flag. See SHADOW_CASTING_SETTING_* constants for values. + The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values. The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box. @@ -40,7 +40,7 @@ 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. 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 @@ 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 + + + Unused in this class, exposed for consistency with [enum VisualServer.InstanceFlags]. + Represents the size of the [enum Flags] enum. diff --git a/doc/classes/HTTPClient.xml b/doc/classes/HTTPClient.xml index 8ae0120a34..16f9531dbd 100644 --- a/doc/classes/HTTPClient.xml +++ b/doc/classes/HTTPClient.xml @@ -211,7 +211,7 @@ HTTP PATCH method. The PATCH method is used to apply partial modifications to a resource. - Marker for end of [code]METHOD_*[/code] enum. Not used. + Represents the size of the [enum Method] enum. Status: Disconnected from the server. diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index 79df64f226..2fde885ee8 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -66,7 +66,7 @@ Maximum acceleration for the motor. - End flag of PARAM_* constants, used internally. + Represents the size of the [enum Param] enum. 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. - End flag of FLAG_* constants, used internally. + Represents the size of the [enum Flag] enum. diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 75434b031e..d7c3c0af78 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -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. + Represents the size of the [enum Format] enum. diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index ecbc07ba72..05eb44b2f1 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -83,6 +83,7 @@ + Represents the size of the [enum Param] enum. Light is ignored when baking. Note: hiding a light does [i]not[/i] affect baking. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 333f6a3671..c336357109 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -181,6 +181,7 @@ Reverse the last undo action. + Represents the size of the [enum MenuItems] enum. diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index 848a43e6c4..22da012022 100644 --- a/doc/classes/Material.xml +++ b/doc/classes/Material.xml @@ -18,8 +18,10 @@ + Maximum value for the [member render_priority] parameter. + Minimum value for the [member render_priority] parameter. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index 048e7074f1..d2911fd299 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -194,6 +194,7 @@ Array of indices. + Represents the size of the [enum ArrayType] enum. diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 172420e4ca..de4a8c233e 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -86,7 +86,7 @@ - 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. @@ -230,7 +230,7 @@ - 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. @@ -291,7 +291,7 @@ - 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. @@ -431,7 +431,7 @@ - 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. @@ -513,7 +513,7 @@ - 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. @@ -650,7 +650,7 @@ - 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. @@ -688,7 +688,7 @@ - Sets the body mode, from one of the constants BODY_MODE*. + Sets the body mode using one of the [enum BodyMode] constants. @@ -712,7 +712,7 @@ - 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. @@ -803,7 +803,7 @@ - Sets a body state (see BODY_STATE* constants). + Sets a body state using one of the [enum BodyState] constants. @@ -885,7 +885,7 @@ - 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. @@ -903,7 +903,7 @@ - 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. @@ -920,7 +920,7 @@ - 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. @@ -940,7 +940,7 @@ - Returns the type of a joint (see JOINT_* constants). + Returns the type of a joint (see [enum JointType]). @@ -953,7 +953,7 @@ - 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. @@ -1017,7 +1017,7 @@ - Returns the type of shape (see SHAPE_* constants). + Returns the type of shape (see [enum ShapeType]). @@ -1088,7 +1088,7 @@ - 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. @@ -1215,7 +1215,7 @@ Constant to set/get a body's angular dampening factor. - 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 to set/get the current transform matrix of the body. diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index eff0d4ef2e..c8afd81701 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1384,7 +1384,7 @@ The amount of damping of the rotation across axes orthogonal to the slider. - End flag of SLIDER_JOINT_* constants, used internally. + Represents the size of the [enum SliderJointParam] enum. 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. - 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 to set/get the current transform matrix of the body. diff --git a/doc/classes/ProceduralSky.xml b/doc/classes/ProceduralSky.xml index 97ad1efa93..68deb5aff4 100644 --- a/doc/classes/ProceduralSky.xml +++ b/doc/classes/ProceduralSky.xml @@ -46,7 +46,7 @@ Color of the sun. - 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]. Amount of energy contribution from the sun. @@ -58,7 +58,7 @@ The direction of the sun using polar coordinates. - Size of [Texture] that the ProceduralSky will generate. + Size of [Texture] that the ProceduralSky will generate. The size is set using [enum TextureSize]. @@ -73,6 +73,7 @@ + Represents the size of the [enum TextureSize] enum. diff --git a/doc/classes/ResourceImporter.xml b/doc/classes/ResourceImporter.xml new file mode 100644 index 0000000000..e0c0aa9a47 --- /dev/null +++ b/doc/classes/ResourceImporter.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/doc/classes/Sky.xml b/doc/classes/Sky.xml index ffd8c3fdee..a5e065203e 100644 --- a/doc/classes/Sky.xml +++ b/doc/classes/Sky.xml @@ -12,9 +12,9 @@ - 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]. @@ -40,7 +40,7 @@ Radiance texture size is 2048x2048 pixels. - Radiance texture size is the largest size it can be. + Represents the size of the [enum RadianceSize] enum. diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index 997930eaa3..75406df39f 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -149,7 +149,7 @@ The amount of damping of the rotation across axes orthogonal to the slider. - End flag of PARAM_* constants, used internally. + Represents the size of the [enum Param] enum. diff --git a/doc/classes/SpatialMaterial.xml b/doc/classes/SpatialMaterial.xml index f0df5fac4a..45d92aa0c3 100644 --- a/doc/classes/SpatialMaterial.xml +++ b/doc/classes/SpatialMaterial.xml @@ -295,6 +295,7 @@ + Represents the size of the [enum TextureParam] enum. @@ -325,6 +326,7 @@ + Represents the size of the [enum Feature] enum. Default blend mode. @@ -395,6 +397,7 @@ + Represents the size of the [enum Flags] enum. Default diffuse scattering algorithm. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 50e00fe333..237a8c9d12 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -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. - Used internally to mark the end of the Flags section. + Represents the size of the [enum DrawFlags] enum. diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 8c7d657b4a..b1105f231d 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -234,6 +234,7 @@ Align the tabs to the right. + Represents the size of the [enum TabAlign] enum. @@ -242,6 +243,7 @@ + Represents the size of the [enum CloseButtonDisplayPolicy] enum. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 53e66cee74..de3cdbbe13 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -331,7 +331,7 @@ - Enum limiter. Do not use it directly. + Represents the size of the [enum ShadowAtlasQuadrantSubdiv] enum. Amount of objects in frame. @@ -352,7 +352,7 @@ Amount of draw calls in frame. - Enum limiter. Do not use it directly. + Represents the size of the [enum RenderInfo] enum. Objects are displayed normally. diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml index 910ca033d1..4b33d1ebce 100644 --- a/doc/classes/VisibilityEnabler.xml +++ b/doc/classes/VisibilityEnabler.xml @@ -26,6 +26,7 @@ This enabler will freeze [RigidBody] nodes. + Represents the size of the [enum Enabler] enum. diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml index 3943eca7f5..b3d41d1fce 100644 --- a/doc/classes/VisibilityEnabler2D.xml +++ b/doc/classes/VisibilityEnabler2D.xml @@ -49,6 +49,7 @@ + Represents the size of the [enum Enabler] enum. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 65675bbd0d..d5e467405e 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -4020,7 +4020,7 @@ Shader is a particle shader. - Marks maximum of the shader types array. used internally. + Represents the size of the [enum ShaderMode] enum. Array is a vertex array. @@ -4050,7 +4050,7 @@ Array is index array. - Marks the maximum of the array types. Used internally. + Represents the size of the [enum ArrayType] enum. 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). - Marks the primitive types endpoint. used internally. + Represents the size of the [enum PrimitiveType] enum. @@ -4186,7 +4186,7 @@ - The light parameters endpoint. Used internally. + Represents the size of the [enum LightParam] enum. @@ -4263,7 +4263,7 @@ - Marks end of VIEWPORT_RENDER_INFO* constants. Used internally. + Represents the size of the [enum ViewportRenderInfo] enum. Debug draw is disabled. Default setting. @@ -4310,7 +4310,7 @@ - The max value for INSTANCE_* constants, used internally. + Represents the size of the [enum InstanceType] enum. A combination of the flags of geometry instances (mesh, multimesh, immediate and particles). @@ -4320,6 +4320,7 @@ + Represents the size of the [enum InstanceFlags] enum. @@ -4444,6 +4445,7 @@ + Represents the size of the [enum EnvironmentBG] enum. diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 6d5f53d992..0c9292930d 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -194,6 +194,7 @@ + Represents the size of the [enum Type] enum. -- cgit v1.2.3 From 71d53637b5bce5519800a5cadfa2e42750b8b793 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 27 Jun 2019 11:44:37 +0200 Subject: doc: Fix scoped hyperlinks to same-class enums/methods The class name does not need to be specified when it is the current class. --- doc/classes/AStar.xml | 2 +- doc/classes/Area.xml | 2 +- doc/classes/Area2D.xml | 2 +- doc/classes/EditorPlugin.xml | 6 +++--- doc/classes/Geometry.xml | 18 +++++++++--------- doc/classes/Light2D.xml | 2 +- doc/classes/LineEdit.xml | 2 +- doc/classes/Node.xml | 2 +- doc/classes/OS.xml | 6 +++--- doc/classes/PhysicsServer.xml | 2 +- doc/classes/StreamPeerTCP.xml | 2 +- doc/classes/TileSet.xml | 12 ++++++------ doc/classes/VisualServer.xml | 6 +++--- 13 files changed, 32 insertions(+), 32 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 81722535c2..0c7de55329 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -5,7 +5,7 @@ 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]. diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index d40376414f..17d9678f64 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -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. - 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. diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 4771a976b5..c287f2b6f5 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -124,7 +124,7 @@ The area's priority. Higher priority areas are processed first. Default value: 0. - 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. diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index 28b2be75e3..36d6e38be9 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -292,7 +292,7 @@ - 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. @@ -455,7 +455,7 @@ - Restore the state saved by [method EditorPlugin.get_state]. + Restore the state saved by [method get_state]. @@ -464,7 +464,7 @@ - Restore the plugin GUI layout saved by [method EditorPlugin.get_window_layout]. + Restore the plugin GUI layout saved by [method get_window_layout]. diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 6fb4341b3c..4fd2bcf3c7 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -68,7 +68,7 @@ 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]. @@ -100,7 +100,7 @@ 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]. @@ -202,7 +202,7 @@ 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]. @@ -269,7 +269,7 @@ 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]. @@ -283,8 +283,8 @@ 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]. @@ -300,9 +300,9 @@ 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]. diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 4c64691da1..bc3fafdf55 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -58,7 +58,7 @@ If [code]true[/code], the Light2D will cast shadows. Default value: [code]false[/code]. - 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]. Smoothing value for shadows. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index c336357109..44043a5a16 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -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. - 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. Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit. diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 851f9f45fe..6df207b2cd 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -163,7 +163,7 @@ 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]). diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 28f1757039..f6e2f47a42 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -163,7 +163,7 @@ - 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]. @@ -380,7 +380,7 @@ - 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]. @@ -477,7 +477,7 @@ - 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. diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index c8afd81701..77536e2b5b 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -910,7 +910,7 @@ - Returns an Info defined by the [enum PhysicsServer.ProcessInfo] input given. + Returns an Info defined by the [enum ProcessInfo] input given. diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 0edea42521..e28fa3491e 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -45,7 +45,7 @@ - Returns the status of the connection, see [enum StreamPeerTCP.Status]. + Returns the status of the connection, see [enum Status]. diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index f29a7990ed..d5e2fd31f8 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -64,7 +64,7 @@ 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). @@ -73,7 +73,7 @@ - Returns the [enum TileSet.BitmaskMode] of the autotile. + Returns the [enum BitmaskMode] of the autotile. @@ -160,7 +160,7 @@ 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). @@ -171,7 +171,7 @@ - Sets the [enum TileSet.BitmaskMode] of the autotile. + Sets the [enum BitmaskMode] of the autotile. @@ -503,7 +503,7 @@ - Returns the tile's [enum TileSet.TileMode]. + Returns the tile's [enum TileMode]. @@ -719,7 +719,7 @@ - Sets the tile's [enum TileSet.TileMode]. + Sets the tile's [enum TileMode]. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index d5e467405e..552aba14ac 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1951,7 +1951,7 @@ - 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. @@ -3710,7 +3710,7 @@ - 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. @@ -3721,7 +3721,7 @@ - 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. -- cgit v1.2.3