diff options
Diffstat (limited to 'doc/classes/VisualInstance.xml')
| -rw-r--r-- | doc/classes/VisualInstance.xml | 23 |
1 files changed, 8 insertions, 15 deletions
diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index 7108eb13c5..bd66880719 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="VisualInstance" inherits="Spatial" category="Core" version="3.0-alpha"> +<class name="VisualInstance" inherits="Spatial" category="Core" version="3.0-beta"> <brief_description> </brief_description> <description> @@ -13,18 +13,15 @@ <return type="AABB"> </return> <description> - </description> - </method> - <method name="get_layer_mask" qualifiers="const"> - <return type="int"> - </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"> @@ -33,19 +30,15 @@ <argument index="0" name="base" type="RID"> </argument> <description> - </description> - </method> - <method name="set_layer_mask"> - <return type="void"> - </return> - <argument index="0" name="mask" type="int"> - </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> |