class_rayshape2d.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the RayShape2D.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_RayShape2D:
  5. RayShape2D
  6. ==========
  7. **Inherits:** :ref:`Shape2D<class_shape2d>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Ray shape for 2D collisions.
  12. Member Functions
  13. ----------------
  14. +----------------------------+-----------------------------------------------------------------------------------------------+
  15. | :ref:`float<class_float>` | :ref:`get_length<class_RayShape2D_get_length>` **(** **)** const |
  16. +----------------------------+-----------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_length<class_RayShape2D_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 2D collisions. 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_RayShape2D_get_length:
  28. - :ref:`float<class_float>` **get_length** **(** **)** const
  29. Return the length of the ray.
  30. .. _class_RayShape2D_set_length:
  31. - void **set_length** **(** :ref:`float<class_float>` length **)**
  32. Set the length of the ray.