Files
godot-docs/classes/class_physicsmaterial.rst
2020-01-21 09:28:25 +01:00

92 lines
2.7 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>`
**Category:** Core
Brief Description
-----------------
A material for physics properties.
Properties
----------
+---------------------------+------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`absorbent<class_PhysicsMaterial_property_absorbent>` |
+---------------------------+------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`bounce<class_PhysicsMaterial_property_bounce>` |
+---------------------------+------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`friction<class_PhysicsMaterial_property_friction>` |
+---------------------------+------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rough<class_PhysicsMaterial_property_rough>` |
+---------------------------+------------------------------------------------------------+
Description
-----------
Provides a means of modifying the collision properties of a :ref:`PhysicsBody<class_PhysicsBody>`.
Property Descriptions
---------------------
.. _class_PhysicsMaterial_property_absorbent:
- :ref:`bool<class_bool>` **absorbent**
+----------+----------------------+
| *Setter* | set_absorbent(value) |
+----------+----------------------+
| *Getter* | is_absorbent() |
+----------+----------------------+
----
.. _class_PhysicsMaterial_property_bounce:
- :ref:`float<class_float>` **bounce**
+----------+-------------------+
| *Setter* | set_bounce(value) |
+----------+-------------------+
| *Getter* | get_bounce() |
+----------+-------------------+
The body's bounciness. Default value: ``0``.
----
.. _class_PhysicsMaterial_property_friction:
- :ref:`float<class_float>` **friction**
+----------+---------------------+
| *Setter* | set_friction(value) |
+----------+---------------------+
| *Getter* | get_friction() |
+----------+---------------------+
The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``.
----
.. _class_PhysicsMaterial_property_rough:
- :ref:`bool<class_bool>` **rough**
+----------+------------------+
| *Setter* | set_rough(value) |
+----------+------------------+
| *Getter* | is_rough() |
+----------+------------------+