virtualx-engine/doc/classes/PhysicsBody.xml

37 lines
1.2 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
2021-11-05 15:02:42 +01:00
<class name="PhysicsBody" inherits="CollisionObject" version="3.5">
<brief_description>
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 *Body types inherit from it.
</description>
<tutorials>
<link>$DOCS_URL/tutorials/physics/physics_introduction.html</link>
</tutorials>
<methods>
<method name="add_collision_exception_with">
<return type="void" />
<argument index="0" name="body" type="Node" />
<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="Array" />
<description>
Returns an array of nodes that were added as collision exceptions for this body.
</description>
</method>
<method name="remove_collision_exception_with">
<return type="void" />
<argument index="0" name="body" type="Node" />
<description>
Removes a body from the list of bodies that this body can't collide with.
</description>
</method>
</methods>
<constants>
</constants>
</class>