mirror of
https://github.com/godotengine/godot.git
synced 2024-12-15 10:12:40 +08:00
ba13d23140
PhysicsBody now has methods move_and_collide/test_move and needed properties for these methods: safe margin, locked axes (3D only). Moved collision_exceptions from StaticBody to PhysicsBody for 3D (same as 2D, and conforms to documentation). RigidBody doesn't have test_motion method anymore, it's now redundant with PhysicsBody.test_move.
85 lines
4.0 KiB
XML
85 lines
4.0 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="PhysicsBody2D" inherits="CollisionObject2D" version="4.0">
|
|
<brief_description>
|
|
Base class for all objects affected by physics in 2D space.
|
|
</brief_description>
|
|
<description>
|
|
PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Physics introduction">https://docs.godotengine.org/en/latest/tutorials/physics/physics_introduction.html</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="add_collision_exception_with">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="body" type="Node">
|
|
</argument>
|
|
<description>
|
|
Adds a body to the list of bodies that this body can't collide with.
|
|
</description>
|
|
</method>
|
|
<method name="get_collision_exceptions">
|
|
<return type="PhysicsBody2D[]">
|
|
</return>
|
|
<description>
|
|
Returns an array of nodes that were added as collision exceptions for this body.
|
|
</description>
|
|
</method>
|
|
<method name="move_and_collide">
|
|
<return type="KinematicCollision2D">
|
|
</return>
|
|
<argument index="0" name="rel_vec" type="Vector2">
|
|
</argument>
|
|
<argument index="1" name="infinite_inertia" type="bool" default="true">
|
|
</argument>
|
|
<argument index="2" name="exclude_raycast_shapes" type="bool" default="true">
|
|
</argument>
|
|
<argument index="3" name="test_only" type="bool" default="false">
|
|
</argument>
|
|
<description>
|
|
Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision2D], which contains information about the collision.
|
|
If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given.
|
|
</description>
|
|
</method>
|
|
<method name="remove_collision_exception_with">
|
|
<return type="void">
|
|
</return>
|
|
<argument index="0" name="body" type="Node">
|
|
</argument>
|
|
<description>
|
|
Removes a body from the list of bodies that this body can't collide with.
|
|
</description>
|
|
</method>
|
|
<method name="test_move">
|
|
<return type="bool">
|
|
</return>
|
|
<argument index="0" name="from" type="Transform2D">
|
|
</argument>
|
|
<argument index="1" name="rel_vec" type="Vector2">
|
|
</argument>
|
|
<argument index="2" name="infinite_inertia" type="bool" default="true">
|
|
</argument>
|
|
<argument index="3" name="exclude_raycast_shapes" type="bool" default="true">
|
|
</argument>
|
|
<argument index="4" name="collision" type="KinematicCollision2D" default="null">
|
|
</argument>
|
|
<description>
|
|
Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur.
|
|
[code]collision[/code] is an optional object of type [KinematicCollision2D], which contains additional information about the collision (should there be one).
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin" default="0.08">
|
|
Extra margin used for collision recovery in motion functions (see [method move_and_collide], [method CharacterBody2D.move_and_slide], [method CharacterBody2D.move_and_slide_with_snap]).
|
|
If the body is at least this close to another body, it will consider them to be colliding and will be pushed away before performing the actual motion.
|
|
A higher value means it's more flexible for detecting collision, which helps with consistently detecting walls and floors.
|
|
A lower value forces the collision algorithm to use more exact detection, so it can be used in cases that specifically require precision, e.g at very low scale to avoid visible jittering, or for stability with a stack of character bodies.
|
|
</member>
|
|
<member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable" override="true" default="false" />
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|