summaryrefslogtreecommitdiffstats
path: root/doc/classes/ArrayOccluder3D.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2022-10-24 17:04:14 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2022-10-24 17:04:14 +0200
commit5fe86f6dce2dae0a7303cb67fbf888dc0c8b7c33 (patch)
tree880c587909f12ff7475f73c4968262f906f0bc09 /doc/classes/ArrayOccluder3D.xml
parent040f49ed6e71a6e7f23d763c4b56095cbf319ef7 (diff)
downloadredot-engine-5fe86f6dce2dae0a7303cb67fbf888dc0c8b7c33.tar.gz
Document the ArrayOccluder3D class
Diffstat (limited to 'doc/classes/ArrayOccluder3D.xml')
-rw-r--r--doc/classes/ArrayOccluder3D.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/ArrayOccluder3D.xml b/doc/classes/ArrayOccluder3D.xml
index 866427beeb..03c553a83a 100644
--- a/doc/classes/ArrayOccluder3D.xml
+++ b/doc/classes/ArrayOccluder3D.xml
@@ -15,13 +15,18 @@
<param index="0" name="vertices" type="PackedVector3Array" />
<param index="1" name="indices" type="PackedInt32Array" />
<description>
+ Sets [member indices] and [member vertices], while updating the final occluder only once after both values are set.
</description>
</method>
</methods>
<members>
<member name="indices" type="PackedInt32Array" setter="set_indices" getter="get_indices" default="PackedInt32Array()">
+ The occluder's index position. Indices determine which points from the [member vertices] array should be drawn, and in which order.
+ [b]Note:[/b] The occluder is always updated after setting this value. If creating occluders procedurally, consider using [method set_arrays] instead to avoid updating the occluder twice when it's created.
</member>
<member name="vertices" type="PackedVector3Array" setter="set_vertices" getter="get_vertices" default="PackedVector3Array()">
+ The occluder's vertex positions in local 3D coordinates.
+ [b]Note:[/b] The occluder is always updated after setting this value. If creating occluders procedurally, consider using [method set_arrays] instead to avoid updating the occluder twice when it's created.
</member>
</members>
</class>