CSGCylinder3D.xml 1.9 KB

12345678910111213141516171819202122232425262728293031323334
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CSGCylinder3D" inherits="CSGPrimitive3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. A CSG Cylinder shape.
  5. </brief_description>
  6. <description>
  7. This node allows you to create a cylinder (or cone) for use with the CSG system.
  8. [b]Note:[/b] CSG nodes are intended to be used for level prototyping. Creating CSG nodes has a significant CPU cost compared to creating a [MeshInstance3D] with a [PrimitiveMesh]. Moving a CSG node within another CSG node also has a significant CPU cost, so it should be avoided during gameplay.
  9. </description>
  10. <tutorials>
  11. <link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
  12. </tutorials>
  13. <members>
  14. <member name="cone" type="bool" setter="set_cone" getter="is_cone" default="false">
  15. If [code]true[/code] a cone is created, the [member radius] will only apply to one side.
  16. </member>
  17. <member name="height" type="float" setter="set_height" getter="get_height" default="2.0">
  18. The height of the cylinder.
  19. </member>
  20. <member name="material" type="Material" setter="set_material" getter="get_material">
  21. The material used to render the cylinder.
  22. </member>
  23. <member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.5">
  24. The radius of the cylinder.
  25. </member>
  26. <member name="sides" type="int" setter="set_sides" getter="get_sides" default="8">
  27. The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.
  28. </member>
  29. <member name="smooth_faces" type="bool" setter="set_smooth_faces" getter="get_smooth_faces" default="true">
  30. If [code]true[/code] the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If [code]false[/code] the cylinder will have a flat shaded look.
  31. </member>
  32. </members>
  33. </class>