summaryrefslogtreecommitdiff
path: root/doc/classes/VisualInstance.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/VisualInstance.xml')
-rw-r--r--doc/classes/VisualInstance.xml7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml
index 2c9fe4f43e..bd66880719 100644
--- a/doc/classes/VisualInstance.xml
+++ b/doc/classes/VisualInstance.xml
@@ -13,12 +13,15 @@
<return type="AABB">
</return>
<description>
+ Returns the [AABB] (also known as the bounding box) for this VisualInstance.
</description>
</method>
<method name="get_transformed_aabb" qualifiers="const">
<return type="AABB">
</return>
<description>
+ Returns the transformed [AABB] (also known as the bounding box) for this VisualInstance.
+ Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]s [Transform]
</description>
</method>
<method name="set_base">
@@ -27,11 +30,15 @@
<argument index="0" name="base" type="RID">
</argument>
<description>
+ Sets the base of the VisualInstance, which changes how the engine handles the VisualInstance under the hood.
+ It is recommended to only use set_base if you know what you're doing.
</description>
</method>
</methods>
<members>
<member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask">
+ The render layer(s) this VisualInstance is drawn on.
+ This object will only be visible for [Camera]s whose cull mask includes the render object this VisualInstance is set to.
</member>
</members>
<constants>