Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: b51a272459
Branches Tags
godot-docs
/
classes
/
class_staticbody.rst

class_staticbody.rst 4.7 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
    3. 

  3. 

  4. .. _class_StaticBody:
    5. 

  5. 

  6. StaticBody
    7. 

  7. ==========
    8. 

  8. 

  9. **Inherits:** :ref:`PhysicsBody<class_physicsbody>` **<** :ref:`CollisionObject<class_collisionobject>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    10. 

  10. 

  11. **Category:** Core
    12. 

  12. 

  13. Brief Description
    14. 

  14. -----------------
    15. 

  15. 

  16. PhysicsBody for static collision objects.
    17. 

  17. 

  18. Member Functions
    19. 

  19. ----------------
    20. 

  20. 

  21. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    22. 

  22. | void                           | :ref:`set_constant_linear_velocity<class_StaticBody_set_constant_linear_velocity>`  **(** :ref:`Vector3<class_vector3>` vel  **)**   |
    23. 

  23. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    24. 

  24. | void                           | :ref:`set_constant_angular_velocity<class_StaticBody_set_constant_angular_velocity>`  **(** :ref:`Vector3<class_vector3>` vel  **)** |
    25. 

  25. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`Vector3<class_vector3>`  | :ref:`get_constant_linear_velocity<class_StaticBody_get_constant_linear_velocity>`  **(** **)** const                                |
    27. 

  27. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`Vector3<class_vector3>`  | :ref:`get_constant_angular_velocity<class_StaticBody_get_constant_angular_velocity>`  **(** **)** const                              |
    29. 

  29. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | void                           | :ref:`set_friction<class_StaticBody_set_friction>`  **(** :ref:`float<class_float>` friction  **)**                                  |
    31. 

  31. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`float<class_float>`      | :ref:`get_friction<class_StaticBody_get_friction>`  **(** **)** const                                                                |
    33. 

  33. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | void                           | :ref:`set_bounce<class_StaticBody_set_bounce>`  **(** :ref:`float<class_float>` bounce  **)**                                        |
    35. 

  35. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`float<class_float>`      | :ref:`get_bounce<class_StaticBody_get_bounce>`  **(** **)** const                                                                    |
    37. 

  37. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. 

  39. Description
    40. 

  40. -----------
    41. 

  41. 

  42. StaticBody implements a static collision :ref:`Node<class_node>`, by utilizing a rigid body in the :ref:`PhysicsServer<class_physicsserver>`. Static bodies are used for static collision. For more information on physics body nodes, see :ref:`PhysicsBody<class_physicsbody>`.
    43. 

  43. 

  44. Member Function Description
    45. 

  45. ---------------------------
    46. 

  46. 

  47. .. _class_StaticBody_set_constant_linear_velocity:
    48. 

  48. 

  49. - void  **set_constant_linear_velocity**  **(** :ref:`Vector3<class_vector3>` vel  **)**
    50. 

  50. 

  51. .. _class_StaticBody_set_constant_angular_velocity:
    52. 

  52. 

  53. - void  **set_constant_angular_velocity**  **(** :ref:`Vector3<class_vector3>` vel  **)**
    54. 

  54. 

  55. .. _class_StaticBody_get_constant_linear_velocity:
    56. 

  56. 

  57. - :ref:`Vector3<class_vector3>`  **get_constant_linear_velocity**  **(** **)** const
    58. 

  58. 

  59. .. _class_StaticBody_get_constant_angular_velocity:
    60. 

  60. 

  61. - :ref:`Vector3<class_vector3>`  **get_constant_angular_velocity**  **(** **)** const
    62. 

  62. 

  63. .. _class_StaticBody_set_friction:
    64. 

  64. 

  65. - void  **set_friction**  **(** :ref:`float<class_float>` friction  **)**
    66. 

  66. 

  67. .. _class_StaticBody_get_friction:
    68. 

  68. 

  69. - :ref:`float<class_float>`  **get_friction**  **(** **)** const
    70. 

  70. 

  71. .. _class_StaticBody_set_bounce:
    72. 

  72. 

  73. - void  **set_bounce**  **(** :ref:`float<class_float>` bounce  **)**
    74. 

  74. 

  75. .. _class_StaticBody_get_bounce:
    76. 

  76. 

  77. - :ref:`float<class_float>`  **get_bounce**  **(** **)** const
    78. 

  78. 

  79.