asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document the ArrayOccluder3D class

Browse source
This commit is contained in:
Hugo Locurcio 2022-10-24 17:04:14 +02:00
parent 040f49ed6e
commit 5fe86f6dce
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/classes/ArrayOccluder3D.xml
View file

@ -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>