virtualx-engine/doc/classes/PhysicsBody.xml
2017-09-13 08:53:01 +02:00

105 lines
2.8 KiB
XML

<?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.
</brief_description>
<description>
PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<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 collision exception list. This list contains bodies that this body will not collide with.
</description>
</method>
<method name="get_collision_layer" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_collision_layer_bit" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="bit" type="int">
</argument>
<description>
</description>
</method>
<method name="get_collision_mask" qualifiers="const">
<return type="int">
</return>
<description>
</description>
</method>
<method name="get_collision_mask_bit" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="bit" type="int">
</argument>
<description>
</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 collision exception list.
</description>
</method>
<method name="set_collision_layer">
<return type="void">
</return>
<argument index="0" name="layer" type="int">
</argument>
<description>
</description>
</method>
<method name="set_collision_layer_bit">
<return type="void">
</return>
<argument index="0" name="bit" type="int">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
<method name="set_collision_mask">
<return type="void">
</return>
<argument index="0" name="mask" type="int">
</argument>
<description>
</description>
</method>
<method name="set_collision_mask_bit">
<return type="void">
</return>
<argument index="0" name="bit" type="int">
</argument>
<argument index="1" name="value" type="bool">
</argument>
<description>
</description>
</method>
</methods>
<members>
<member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer">
</member>
<member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask">
</member>
</members>
<constants>
</constants>
</class>