Files
godot-docs/classes/class_bakedlightmapdata.rst
Rémi Verschelde 782dd64a19 classref: Use code markup for default values/overrides
Sync with godotengine/godot#35357.
Fixes #3071.
2020-01-20 12:41:39 +01:00

148 lines
7.6 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the BakedLightmapData.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_BakedLightmapData:
BakedLightmapData
=================
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Properties
----------
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
| :ref:`Transform<class_Transform>` | :ref:`cell_space_transform<class_BakedLightmapData_property_cell_space_transform>` | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
| :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` | ``1`` |
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
| :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` | ``1.0`` |
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` | ``PoolByteArray( )`` |
+-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
Methods
-------
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_user<class_BakedLightmapData_method_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)** |
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_users<class_BakedLightmapData_method_clear_users>` **(** **)** |
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_method_get_user_count>` **(** **)** const |
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_Texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_method_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** const |
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_BakedLightmapData_method_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** const |
+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_BakedLightmapData_property_bounds:
- :ref:`AABB<class_AABB>` **bounds**
+-----------+------------------------------+
| *Default* | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
+-----------+------------------------------+
| *Setter* | set_bounds(value) |
+-----------+------------------------------+
| *Getter* | get_bounds() |
+-----------+------------------------------+
----
.. _class_BakedLightmapData_property_cell_space_transform:
- :ref:`Transform<class_Transform>` **cell_space_transform**
+-----------+-----------------------------------------------------+
| *Default* | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
+-----------+-----------------------------------------------------+
| *Setter* | set_cell_space_transform(value) |
+-----------+-----------------------------------------------------+
| *Getter* | get_cell_space_transform() |
+-----------+-----------------------------------------------------+
----
.. _class_BakedLightmapData_property_cell_subdiv:
- :ref:`int<class_int>` **cell_subdiv**
+-----------+------------------------+
| *Default* | ``1`` |
+-----------+------------------------+
| *Setter* | set_cell_subdiv(value) |
+-----------+------------------------+
| *Getter* | get_cell_subdiv() |
+-----------+------------------------+
----
.. _class_BakedLightmapData_property_energy:
- :ref:`float<class_float>` **energy**
+-----------+-------------------+
| *Default* | ``1.0`` |
+-----------+-------------------+
| *Setter* | set_energy(value) |
+-----------+-------------------+
| *Getter* | get_energy() |
+-----------+-------------------+
----
.. _class_BakedLightmapData_property_octree:
- :ref:`PoolByteArray<class_PoolByteArray>` **octree**
+-----------+-----------------------+
| *Default* | ``PoolByteArray( )`` |
+-----------+-----------------------+
| *Setter* | set_octree(value) |
+-----------+-----------------------+
| *Getter* | get_octree() |
+-----------+-----------------------+
Method Descriptions
-------------------
.. _class_BakedLightmapData_method_add_user:
- void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)**
----
.. _class_BakedLightmapData_method_clear_users:
- void **clear_users** **(** **)**
----
.. _class_BakedLightmapData_method_get_user_count:
- :ref:`int<class_int>` **get_user_count** **(** **)** const
----
.. _class_BakedLightmapData_method_get_user_lightmap:
- :ref:`Texture<class_Texture>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** const
----
.. _class_BakedLightmapData_method_get_user_path:
- :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** const