class_bakedlightmapdata.rst 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the BakedLightmapData.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_BakedLightmapData:
  6. BakedLightmapData
  7. =================
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
  12. | :ref:`AABB<class_AABB>` | :ref:`bounds<class_BakedLightmapData_property_bounds>` | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
  13. +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
  14. | :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 )`` |
  15. +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
  16. | :ref:`int<class_int>` | :ref:`cell_subdiv<class_BakedLightmapData_property_cell_subdiv>` | ``1`` |
  17. +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
  18. | :ref:`float<class_float>` | :ref:`energy<class_BakedLightmapData_property_energy>` | ``1.0`` |
  19. +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
  20. | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`octree<class_BakedLightmapData_property_octree>` | ``PoolByteArray( )`` |
  21. +-------------------------------------------+------------------------------------------------------------------------------------+-----------------------------------------------------+
  22. Methods
  23. -------
  24. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`add_user<class_BakedLightmapData_method_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)** |
  26. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`clear_users<class_BakedLightmapData_method_clear_users>` **(** **)** |
  28. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`int<class_int>` | :ref:`get_user_count<class_BakedLightmapData_method_get_user_count>` **(** **)** |const| |
  30. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Texture<class_Texture>` | :ref:`get_user_lightmap<class_BakedLightmapData_method_get_user_lightmap>` **(** :ref:`int<class_int>` user_idx **)** |const| |
  32. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_BakedLightmapData_method_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** |const| |
  34. +---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. Property Descriptions
  36. ---------------------
  37. .. _class_BakedLightmapData_property_bounds:
  38. - :ref:`AABB<class_AABB>` **bounds**
  39. +-----------+------------------------------+
  40. | *Default* | ``AABB( 0, 0, 0, 0, 0, 0 )`` |
  41. +-----------+------------------------------+
  42. | *Setter* | set_bounds(value) |
  43. +-----------+------------------------------+
  44. | *Getter* | get_bounds() |
  45. +-----------+------------------------------+
  46. ----
  47. .. _class_BakedLightmapData_property_cell_space_transform:
  48. - :ref:`Transform<class_Transform>` **cell_space_transform**
  49. +-----------+-----------------------------------------------------+
  50. | *Default* | ``Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )`` |
  51. +-----------+-----------------------------------------------------+
  52. | *Setter* | set_cell_space_transform(value) |
  53. +-----------+-----------------------------------------------------+
  54. | *Getter* | get_cell_space_transform() |
  55. +-----------+-----------------------------------------------------+
  56. ----
  57. .. _class_BakedLightmapData_property_cell_subdiv:
  58. - :ref:`int<class_int>` **cell_subdiv**
  59. +-----------+------------------------+
  60. | *Default* | ``1`` |
  61. +-----------+------------------------+
  62. | *Setter* | set_cell_subdiv(value) |
  63. +-----------+------------------------+
  64. | *Getter* | get_cell_subdiv() |
  65. +-----------+------------------------+
  66. ----
  67. .. _class_BakedLightmapData_property_energy:
  68. - :ref:`float<class_float>` **energy**
  69. +-----------+-------------------+
  70. | *Default* | ``1.0`` |
  71. +-----------+-------------------+
  72. | *Setter* | set_energy(value) |
  73. +-----------+-------------------+
  74. | *Getter* | get_energy() |
  75. +-----------+-------------------+
  76. ----
  77. .. _class_BakedLightmapData_property_octree:
  78. - :ref:`PoolByteArray<class_PoolByteArray>` **octree**
  79. +-----------+-----------------------+
  80. | *Default* | ``PoolByteArray( )`` |
  81. +-----------+-----------------------+
  82. | *Setter* | set_octree(value) |
  83. +-----------+-----------------------+
  84. | *Getter* | get_octree() |
  85. +-----------+-----------------------+
  86. Method Descriptions
  87. -------------------
  88. .. _class_BakedLightmapData_method_add_user:
  89. - void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Texture<class_Texture>` lightmap, :ref:`int<class_int>` instance **)**
  90. ----
  91. .. _class_BakedLightmapData_method_clear_users:
  92. - void **clear_users** **(** **)**
  93. ----
  94. .. _class_BakedLightmapData_method_get_user_count:
  95. - :ref:`int<class_int>` **get_user_count** **(** **)** |const|
  96. ----
  97. .. _class_BakedLightmapData_method_get_user_lightmap:
  98. - :ref:`Texture<class_Texture>` **get_user_lightmap** **(** :ref:`int<class_int>` user_idx **)** |const|
  99. ----
  100. .. _class_BakedLightmapData_method_get_user_path:
  101. - :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** |const|
  102. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  103. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  104. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`