class_lightmapgidata.rst 5.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the LightmapGIData.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_LightmapGIData:
  6. LightmapGIData
  7. ==============
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  9. Properties
  10. ----------
  11. +---------------------------------------------+-------------------------------------------------------------------+
  12. | :ref:`TextureLayered<class_TextureLayered>` | :ref:`light_texture<class_LightmapGIData_property_light_texture>` |
  13. +---------------------------------------------+-------------------------------------------------------------------+
  14. Methods
  15. -------
  16. +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`add_user<class_LightmapGIData_method_add_user>` **(** :ref:`NodePath<class_NodePath>` path, :ref:`Rect2<class_Rect2>` uv_scale, :ref:`int<class_int>` slice_index, :ref:`int<class_int>` sub_instance **)** |
  18. +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`clear_users<class_LightmapGIData_method_clear_users>` **(** **)** |
  20. +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_user_count<class_LightmapGIData_method_get_user_count>` **(** **)** |const| |
  22. +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`NodePath<class_NodePath>` | :ref:`get_user_path<class_LightmapGIData_method_get_user_path>` **(** :ref:`int<class_int>` user_idx **)** |const| |
  24. +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`bool<class_bool>` | :ref:`is_using_spherical_harmonics<class_LightmapGIData_method_is_using_spherical_harmonics>` **(** **)** |const| |
  26. +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`set_uses_spherical_harmonics<class_LightmapGIData_method_set_uses_spherical_harmonics>` **(** :ref:`bool<class_bool>` uses_spherical_harmonics **)** |
  28. +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. Property Descriptions
  30. ---------------------
  31. .. _class_LightmapGIData_property_light_texture:
  32. - :ref:`TextureLayered<class_TextureLayered>` **light_texture**
  33. +----------+--------------------------+
  34. | *Setter* | set_light_texture(value) |
  35. +----------+--------------------------+
  36. | *Getter* | get_light_texture() |
  37. +----------+--------------------------+
  38. Method Descriptions
  39. -------------------
  40. .. _class_LightmapGIData_method_add_user:
  41. - void **add_user** **(** :ref:`NodePath<class_NodePath>` path, :ref:`Rect2<class_Rect2>` uv_scale, :ref:`int<class_int>` slice_index, :ref:`int<class_int>` sub_instance **)**
  42. ----
  43. .. _class_LightmapGIData_method_clear_users:
  44. - void **clear_users** **(** **)**
  45. ----
  46. .. _class_LightmapGIData_method_get_user_count:
  47. - :ref:`int<class_int>` **get_user_count** **(** **)** |const|
  48. ----
  49. .. _class_LightmapGIData_method_get_user_path:
  50. - :ref:`NodePath<class_NodePath>` **get_user_path** **(** :ref:`int<class_int>` user_idx **)** |const|
  51. ----
  52. .. _class_LightmapGIData_method_is_using_spherical_harmonics:
  53. - :ref:`bool<class_bool>` **is_using_spherical_harmonics** **(** **)** |const|
  54. ----
  55. .. _class_LightmapGIData_method_set_uses_spherical_harmonics:
  56. - void **set_uses_spherical_harmonics** **(** :ref:`bool<class_bool>` uses_spherical_harmonics **)**
  57. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  58. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  59. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  60. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  61. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  62. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`