class_physicsmaterial.rst 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the PhysicsMaterial.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_PhysicsMaterial:
  6. PhysicsMaterial
  7. ===============
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. A material for physics properties.
  13. Properties
  14. ----------
  15. +---------------------------+------------------------------------------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`absorbent<class_PhysicsMaterial_property_absorbent>` |
  17. +---------------------------+------------------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`bounce<class_PhysicsMaterial_property_bounce>` |
  19. +---------------------------+------------------------------------------------------------+
  20. | :ref:`float<class_float>` | :ref:`friction<class_PhysicsMaterial_property_friction>` |
  21. +---------------------------+------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`rough<class_PhysicsMaterial_property_rough>` |
  23. +---------------------------+------------------------------------------------------------+
  24. Description
  25. -----------
  26. Provides a means of modifying the collision properties of a :ref:`PhysicsBody<class_PhysicsBody>`.
  27. Property Descriptions
  28. ---------------------
  29. .. _class_PhysicsMaterial_property_absorbent:
  30. - :ref:`bool<class_bool>` **absorbent**
  31. +----------+----------------------+
  32. | *Setter* | set_absorbent(value) |
  33. +----------+----------------------+
  34. | *Getter* | is_absorbent() |
  35. +----------+----------------------+
  36. ----
  37. .. _class_PhysicsMaterial_property_bounce:
  38. - :ref:`float<class_float>` **bounce**
  39. +----------+-------------------+
  40. | *Setter* | set_bounce(value) |
  41. +----------+-------------------+
  42. | *Getter* | get_bounce() |
  43. +----------+-------------------+
  44. The body's bounciness. Default value: ``0``.
  45. ----
  46. .. _class_PhysicsMaterial_property_friction:
  47. - :ref:`float<class_float>` **friction**
  48. +----------+---------------------+
  49. | *Setter* | set_friction(value) |
  50. +----------+---------------------+
  51. | *Getter* | get_friction() |
  52. +----------+---------------------+
  53. The body's friction. Values range from ``0`` (frictionless) to ``1`` (maximum friction). Default value: ``1``.
  54. ----
  55. .. _class_PhysicsMaterial_property_rough:
  56. - :ref:`bool<class_bool>` **rough**
  57. +----------+------------------+
  58. | *Setter* | set_rough(value) |
  59. +----------+------------------+
  60. | *Getter* | is_rough() |
  61. +----------+------------------+