virtualx-engine/doc/classes/VisualInstance.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualInstance" inherits="Spatial" category="Core" version="3.2">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_aabb" qualifiers="const">
			<return type="AABB">
			</return>
			<description>
				Returns the [AABB] (also known as the bounding box) for this VisualInstance.
			</description>
		</method>
		<method name="get_layer_mask_bit" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="layer" type="int">
			</argument>
			<description>
			</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">
			<return type="void">
			</return>
			<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>
		<method name="set_layer_mask_bit">
			<return type="void">
			</return>
			<argument index="0" name="layer" type="int">
			</argument>
			<argument index="1" name="enabled" type="bool">
			</argument>
			<description>
			</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>
	</constants>
</class>