Light2D.xml 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="Light2D" inherits="Node2D" category="Core" version="3.1">
  3. <brief_description>
  4. Casts light in a 2D environment.
  5. </brief_description>
  6. <description>
  7. Casts light in a 2D environment. Light is defined by a (usually grayscale) texture, a color, an energy value, a mode (see constants), and various other parameters (range and shadows-related). Note that Light2D can be used as a mask.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <demos>
  12. </demos>
  13. <methods>
  14. </methods>
  15. <members>
  16. <member name="color" type="Color" setter="set_color" getter="get_color">
  17. The Light2D's [Color].
  18. </member>
  19. <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only">
  20. If [code]true[/code], Light2D will only appear when editing the scene. Default value: [code]false[/code].
  21. </member>
  22. <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled">
  23. If [code]true[/code], Light2D will emit light. Default value: [code]true[/code].
  24. </member>
  25. <member name="energy" type="float" setter="set_energy" getter="get_energy">
  26. The Light2D's energy value. The larger the value, the stronger the light.
  27. </member>
  28. <member name="mode" type="int" setter="set_mode" getter="get_mode" enum="Light2D.Mode">
  29. The Light2D's mode. See MODE_* constants for values.
  30. </member>
  31. <member name="offset" type="Vector2" setter="set_texture_offset" getter="get_texture_offset">
  32. The offset of the Light2D's [code]texture[/code].
  33. </member>
  34. <member name="range_height" type="float" setter="set_height" getter="get_height">
  35. The height of the Light2D. Used with 2D normal mapping.
  36. </member>
  37. <member name="range_item_cull_mask" type="int" setter="set_item_cull_mask" getter="get_item_cull_mask">
  38. The layer mask. Only objects with a matching mask will be affected by the Light2D.
  39. </member>
  40. <member name="range_layer_max" type="int" setter="set_layer_range_max" getter="get_layer_range_max">
  41. Maximum layer value of objects that are affected by the Light2D. Default value: [code]0[/code].
  42. </member>
  43. <member name="range_layer_min" type="int" setter="set_layer_range_min" getter="get_layer_range_min">
  44. Minimum layer value of objects that are affected by the Light2D. Default value: [code]0[/code].
  45. </member>
  46. <member name="range_z_max" type="int" setter="set_z_range_max" getter="get_z_range_max">
  47. Maximum [code]Z[/code] value of objects that are affected by the Light2D. Default value: [code]1024[/code].
  48. </member>
  49. <member name="range_z_min" type="int" setter="set_z_range_min" getter="get_z_range_min">
  50. Minimum [code]z[/code] value of objects that are affected by the Light2D. Default value: [code]-1024[/code].
  51. </member>
  52. <member name="shadow_buffer_size" type="int" setter="set_shadow_buffer_size" getter="get_shadow_buffer_size">
  53. Shadow buffer size. Default value: [code]2048[/code].
  54. </member>
  55. <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color">
  56. [Color] of shadows cast by the Light2D.
  57. </member>
  58. <member name="shadow_enabled" type="bool" setter="set_shadow_enabled" getter="is_shadow_enabled">
  59. If [code]true[/code], the Light2D will cast shadows. Default value: [code]false[/code].
  60. </member>
  61. <member name="shadow_filter" type="int" setter="set_shadow_filter" getter="get_shadow_filter" enum="Light2D.ShadowFilter">
  62. Shadow filter type. Use SHADOW_FILTER_* constants to set [code]shadow_filter[/code]. Default value: [code]None[/code].
  63. </member>
  64. <member name="shadow_filter_smooth" type="float" setter="set_shadow_smooth" getter="get_shadow_smooth">
  65. Smoothing value for shadows.
  66. </member>
  67. <member name="shadow_gradient_length" type="float" setter="set_shadow_gradient_length" getter="get_shadow_gradient_length">
  68. Smooth shadow gradient length.
  69. </member>
  70. <member name="shadow_item_cull_mask" type="int" setter="set_item_shadow_cull_mask" getter="get_item_shadow_cull_mask">
  71. The shadow mask. Used with [LightOccluder2D] to cast shadows. Only occluders with a matching shadow mask will cast shadows.
  72. </member>
  73. <member name="texture" type="Texture" setter="set_texture" getter="get_texture">
  74. [Texture] used for the Light2D's appearance.
  75. </member>
  76. <member name="texture_scale" type="float" setter="set_texture_scale" getter="get_texture_scale">
  77. The [code]texture[/code]'s scale factor.
  78. </member>
  79. </members>
  80. <constants>
  81. <constant name="MODE_ADD" value="0" enum="Mode">
  82. Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behaviour of a light.
  83. </constant>
  84. <constant name="MODE_SUB" value="1" enum="Mode">
  85. Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect.
  86. </constant>
  87. <constant name="MODE_MIX" value="2" enum="Mode">
  88. Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation.
  89. </constant>
  90. <constant name="MODE_MASK" value="3" enum="Mode">
  91. The light texture of the Light2D is used as a mask, hiding or revealing parts of the screen underneath depending on the value of each pixel of the light (mask) texture.
  92. </constant>
  93. <constant name="SHADOW_FILTER_NONE" value="0" enum="ShadowFilter">
  94. No filter applies to the shadow map. See [method shadow_filter].
  95. </constant>
  96. <constant name="SHADOW_FILTER_PCF3" value="1" enum="ShadowFilter">
  97. Percentage closer filtering (3 samples) applies to the shadow map. See [method shadow_filter].
  98. </constant>
  99. <constant name="SHADOW_FILTER_PCF5" value="2" enum="ShadowFilter">
  100. Percentage closer filtering (5 samples) applies to the shadow map. See [method shadow_filter].
  101. </constant>
  102. <constant name="SHADOW_FILTER_PCF7" value="3" enum="ShadowFilter">
  103. Percentage closer filtering (7 samples) applies to the shadow map. See [method shadow_filter].
  104. </constant>
  105. <constant name="SHADOW_FILTER_PCF9" value="4" enum="ShadowFilter">
  106. Percentage closer filtering (9 samples) applies to the shadow map. See [method shadow_filter].
  107. </constant>
  108. <constant name="SHADOW_FILTER_PCF13" value="5" enum="ShadowFilter">
  109. Percentage closer filtering (13 samples) applies to the shadow map. See [method shadow_filter].
  110. </constant>
  111. </constants>
  112. </class>