godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases Wiki Activity

Remove redundant info on the enum types used

Browse Source
This commit is contained in:
Haoyu Qiu
2025-05-08 11:56:10 +08:00
parent 1b37dacc18
commit 1e82bafa3a
144 changed files with 359 additions and 361 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
doc/classes/PhysicsServer2D.xml
View File

@@ -89,7 +89,7 @@
<param index="0" name="area" type="RID" />
<param index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" />
<description>
Returns the value of the given area parameter. See [enum AreaParameter] for the list of available parameters.
Returns the value of the given area parameter.
</description>
</method>
<method name="area_get_shape" qualifiers="const">
@@ -195,7 +195,7 @@
<param index="1" name="param" type="int" enum="PhysicsServer2D.AreaParameter" />
<param index="2" name="value" type="Variant" />
<description>
Sets the value of the given area parameter. See [enum AreaParameter] for the list of available parameters.
Sets the value of the given area parameter.
</description>
</method>
<method name="area_set_shape">
@@ -422,7 +422,7 @@
<return type="int" enum="PhysicsServer2D.CCDMode" />
<param index="0" name="body" type="RID" />
<description>
Returns the body's continuous collision detection mode (see [enum CCDMode]).
Returns the body's continuous collision detection mode.
</description>
</method>
<method name="body_get_direct_state">
@@ -443,7 +443,7 @@
<return type="int" enum="PhysicsServer2D.BodyMode" />
<param index="0" name="body" type="RID" />
<description>
Returns the body's mode (see [enum BodyMode]).
Returns the body's mode.
</description>
</method>
<method name="body_get_object_instance_id" qualifiers="const">
@@ -458,7 +458,7 @@
<param index="0" name="body" type="RID" />
<param index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" />
<description>
Returns the value of the given body parameter. See [enum BodyParameter] for the list of available parameters.
Returns the value of the given body parameter.
</description>
</method>
<method name="body_get_shape" qualifiers="const">
@@ -496,7 +496,7 @@
<param index="0" name="body" type="RID" />
<param index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" />
<description>
Returns the value of the given state of the body. See [enum BodyState] for the list of available states.
Returns the value of the given state of the body.
</description>
</method>
<method name="body_is_omitting_force_integration" qualifiers="const">
@@ -584,7 +584,7 @@
<param index="0" name="body" type="RID" />
<param index="1" name="mode" type="int" enum="PhysicsServer2D.CCDMode" />
<description>
Sets the continuous collision detection mode using one of the [enum CCDMode] constants.
Sets the continuous collision detection mode.
Continuous collision detection tries to predict where a moving body would collide in between physics updates, instead of moving it and correcting its movement if it collided.
</description>
</method>
@@ -615,7 +615,7 @@
<param index="0" name="body" type="RID" />
<param index="1" name="mode" type="int" enum="PhysicsServer2D.BodyMode" />
<description>
Sets the body's mode. See [enum BodyMode] for the list of available modes.
Sets the body's mode.
</description>
</method>
<method name="body_set_omit_force_integration">
@@ -633,7 +633,7 @@
<param index="1" name="param" type="int" enum="PhysicsServer2D.BodyParameter" />
<param index="2" name="value" type="Variant" />
<description>
Sets the value of the given body parameter. See [enum BodyParameter] for the list of available parameters.
Sets the value of the given body parameter.
</description>
</method>
<method name="body_set_shape">
@@ -690,7 +690,7 @@
<param index="1" name="state" type="int" enum="PhysicsServer2D.BodyState" />
<param index="2" name="value" type="Variant" />
<description>
Sets the value of a body's state. See [enum BodyState] for the list of available states.
Sets the value of a body's state.
[b]Note:[/b] The state change doesn't take effect immediately. The state will change on the next physics frame.
</description>
</method>
@@ -743,7 +743,7 @@
<param index="0" name="joint" type="RID" />
<param index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" />
<description>
Returns the value of the given damped spring joint parameter. See [enum DampedSpringParam] for the list of available parameters.
Returns the value of the given damped spring joint parameter.
</description>
</method>
<method name="damped_spring_joint_set_param">
@@ -752,7 +752,7 @@
<param index="1" name="param" type="int" enum="PhysicsServer2D.DampedSpringParam" />
<param index="2" name="value" type="float" />
<description>
Sets the value of the given damped spring joint parameter. See [enum DampedSpringParam] for the list of available parameters.
Sets the value of the given damped spring joint parameter.
</description>
</method>
<method name="free_rid">
@@ -766,7 +766,7 @@
<return type="int" />
<param index="0" name="process_info" type="int" enum="PhysicsServer2D.ProcessInfo" />
<description>
Returns information about the current state of the 2D physics engine. See [enum ProcessInfo] for the list of available states.
Returns the value of a physics engine state specified by [param process_info].
</description>
</method>
<method name="joint_clear">
@@ -795,14 +795,14 @@
<param index="0" name="joint" type="RID" />
<param index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" />
<description>
Returns the value of the given joint parameter. See [enum JointParam] for the list of available parameters.
Returns the value of the given joint parameter.
</description>
</method>
<method name="joint_get_type" qualifiers="const">
<return type="int" enum="PhysicsServer2D.JointType" />
<param index="0" name="joint" type="RID" />
<description>
Returns the joint's type (see [enum JointType]).
Returns the joint's type.
</description>
</method>
<method name="joint_is_disabled_collisions_between_bodies" qualifiers="const">
@@ -851,7 +851,7 @@
<param index="1" name="param" type="int" enum="PhysicsServer2D.JointParam" />
<param index="2" name="value" type="float" />
<description>
Sets the value of the given joint parameter. See [enum JointParam] for the list of available parameters.
Sets the value of the given joint parameter.
</description>
</method>
<method name="pin_joint_get_flag" qualifiers="const">
@@ -859,7 +859,7 @@
<param index="0" name="joint" type="RID" />
<param index="1" name="flag" type="int" enum="PhysicsServer2D.PinJointFlag" />
<description>
Gets a pin joint flag (see [enum PinJointFlag] constants).
Gets a pin joint flag.
</description>
</method>
<method name="pin_joint_get_param" qualifiers="const">
@@ -867,7 +867,7 @@
<param index="0" name="joint" type="RID" />
<param index="1" name="param" type="int" enum="PhysicsServer2D.PinJointParam" />
<description>
Returns the value of a pin joint parameter. See [enum PinJointParam] for a list of available parameters.
Returns the value of a pin joint parameter.
</description>
</method>
<method name="pin_joint_set_flag">
@@ -876,7 +876,7 @@
<param index="1" name="flag" type="int" enum="PhysicsServer2D.PinJointFlag" />
<param index="2" name="enabled" type="bool" />
<description>
Sets a pin joint flag (see [enum PinJointFlag] constants).
Sets a pin joint flag.
</description>
</method>
<method name="pin_joint_set_param">
@@ -885,7 +885,7 @@
<param index="1" name="param" type="int" enum="PhysicsServer2D.PinJointParam" />
<param index="2" name="value" type="float" />
<description>
Sets a pin joint parameter. See [enum PinJointParam] for a list of available parameters.
Sets a pin joint parameter.
</description>
</method>
<method name="rectangle_shape_create">
@@ -924,7 +924,7 @@
<return type="int" enum="PhysicsServer2D.ShapeType" />
<param index="0" name="shape" type="RID" />
<description>
Returns the shape's type (see [enum ShapeType]).
Returns the shape's type.
</description>
</method>
<method name="shape_set_data">
@@ -962,7 +962,7 @@
<param index="0" name="space" type="RID" />
<param index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" />
<description>
Returns the value of the given space parameter. See [enum SpaceParameter] for the list of available parameters.
Returns the value of the given space parameter.
</description>
</method>
<method name="space_is_active" qualifiers="const">
@@ -986,7 +986,7 @@
<param index="1" name="param" type="int" enum="PhysicsServer2D.SpaceParameter" />
<param index="2" name="value" type="float" />
<description>
Sets the value of the given space parameter. See [enum SpaceParameter] for the list of available parameters.
Sets the value of the given space parameter.
</description>
</method>
<method name="world_boundary_shape_create">