class_rayshape.rst 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the RayShape.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_RayShape:
  5. RayShape
  6. ========
  7. **Inherits:** :ref:`Shape<class_shape>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Ray shape for 3D collisions.
  12. Member Functions
  13. ----------------
  14. +----------------------------+---------------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`get_length<class_RayShape_get_length>` **(** **)** const |
  16. +----------------------------+---------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_length<class_RayShape_set_length>` **(** :ref:`float<class_float>` length **)** |
  18. +----------------------------+---------------------------------------------------------------------------------------------+
  19. Member Variables
  20. ----------------
  21. - :ref:`float<class_float>` **length** - The ray's length.
  22. Description
  23. -----------
  24. Ray shape for 3D collisions, which can be set into a :ref:`PhysicsBody<class_physicsbody>` or :ref:`Area<class_area>`. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters.
  25. Member Function Description
  26. ---------------------------
  27. .. _class_RayShape_get_length:
  28. - :ref:`float<class_float>` **get_length** **(** **)** const
  29. .. _class_RayShape_set_length:
  30. - void **set_length** **(** :ref:`float<class_float>` length **)**