class_boxshape3d.rst 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the BoxShape3D.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_BoxShape3D:
  6. BoxShape3D
  7. ==========
  8. **Inherits:** :ref:`Shape3D<class_Shape3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Box shape resource.
  10. Description
  11. -----------
  12. 3D box shape that can be a child of a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`Area3D<class_Area3D>`.
  13. Tutorials
  14. ---------
  15. - `3D Physics Tests Demo <https://godotengine.org/asset-library/asset/675>`__
  16. - `3D Kinematic Character Demo <https://godotengine.org/asset-library/asset/126>`__
  17. - `3D Platformer Demo <https://godotengine.org/asset-library/asset/125>`__
  18. Properties
  19. ----------
  20. +-------------------------------+---------------------------------------------+----------------------+
  21. | :ref:`Vector3<class_Vector3>` | :ref:`size<class_BoxShape3D_property_size>` | ``Vector3(1, 1, 1)`` |
  22. +-------------------------------+---------------------------------------------+----------------------+
  23. Property Descriptions
  24. ---------------------
  25. .. _class_BoxShape3D_property_size:
  26. - :ref:`Vector3<class_Vector3>` **size**
  27. +-----------+----------------------+
  28. | *Default* | ``Vector3(1, 1, 1)`` |
  29. +-----------+----------------------+
  30. | *Setter* | set_size(value) |
  31. +-----------+----------------------+
  32. | *Getter* | get_size() |
  33. +-----------+----------------------+
  34. The box's width, height and depth.
  35. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  36. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  37. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  38. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  39. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  40. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`