diff options
| author | FigyTuna | 2017-09-16 23:47:20 -0700 |
|---|---|---|
| committer | FigyTuna | 2017-09-16 23:47:20 -0700 |
| commit | 4fc0910ed3bcca04ba78935361050beffc8e35ed (patch) | |
| tree | 21fe62566df92189cd276ba48b778840d9466c49 /doc/classes/PhysicsBody.xml | |
| parent | 2ca656fc38a7da6552b8d1bed88132062295748a (diff) | |
| download | godot-4fc0910ed3bcca04ba78935361050beffc8e35ed.tar.gz godot-4fc0910ed3bcca04ba78935361050beffc8e35ed.tar.zst godot-4fc0910ed3bcca04ba78935361050beffc8e35ed.zip | |
Modified/Added documentation for PhysicsBody and PhysicsBody2D
Diffstat (limited to 'doc/classes/PhysicsBody.xml')
| -rw-r--r-- | doc/classes/PhysicsBody.xml | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index e8ae98634..e75fbb8e2 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsBody" inherits="CollisionObject" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Base class for different types of Physics bodies. + Base class for all objects affected by physics in 3D space. </brief_description> <description> - PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it. + PhysicsBody is an abstract base class for implementing a physics body. All *Body types inherit from it. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <argument index="0" name="body" type="Node"> </argument> <description> - Adds a body to the collision exception list. This list contains bodies that this body will not collide with. + Adds a body to the list of bodies that this body can't collide with. </description> </method> <method name="get_collision_layer" qualifiers="const"> @@ -54,7 +54,7 @@ <argument index="0" name="body" type="Node"> </argument> <description> - Removes a body from the collision exception list. + Removes a body from the list of bodies that this body can't collide with. </description> </method> <method name="set_collision_layer"> @@ -96,8 +96,12 @@ </methods> <members> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> + The physics layers this area is in. + Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. + 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. </member> <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + The physics layers this area can scan for collisions. </member> </members> <constants> |