Files
godot-docs/classes/class_physicsmaterial.rst
Rémi Verschelde 2b4319bc29 Sync classref with current source
Changes order of brief/long descriptions and removes category
as per godotengine/godot#35132.
2020-01-15 00:51:47 +01:00

95 lines
3.0 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PhysicsMaterial.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_PhysicsMaterial:
PhysicsMaterial
===============
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
A material for physics properties.
Description
-----------
Provides a means of modifying the collision properties of a :ref:`PhysicsBody<class_PhysicsBody>`.
Properties
----------
+---------------------------+------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`absorbent<class_PhysicsMaterial_property_absorbent>` | false |
+---------------------------+------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`bounce<class_PhysicsMaterial_property_bounce>` | 0.0 |
+---------------------------+------------------------------------------------------------+-------+
| :ref:`float<class_float>` | :ref:`friction<class_PhysicsMaterial_property_friction>` | 1.0 |
+---------------------------+------------------------------------------------------------+-------+
| :ref:`bool<class_bool>` | :ref:`rough<class_PhysicsMaterial_property_rough>` | false |
+---------------------------+------------------------------------------------------------+-------+
Property Descriptions
---------------------
.. _class_PhysicsMaterial_property_absorbent:
- :ref:`bool<class_bool>` **absorbent**
+-----------+----------------------+
| *Default* | false |
+-----------+----------------------+
| *Setter* | set_absorbent(value) |
+-----------+----------------------+
| *Getter* | is_absorbent() |
+-----------+----------------------+
----
.. _class_PhysicsMaterial_property_bounce:
- :ref:`float<class_float>` **bounce**
+-----------+-------------------+
| *Default* | 0.0 |
+-----------+-------------------+
| *Setter* | set_bounce(value) |
+-----------+-------------------+
| *Getter* | get_bounce() |
+-----------+-------------------+
The body's bounciness. Values range from ``0`` (no bounce) to ``1`` (full bounciness).
----
.. _class_PhysicsMaterial_property_friction:
- :ref:`float<class_float>` **friction**
+-----------+---------------------+
| *Default* | 1.0 |
+-----------+---------------------+
| *Setter* | set_friction(value) |
+-----------+---------------------+
| *Getter* | get_friction() |
+-----------+---------------------+
The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction).
----
.. _class_PhysicsMaterial_property_rough:
- :ref:`bool<class_bool>` **rough**
+-----------+------------------+
| *Default* | false |
+-----------+------------------+
| *Setter* | set_rough(value) |
+-----------+------------------+
| *Getter* | is_rough() |
+-----------+------------------+