2018-05-12 09:38:00 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-03-01 01:44:37 +01:00
<class name= "CSGCylinder3D" inherits= "CSGPrimitive3D" version= "4.1" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../../../doc/class.xsd" >
2018-05-12 09:38:00 +02:00
<brief_description >
2018-07-19 11:31:12 +02:00
A CSG Cylinder shape.
2018-05-12 09:38:00 +02:00
</brief_description>
<description >
2018-07-19 11:31:12 +02:00
This node allows you to create a cylinder (or cone) for use with the CSG system.
2022-02-07 13:58:08 +01:00
[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.
2018-05-12 09:38:00 +02:00
</description>
<tutorials >
2022-02-07 13:58:08 +01:00
<link title= "Prototyping levels with CSG" > $DOCS_URL/tutorials/3d/csg_tools.html</link>
2018-05-12 09:38:00 +02:00
</tutorials>
<members >
2019-06-29 12:38:01 +02:00
<member name= "cone" type= "bool" setter= "set_cone" getter= "is_cone" default= "false" >
2019-04-17 13:42:56 +02:00
If [code]true[/code] a cone is created, the [member radius] will only apply to one side.
2018-05-12 09:38:00 +02:00
</member>
2021-12-31 00:20:56 +01:00
<member name= "height" type= "float" setter= "set_height" getter= "get_height" default= "2.0" >
2018-07-19 11:31:12 +02:00
The height of the cylinder.
2018-05-12 09:38:00 +02:00
</member>
2019-07-15 20:42:47 +02:00
<member name= "material" type= "Material" setter= "set_material" getter= "get_material" >
2018-07-19 11:31:12 +02:00
The material used to render the cylinder.
2018-05-12 09:38:00 +02:00
</member>
2021-12-31 00:20:56 +01:00
<member name= "radius" type= "float" setter= "set_radius" getter= "get_radius" default= "0.5" >
2018-07-19 11:31:12 +02:00
The radius of the cylinder.
2018-05-12 09:38:00 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "sides" type= "int" setter= "set_sides" getter= "get_sides" default= "8" >
2018-07-19 11:31:12 +02:00
The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.
2018-05-12 09:38:00 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "smooth_faces" type= "bool" setter= "set_smooth_faces" getter= "get_smooth_faces" default= "true" >
2019-04-17 13:42:56 +02:00
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.
2018-05-12 09:38:00 +02:00
</member>
</members>
</class>