summaryrefslogtreecommitdiffstats
path: root/doc/classes/ArrayOccluder3D.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-06-02 17:26:02 +0200
committerRémi Verschelde <rverschelde@gmail.com>2023-06-02 17:26:02 +0200
commit86df3312b581c652fa7807109ce76493355bacdc (patch)
tree0f632cf05917c64f10f6c022f46a672dfa4cb874 /doc/classes/ArrayOccluder3D.xml
parentdc8a0c3cd1ddd8649a73fa74ec432de359d8cb51 (diff)
parent5fe86f6dce2dae0a7303cb67fbf888dc0c8b7c33 (diff)
downloadredot-engine-86df3312b581c652fa7807109ce76493355bacdc.tar.gz
Merge pull request #67835 from Calinou/doc-arrayoccluder3d
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 5eda132b84..0210ffbc96 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>