classref: Sync with latest 4.0-dev

classes/class_pointlight2d.rst

@@ -0,0 +1,97 @@
+:github_url: hide
+
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the PointLight2D.xml source instead.
+.. The source is found in doc/classes or modules/<name>/doc_classes.
+
+.. _class_PointLight2D:
+
+PointLight2D
+============
+
+**Inherits:** :ref:`Light2D<class_Light2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
+
+
+
+Properties
+----------
+
++-----------------------------------+-----------------------------------------------------------------+-------------------+
+| :ref:`float<class_float>`         | :ref:`height<class_PointLight2D_property_height>`               | ``0.0``           |
++-----------------------------------+-----------------------------------------------------------------+-------------------+
+| :ref:`Vector2<class_Vector2>`     | :ref:`offset<class_PointLight2D_property_offset>`               | ``Vector2(0, 0)`` |
++-----------------------------------+-----------------------------------------------------------------+-------------------+
+| :ref:`Texture2D<class_Texture2D>` | :ref:`texture<class_PointLight2D_property_texture>`             |                   |
++-----------------------------------+-----------------------------------------------------------------+-------------------+
+| :ref:`float<class_float>`         | :ref:`texture_scale<class_PointLight2D_property_texture_scale>` | ``1.0``           |
++-----------------------------------+-----------------------------------------------------------------+-------------------+
+
+Property Descriptions
+---------------------
+
+.. _class_PointLight2D_property_height:
+
+- :ref:`float<class_float>` **height**
+
++-----------+-------------------+
+| *Default* | ``0.0``           |
++-----------+-------------------+
+| *Setter*  | set_height(value) |
++-----------+-------------------+
+| *Getter*  | get_height()      |
++-----------+-------------------+
+
+The height of the light. Used with 2D normal mapping.
+
+----
+
+.. _class_PointLight2D_property_offset:
+
+- :ref:`Vector2<class_Vector2>` **offset**
+
++-----------+---------------------------+
+| *Default* | ``Vector2(0, 0)``         |
++-----------+---------------------------+
+| *Setter*  | set_texture_offset(value) |
++-----------+---------------------------+
+| *Getter*  | get_texture_offset()      |
++-----------+---------------------------+
+
+The offset of the light's :ref:`texture<class_PointLight2D_property_texture>`.
+
+----
+
+.. _class_PointLight2D_property_texture:
+
+- :ref:`Texture2D<class_Texture2D>` **texture**
+
++----------+--------------------+
+| *Setter* | set_texture(value) |
++----------+--------------------+
+| *Getter* | get_texture()      |
++----------+--------------------+
+
+:ref:`Texture2D<class_Texture2D>` used for the light's appearance.
+
+----
+
+.. _class_PointLight2D_property_texture_scale:
+
+- :ref:`float<class_float>` **texture_scale**
+
++-----------+--------------------------+
+| *Default* | ``1.0``                  |
++-----------+--------------------------+
+| *Setter*  | set_texture_scale(value) |
++-----------+--------------------------+
+| *Getter*  | get_texture_scale()      |
++-----------+--------------------------+
+
+The :ref:`texture<class_PointLight2D_property_texture>`'s scale factor.
+
+.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
+.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
+.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
+.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
+.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
+.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`