summaryrefslogtreecommitdiff
path: root/modules/csg/doc_classes/CSGCylinder3D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'modules/csg/doc_classes/CSGCylinder3D.xml')
-rw-r--r--modules/csg/doc_classes/CSGCylinder3D.xml35
1 files changed, 35 insertions, 0 deletions
diff --git a/modules/csg/doc_classes/CSGCylinder3D.xml b/modules/csg/doc_classes/CSGCylinder3D.xml
new file mode 100644
index 0000000000..bfd2a5d5f2
--- /dev/null
+++ b/modules/csg/doc_classes/CSGCylinder3D.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="CSGCylinder3D" inherits="CSGPrimitive3D" version="4.0">
+ <brief_description>
+ A CSG Cylinder shape.
+ </brief_description>
+ <description>
+ This node allows you to create a cylinder (or cone) for use with the CSG system.
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ </methods>
+ <members>
+ <member name="cone" type="bool" setter="set_cone" getter="is_cone" default="false">
+ If [code]true[/code] a cone is created, the [member radius] will only apply to one side.
+ </member>
+ <member name="height" type="float" setter="set_height" getter="get_height" default="1.0">
+ The height of the cylinder.
+ </member>
+ <member name="material" type="Material" setter="set_material" getter="get_material">
+ The material used to render the cylinder.
+ </member>
+ <member name="radius" type="float" setter="set_radius" getter="get_radius" default="1.0">
+ The radius of the cylinder.
+ </member>
+ <member name="sides" type="int" setter="set_sides" getter="get_sides" default="8">
+ The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.
+ </member>
+ <member name="smooth_faces" type="bool" setter="set_smooth_faces" getter="get_smooth_faces" default="true">
+ 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.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>