OccluderPolygon2D.xml 1.6 KB

123456789101112131415161718192021222324252627282930313233343536
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="OccluderPolygon2D" inherits="Resource" version="3.4">
  3. <brief_description>
  4. Defines a 2D polygon for LightOccluder2D.
  5. </brief_description>
  6. <description>
  7. Editor facility that helps you draw a 2D polygon used as resource for [LightOccluder2D].
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <methods>
  12. </methods>
  13. <members>
  14. <member name="closed" type="bool" setter="set_closed" getter="is_closed" default="true">
  15. If [code]true[/code], closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction.
  16. </member>
  17. <member name="cull_mode" type="int" setter="set_cull_mode" getter="get_cull_mode" enum="OccluderPolygon2D.CullMode" default="0">
  18. The culling mode to use.
  19. </member>
  20. <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" default="PoolVector2Array( )">
  21. A [Vector2] array with the index for polygon's vertices positions.
  22. [b]Note:[/b] The returned value is a copy of the underlying array, rather than a reference.
  23. </member>
  24. </members>
  25. <constants>
  26. <constant name="CULL_DISABLED" value="0" enum="CullMode">
  27. Culling is disabled. See [member cull_mode].
  28. </constant>
  29. <constant name="CULL_CLOCKWISE" value="1" enum="CullMode">
  30. Culling is performed in the clockwise direction. See [member cull_mode].
  31. </constant>
  32. <constant name="CULL_COUNTER_CLOCKWISE" value="2" enum="CullMode">
  33. Culling is performed in the counterclockwise direction. See [member cull_mode].
  34. </constant>
  35. </constants>
  36. </class>