2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-02-14 14:18:53 +01:00
<class name= "PhysicsBody3D" inherits= "CollisionObject3D" version= "4.0" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-09-17 08:47:20 +02:00
Base class for all objects affected by physics in 3D space.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2020-03-30 18:22:57 +02:00
PhysicsBody3D is an abstract base class for implementing a physics body. All *Body types inherit from it.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
2021-11-15 10:43:07 +01:00
<link title= "Physics introduction" > $DOCS_URL/tutorials/physics/physics_introduction.html</link>
2017-09-12 22:42:36 +02:00
</tutorials>
<methods >
<method name= "add_collision_exception_with" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "body" type= "Node" />
2017-09-12 22:42:36 +02:00
<description >
2017-09-17 08:47:20 +02:00
Adds a body to the list of bodies that this body can't collide with.
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-05-20 03:14:33 +02:00
<method name= "get_axis_lock" qualifiers= "const" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "axis" type= "int" enum= "PhysicsServer3D.BodyAxis" />
2021-05-20 03:14:33 +02:00
<description >
2022-08-11 19:52:19 +02:00
Returns [code]true[/code] if the specified linear or rotational [param axis] is locked.
2021-05-20 03:14:33 +02:00
</description>
</method>
2018-10-24 21:32:55 +02:00
<method name= "get_collision_exceptions" >
2021-07-30 15:28:05 +02:00
<return type= "PhysicsBody3D[]" />
2018-10-24 21:32:55 +02:00
<description >
Returns an array of nodes that were added as collision exceptions for this body.
</description>
</method>
2021-05-20 03:14:33 +02:00
<method name= "move_and_collide" >
2021-07-30 15:28:05 +02:00
<return type= "KinematicCollision3D" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "distance" type= "Vector3" />
<param index= "1" name= "test_only" type= "bool" default= "false" />
<param index= "2" name= "safe_margin" type= "float" default= "0.001" />
<param index= "3" name= "max_collisions" type= "int" default= "1" />
2021-05-20 03:14:33 +02:00
<description >
2022-08-11 19:52:19 +02:00
Moves the body along the vector [param distance]. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [param distance] should be computed using [code]delta[/code].
2021-11-10 19:20:02 +01:00
The body will stop if it collides. Returns a [KinematicCollision3D], which contains information about the collision when stopped, or when touching another body along the motion.
2022-08-11 19:52:19 +02:00
If [param test_only] is [code]true[/code], the body does not move but the would-be collision information is given.
[param safe_margin] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details).
[param max_collisions] allows to retrieve more than one collision result.
2021-05-20 03:14:33 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "remove_collision_exception_with" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "body" type= "Node" />
2017-09-12 22:42:36 +02:00
<description >
2017-09-17 08:47:20 +02:00
Removes a body from the list of bodies that this body can't collide with.
2017-09-12 22:42:36 +02:00
</description>
</method>
2021-05-20 03:14:33 +02:00
<method name= "set_axis_lock" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "axis" type= "int" enum= "PhysicsServer3D.BodyAxis" />
<param index= "1" name= "lock" type= "bool" />
2021-05-20 03:14:33 +02:00
<description >
2022-08-11 19:52:19 +02:00
Locks or unlocks the specified linear or rotational [param axis] depending on the value of [param lock].
2021-05-20 03:14:33 +02:00
</description>
</method>
<method name= "test_move" >
2021-07-30 15:28:05 +02:00
<return type= "bool" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "from" type= "Transform3D" />
<param index= "1" name= "distance" type= "Vector3" />
<param index= "2" name= "collision" type= "KinematicCollision3D" default= "null" />
<param index= "3" name= "safe_margin" type= "float" default= "0.001" />
<param index= "4" name= "max_collisions" type= "int" default= "1" />
2021-05-20 03:14:33 +02:00
<description >
2022-08-11 19:52:19 +02:00
Checks for collisions without moving the body. In order to be frame rate independent in [method Node._physics_process] or [method Node._process], [param distance] should be computed using [code]delta[/code].
Virtually sets the node's position, scale and rotation to that of the given [Transform3D], then tries to move the body along the vector [param distance]. Returns [code]true[/code] if a collision would stop the body from moving along the whole path.
[param collision] is an optional object of type [KinematicCollision3D], which contains additional information about the collision when stopped, or when touching another body along the motion.
[param safe_margin] is the extra margin used for collision recovery (see [member CharacterBody3D.collision/safe_margin] for more details).
[param max_collisions] allows to retrieve more than one collision result.
2021-05-20 03:14:33 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
</methods>
2021-05-20 03:14:33 +02:00
<members >
<member name= "axis_lock_angular_x" type= "bool" setter= "set_axis_lock" getter= "get_axis_lock" default= "false" >
Lock the body's rotation in the X axis.
</member>
<member name= "axis_lock_angular_y" type= "bool" setter= "set_axis_lock" getter= "get_axis_lock" default= "false" >
Lock the body's rotation in the Y axis.
</member>
<member name= "axis_lock_angular_z" type= "bool" setter= "set_axis_lock" getter= "get_axis_lock" default= "false" >
Lock the body's rotation in the Z axis.
</member>
<member name= "axis_lock_linear_x" type= "bool" setter= "set_axis_lock" getter= "get_axis_lock" default= "false" >
Lock the body's linear movement in the X axis.
</member>
<member name= "axis_lock_linear_y" type= "bool" setter= "set_axis_lock" getter= "get_axis_lock" default= "false" >
Lock the body's linear movement in the Y axis.
</member>
<member name= "axis_lock_linear_z" type= "bool" setter= "set_axis_lock" getter= "get_axis_lock" default= "false" >
Lock the body's linear movement in the Z axis.
</member>
</members>
2017-09-12 22:42:36 +02:00
</class>