From 74aa104607ee48f07e21c20dd073c7d117b16886 Mon Sep 17 00:00:00 2001 From: Tiger C Date: Wed, 29 Aug 2018 18:44:24 -0400 Subject: [PATCH] Added documentation for some RigidBody methods, and copied the descriptions to matching PhysicsDirectBodyState methods. --- doc/classes/PhysicsDirectBodyState.xml | 8 ++++++++ doc/classes/RigidBody.xml | 6 ++++++ 2 files changed, 14 insertions(+) diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index 91fc4df4ff2..2f3501ae5d5 100644 --- a/doc/classes/PhysicsDirectBodyState.xml +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -15,6 +15,8 @@ + Adds a constant directional force without affecting rotation. + This is equivalent to [code]add_force(force, Vector3(0,0,0))[/code]. @@ -25,6 +27,7 @@ + Adds a constant force (i.e. acceleration). @@ -33,6 +36,7 @@ + Adds a constant rotational force (i.e. a motor) without affecting position. @@ -41,6 +45,8 @@ + Applies a single directional impulse without affecting rotation. + This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. @@ -51,6 +57,7 @@ + Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the object's origin. @@ -59,6 +66,7 @@ + Apply a torque impulse (which will be affected by the body mass and shape). This will rotate the body around the passed in vector. diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index 038464e127c..4ae1ef8e942 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -30,6 +30,8 @@ + Adds a constant directional force without affecting rotation. + This is equivalent to [code]add_force(force, Vector3(0,0,0))[/code]. @@ -40,6 +42,7 @@ + Adds a constant force (i.e. acceleration). @@ -48,6 +51,7 @@ + Adds a constant rotational force (i.e. a motor) without affecting position. @@ -56,6 +60,8 @@ + Applies a single directional impulse without affecting rotation. + This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``.