FogVolume.xml 1.5 KB

1234567891011121314151617181920212223
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="FogVolume" inherits="VisualInstance3D" version="4.0">
  3. <brief_description>
  4. A node used to add local fog with the volumetric fog effect.
  5. </brief_description>
  6. <description>
  7. [FogVolume]s are used to add localized fog into the global volumetric fog effect.
  8. Performance of [FogVolume]s is directly related to their relative size on the screen and the complexity of their attached [FogMaterial]. It is best to keep [FogVolume]s relatively small and simple where possible.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <members>
  13. <member name="extents" type="Vector3" setter="set_extents" getter="get_extents" default="Vector3(1, 1, 1)">
  14. Sets the size of the [FogVolume] when [member shape] is [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID] or [constant RenderingServer.FOG_VOLUME_SHAPE_BOX].
  15. </member>
  16. <member name="material" type="Material" setter="set_material" getter="get_material">
  17. Sets the [Material] to be used by the [FogVolume]. Can be either a [FogMaterial] or a custom [ShaderMaterial].
  18. </member>
  19. <member name="shape" type="int" setter="set_shape" getter="get_shape" enum="RenderingServer.FogVolumeShape" default="1">
  20. Sets the shape of the [FogVolume] to either [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID], [constant RenderingServer.FOG_VOLUME_SHAPE_BOX], or [constant RenderingServer.FOG_VOLUME_SHAPE_ELLIPSOID] or [constant RenderingServer.FOG_VOLUME_SHAPE_WORLD].
  21. </member>
  22. </members>
  23. </class>