From 617530832b56d10dc6df16f83692ccdcb905cfc7 Mon Sep 17 00:00:00 2001 From: P-GLEZ <4cpablogp@gmail.com> Date: Tue, 31 May 2016 19:24:27 +0200 Subject: [PATCH] Area Documentation Ported the Area2D documentation into its 3D counterpart. Also fixed some typos --- doc/base/classes.xml | 52 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 49 insertions(+), 3 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 074c14443ce..6f271d168a8 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -3612,8 +3612,10 @@ + General purpose area detection and influence for 3D physics. + General purpose area detection for 3D physics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). For this, use any space override different from AREA_SPACE_OVERRIDE_DISABLE and point gravity at the center of mass. @@ -3632,42 +3634,50 @@ + Return the space override mode. + When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use [method set_gravity_vector]/[method get_gravity_vector]. + Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction. + Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance. + Return the falloff factor for point gravity. + Set the gravity vector. This vector does not have to be normalized. + If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. + Return the gravity vector. If gravity is a point (see [method is_gravity_a_point]), this will be the attraction center. @@ -3680,66 +3690,82 @@ + Return the gravity intensity. + Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. + Return the angular damp rate. + Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops. + In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. + Return the linear damp rate. + Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent. + Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. + Return the processing order of this area. + Set the physics layers this area can scan for collisions. + Return the physics layers this area can scan for collisions. + Set the physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using [method set_collision_mask]. + A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + Return the physics layer this area is in. @@ -3748,6 +3774,7 @@ + Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. @@ -3756,6 +3783,7 @@ + Return an individual bit on the collision mask. @@ -3764,6 +3792,7 @@ + Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier. @@ -3772,58 +3801,67 @@ + Return an individual bit on the layer mask. + Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so. + Return whether this area can be detected by other, monitoring, areas. + Set whether this area can detect bodies/areas entering/exiting it. + Return whether this area detects bodies/areas entering/exiting it. + Return a list of the bodies ([PhysicsBody]) that are totally or partially inside this area. + Return a list of the areas that are totally or partially inside this area. - + + Return whether the body passed is totally or partially inside this area. - + + Return whether the area passed is totally or partially inside this area. @@ -3832,6 +3870,7 @@ + This signal is triggered only once when a body enters this area. The only parameter passed is the body that entered this area. @@ -3844,12 +3883,14 @@ + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. + This signal is triggered only once when an area enters this area. The only parameter passed is the area that entered this area. @@ -3862,12 +3903,14 @@ + This signal triggers only once when an area enters this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. + This signal is triggered only once when a body exits this area. The only parameter passed is the body that exited this area. @@ -3880,12 +3923,14 @@ + This signal triggers only once when a body exits this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape exiting this area, and the fourth one is the index of the shape in this area that reported the exit. + This signal is triggered only once when an area exits this area. The only parameter passed is the area that exited this area. @@ -3898,6 +3943,7 @@ + This signal triggers only once when an area exits this area. The first parameter is the area's [RID]. The second one is the area as an object. The third one is the index of the shape entering this area, and the fourth one is the index of the shape in this area that reported the entering. @@ -4125,7 +4171,7 @@ - Set whether this area can be detected by other, monitoring, areas. + Return whether this area can be detected by other, monitoring, areas.