Files
godot-docs/classes/class_rayshape2d.rst
Rémi Verschelde 1b5e8c18fd classref: Order everything alphabetically
And sync with current 2.0.x sources.
2016-06-25 02:10:54 +02:00

48 lines
1.6 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _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 2D shape resource for physics.
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_RayShape2D_get_length>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`set_length<class_RayShape2D_set_length>` **(** :ref:`float<class_float>` length **)** |
+----------------------------+-----------------------------------------------------------------------------------------------+
Description
-----------
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.
Member Function Description
---------------------------
.. _class_RayShape2D_get_length:
- :ref:`float<class_float>` **get_length** **(** **)** const
Return the length of the ray.
.. _class_RayShape2D_set_length:
- void **set_length** **(** :ref:`float<class_float>` length **)**
Set the length of the ray.