class_rayshape2d.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_RayShape2D:
  4. RayShape2D
  5. ==========
  6. **Inherits:** :ref:`Shape2D<class_shape2d>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Ray 2D shape resource for physics.
  11. Member Functions
  12. ----------------
  13. +----------------------------+-----------------------------------------------------------------------------------------------+
  14. | :ref:`float<class_float>` | :ref:`get_length<class_RayShape2D_get_length>` **(** **)** const |
  15. +----------------------------+-----------------------------------------------------------------------------------------------+
  16. | void | :ref:`set_length<class_RayShape2D_set_length>` **(** :ref:`float<class_float>` length **)** |
  17. +----------------------------+-----------------------------------------------------------------------------------------------+
  18. Description
  19. -----------
  20. Ray 2D shape resource for physics. 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.
  21. Member Function Description
  22. ---------------------------
  23. .. _class_RayShape2D_get_length:
  24. - :ref:`float<class_float>` **get_length** **(** **)** const
  25. Return the length of the ray.
  26. .. _class_RayShape2D_set_length:
  27. - void **set_length** **(** :ref:`float<class_float>` length **)**
  28. Set the length of the ray.