Files
godot-docs/classes/class_rayshape2d.rst
2018-03-28 11:50:20 +02:00

36 lines
1007 B
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the RayShape2D.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_RayShape2D:
RayShape2D
==========
**Inherits:** :ref:`Shape2D<class_shape2d>` **<** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Ray shape for 2D collisions.
Member Variables
----------------
.. _class_RayShape2D_length:
- :ref:`float<class_float>` **length** - The ray's length.
.. _class_RayShape2D_slips_on_slope:
- :ref:`bool<class_bool>` **slips_on_slope** - If ``true`` allow the shape to return the correct normal. Default value: ``false``.
Description
-----------
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.