virtualx-engine/modules/gltf/doc_classes/GLTFCollider.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GLTFCollider" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
	<brief_description>
		Represents a GLTF collider.
	</brief_description>
	<description>
		Represents a collider as defined by the [code]OMI_collider[/code] GLTF extension. This class is an intermediary between the GLTF data and Godot's nodes, and it's abstracted in a way that allows adding support for different GLTF physics extensions in the future.
	</description>
	<tutorials>
		<link title="OMI_collider GLTF extension">https://github.com/omigroup/gltf-extensions/tree/main/extensions/2.0/OMI_collider</link>
	</tutorials>
	<methods>
		<method name="to_dictionary" qualifiers="const">
			<return type="Dictionary" />
			<description>
				Serializes this GLTFCollider instance into a [Dictionary].
			</description>
		</method>
		<method name="to_node">
			<return type="CollisionShape" />
			<argument index="0" name="cache_shapes" type="bool" default="false" />
			<description>
				Converts this GLTFCollider instance into a Godot [CollisionShape] node.
			</description>
		</method>
	</methods>
	<members>
		<member name="array_mesh" type="ArrayMesh" setter="set_array_mesh" getter="get_array_mesh">
			The [ArrayMesh] resource of the collider. This is only used when the collider type is "hull" (convex hull) or "trimesh" (concave trimesh).
		</member>
		<member name="height" type="float" setter="set_height" getter="get_height" default="2.0">
			The height of the collider, in meters. This is only used when the collider type is "capsule" or "cylinder". This value should not be negative, and for "capsule" it should be at least twice the radius.
		</member>
		<member name="is_trigger" type="bool" setter="set_is_trigger" getter="get_is_trigger" default="false">
			If [code]true[/code], indicates that this collider is a trigger. For Godot, this means that the collider should be a child of an Area3D node.
			This is the only variable not used in the [method to_node] method, it's intended to be used alongside when deciding where to add the generated node as a child.
		</member>
		<member name="mesh_index" type="int" setter="set_mesh_index" getter="get_mesh_index" default="-1">
			The index of the collider's mesh in the GLTF file. This is only used when the collider type is "hull" (convex hull) or "trimesh" (concave trimesh).
		</member>
		<member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.5">
			The radius of the collider, in meters. This is only used when the collider type is "capsule", "cylinder", or "sphere". This value should not be negative.
		</member>
		<member name="shape_type" type="String" setter="set_shape_type" getter="get_shape_type" default="&quot;&quot;">
			The type of shape this collider represents. Valid values are "box", "capsule", "cylinder", "sphere", "hull", and "trimesh".
		</member>
		<member name="size" type="Vector3" setter="set_size" getter="get_size" default="Vector3( 1, 1, 1 )">
			The size of the collider, in meters. This is only used when the collider type is "box", and it represents the "diameter" of the box. This value should not be negative.
		</member>
	</members>
	<constants>
	</constants>
</class>