From 4fc0910ed3bcca04ba78935361050beffc8e35ed Mon Sep 17 00:00:00 2001 From: FigyTuna Date: Sat, 16 Sep 2017 23:47:20 -0700 Subject: [PATCH] Modified/Added documentation for PhysicsBody and PhysicsBody2D --- doc/classes/PhysicsBody.xml | 12 ++++++++---- doc/classes/PhysicsBody2D.xml | 9 ++++++++- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/doc/classes/PhysicsBody.xml b/doc/classes/PhysicsBody.xml index e8ae986346b..e75fbb8e2d3 100644 --- a/doc/classes/PhysicsBody.xml +++ b/doc/classes/PhysicsBody.xml @@ -1,10 +1,10 @@ - Base class for different types of Physics bodies. + Base class for all objects affected by physics in 3D space. - 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. @@ -17,7 +17,7 @@ - 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. @@ -54,7 +54,7 @@ - Removes a body from the collision exception list. + Removes a body from the list of bodies that this body can't collide with. @@ -96,8 +96,12 @@ + 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. + The physics layers this area can scan for collisions. diff --git a/doc/classes/PhysicsBody2D.xml b/doc/classes/PhysicsBody2D.xml index e1603110908..748506baa90 100644 --- a/doc/classes/PhysicsBody2D.xml +++ b/doc/classes/PhysicsBody2D.xml @@ -1,7 +1,7 @@ - Base class for all objects affected by physics. + Base class for all objects affected by physics in 2D space. PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it. @@ -17,6 +17,7 @@ + Adds a body to the list of bodies that this body can't collide with. @@ -57,6 +58,7 @@ + Removes a body from the list of bodies that this body can't collide with. @@ -104,10 +106,15 @@ + 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. + The physics layers this area can scan for collisions. + Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layers and collision_mask when modified.