virtualx-engine/modules/csg/doc_classes/CSGBox.xml

32 lines
1.4 KiB
XML
Raw Normal View History

2018-05-12 09:38:00 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2022-08-05 18:51:38 +02:00
<class name="CSGBox" inherits="CSGPrimitive" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2018-05-12 09:38:00 +02:00
<brief_description>
A CSG Box shape.
2018-05-12 09:38:00 +02:00
</brief_description>
<description>
This node allows you to create a box for use with the CSG system.
[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 [MeshInstance] 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>
<link title="Prototyping levels with CSG">$DOCS_URL/tutorials/3d/csg_tools.html</link>
2018-05-12 09:38:00 +02:00
</tutorials>
<methods>
</methods>
<members>
<member name="depth" type="float" setter="set_depth" getter="get_depth" default="2.0">
Depth of the box measured from the center of the box.
2018-05-12 09:38:00 +02:00
</member>
<member name="height" type="float" setter="set_height" getter="get_height" default="2.0">
Height of the box measured from the center of the box.
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">
The material used to render the box.
2018-05-12 09:38:00 +02:00
</member>
<member name="width" type="float" setter="set_width" getter="get_width" default="2.0">
Width of the box measured from the center of the box.
2018-05-12 09:38:00 +02:00
</member>
</members>
<constants>
</constants>
</class>