mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
128 lines
4.0 KiB
ReStructuredText
128 lines
4.0 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the CSGCylinder.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_CSGCylinder:
|
|
|
|
CSGCylinder
|
|
===========
|
|
|
|
**Inherits:** :ref:`CSGPrimitive<class_CSGPrimitive>` **<** :ref:`CSGShape<class_CSGShape>` **<** :ref:`VisualInstance<class_VisualInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
A CSG Cylinder shape.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+---------------------------------+--------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`cone<class_CSGCylinder_property_cone>` |
|
|
+---------------------------------+--------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`height<class_CSGCylinder_property_height>` |
|
|
+---------------------------------+--------------------------------------------------------------+
|
|
| :ref:`Material<class_Material>` | :ref:`material<class_CSGCylinder_property_material>` |
|
|
+---------------------------------+--------------------------------------------------------------+
|
|
| :ref:`float<class_float>` | :ref:`radius<class_CSGCylinder_property_radius>` |
|
|
+---------------------------------+--------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`sides<class_CSGCylinder_property_sides>` |
|
|
+---------------------------------+--------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`smooth_faces<class_CSGCylinder_property_smooth_faces>` |
|
|
+---------------------------------+--------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
This node allows you to create a cylinder (or cone) for use with the CSG system.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_CSGCylinder_property_cone:
|
|
|
|
- :ref:`bool<class_bool>` **cone**
|
|
|
|
+----------+-----------------+
|
|
| *Setter* | set_cone(value) |
|
|
+----------+-----------------+
|
|
| *Getter* | is_cone() |
|
|
+----------+-----------------+
|
|
|
|
If ``true`` a cone is created, the :ref:`radius<class_CSGCylinder_property_radius>` will only apply to one side.
|
|
|
|
----
|
|
|
|
.. _class_CSGCylinder_property_height:
|
|
|
|
- :ref:`float<class_float>` **height**
|
|
|
|
+----------+-------------------+
|
|
| *Setter* | set_height(value) |
|
|
+----------+-------------------+
|
|
| *Getter* | get_height() |
|
|
+----------+-------------------+
|
|
|
|
The height of the cylinder.
|
|
|
|
----
|
|
|
|
.. _class_CSGCylinder_property_material:
|
|
|
|
- :ref:`Material<class_Material>` **material**
|
|
|
|
+----------+---------------------+
|
|
| *Setter* | set_material(value) |
|
|
+----------+---------------------+
|
|
| *Getter* | get_material() |
|
|
+----------+---------------------+
|
|
|
|
The material used to render the cylinder.
|
|
|
|
----
|
|
|
|
.. _class_CSGCylinder_property_radius:
|
|
|
|
- :ref:`float<class_float>` **radius**
|
|
|
|
+----------+-------------------+
|
|
| *Setter* | set_radius(value) |
|
|
+----------+-------------------+
|
|
| *Getter* | get_radius() |
|
|
+----------+-------------------+
|
|
|
|
The radius of the cylinder.
|
|
|
|
----
|
|
|
|
.. _class_CSGCylinder_property_sides:
|
|
|
|
- :ref:`int<class_int>` **sides**
|
|
|
|
+----------+------------------+
|
|
| *Setter* | set_sides(value) |
|
|
+----------+------------------+
|
|
| *Getter* | get_sides() |
|
|
+----------+------------------+
|
|
|
|
The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.
|
|
|
|
----
|
|
|
|
.. _class_CSGCylinder_property_smooth_faces:
|
|
|
|
- :ref:`bool<class_bool>` **smooth_faces**
|
|
|
|
+----------+-------------------------+
|
|
| *Setter* | set_smooth_faces(value) |
|
|
+----------+-------------------------+
|
|
| *Getter* | get_smooth_faces() |
|
|
+----------+-------------------------+
|
|
|
|
If ``true`` the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If ``false`` the cylinder will have a flat shaded look.
|
|
|