Class CSGCylinder3D

A CSG Cylinder shape.

Inheritance

CSGPrimitive3D

CSGShape3D

GeometryInstance3D

VisualInstance3D

Node3D

Node

Object

CSGCylinder3D

Remarks

This node allows you to create a cylinder (or cone) for use with the CSG system.

Note: 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.

See Also

Prototyping levels with CSG

Properties

cone

If true a cone is created, the radius will only apply to one side.

var cone : bool = false

Property Value

bool

Remarks

• void set_cone(bool value)
• bool is_cone

height

The height of the cylinder.

var height : float = 2.0

Property Value

float

Remarks

• void set_height(float value)
• float get_height

material

The material used to render the cylinder.

var material : Material

Property Value

Material

Remarks

• void set_material(Material value)
• Material get_material

radius

The radius of the cylinder.

var radius : float = 0.5

Property Value

float

Remarks

• void set_radius(float value)
• float get_radius

sides

The number of sides of the cylinder, the higher this number the more detail there will be in the cylinder.

var sides : int = 8

Property Value

int

Remarks

• void set_sides(int value)
• int get_sides

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.

var smooth_faces : bool = true

Property Value

bool

Remarks

• void set_smooth_faces(bool value)
• bool get_smooth_faces