summaryrefslogtreecommitdiff
path: root/doc/classes/PhysicsServer.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-06-28 12:36:41 +0200
committerGitHub <noreply@github.com>2019-06-28 12:36:41 +0200
commit6e03236574467d6a0c3aca1b0375da59423b0083 (patch)
tree7da85ef95f4fc66559218976bb08a87143ae3c8c /doc/classes/PhysicsServer.xml
parent7b10bae916dabcf1639fa1ee99c5fefd2790a1ca (diff)
parentf7f6115f7627df24a08a9a0882b2f573cc838eb1 (diff)
Merge pull request #30134 from Calinou/doc-proofread
Proofread and improve the whole class reference
Diffstat (limited to 'doc/classes/PhysicsServer.xml')
-rw-r--r--doc/classes/PhysicsServer.xml26
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml
index 77536e2b5b..b06b0df40d 100644
--- a/doc/classes/PhysicsServer.xml
+++ b/doc/classes/PhysicsServer.xml
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsServer" inherits="Object" category="Core" version="3.2">
<brief_description>
- Server interface for low level physics access.
+ Server interface for low-level physics access.
</brief_description>
<description>
- Everything related to physics in 3D.
+ PhysicsServer is the server responsible for all 3D physics. It can create many kinds of physics objects, but does not insert them on the node tree.
</description>
<tutorials>
</tutorials>
@@ -68,7 +68,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.AreaParameter">
</argument>
<description>
- Returns an area parameter value. A list of available parameters is on the AREA_PARAM_* constants.
+ Returns an area parameter value. A list of available parameters is on the [code]AREA_PARAM_*[/code] constants.
</description>
</method>
<method name="area_get_shape" qualifiers="const">
@@ -221,7 +221,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. A list of available parameters is on the [code]AREA_PARAM_*[/code] constants.
</description>
</method>
<method name="area_set_ray_pickable">
@@ -292,7 +292,7 @@
<argument index="1" name="mode" type="int" enum="PhysicsServer.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. The modes are described in the constants [code]AREA_SPACE_OVERRIDE_*[/code].
</description>
</method>
<method name="area_set_transform">
@@ -500,7 +500,7 @@
<argument index="1" name="param" type="int" enum="PhysicsServer.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. A list of available parameters is on the [code]BODY_PARAM_*[/code] constants.
</description>
</method>
<method name="body_get_shape" qualifiers="const">
@@ -588,7 +588,7 @@
<argument index="0" name="body" type="RID">
</argument>
<description>
- If [code]true[/code], the body can be detected by rays
+ If [code]true[/code], the body can be detected by rays.
</description>
</method>
<method name="body_remove_collision_exception">
@@ -739,7 +739,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. A list of available parameters is on the [code]BODY_PARAM_*[/code] constants.
</description>
</method>
<method name="body_set_ray_pickable">
@@ -1144,7 +1144,7 @@
<argument index="0" name="type" type="int" enum="PhysicsServer.ShapeType">
</argument>
<description>
- Creates a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape].
+ Creates a shape of type [code]SHAPE_*[/code]. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape].
</description>
</method>
<method name="shape_get_data" qualifiers="const">
@@ -1162,7 +1162,7 @@
<argument index="0" name="shape" type="RID">
</argument>
<description>
- Returns the type of shape (see SHAPE_* constants).
+ Returns the type of shape (see [code]SHAPE_*[/code] constants).
</description>
</method>
<method name="shape_set_data">
@@ -1257,7 +1257,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. A list of available parameters is on the [code]SPACE_PARAM_*[/code] constants.
</description>
</method>
</methods>
@@ -1318,10 +1318,10 @@
If [code]true[/code], a motor turns the Hinge
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0" enum="SliderJointParam">
- The maximum difference between the pivot points on their x-axis before damping happens.
+ The maximum difference between the pivot points on their X axis before damping happens.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1" enum="SliderJointParam">
- The minimum difference between the pivot points on their x-axis before damping happens.
+ The minimum difference between the pivot points on their X axis before damping happens.
</constant>
<constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2" enum="SliderJointParam">
A factor applied to the movement across the slider axis once the limits get surpassed. The lower, the slower the movement.