virtualx-engine/doc/classes/CollisionShape3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionShape3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A node that provides a [Shape3D] to a [CollisionObject3D] parent.
	</brief_description>
	<description>
		A node that provides a [Shape3D] to a [CollisionObject3D] parent and allows to edit it. This can give a detection shape to an [Area3D] or turn a [PhysicsBody3D] into a solid object.
		[b]Warning:[/b] A non-uniformly scaled [CollisionShape3D] will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its [member shape] resource instead.
	</description>
	<tutorials>
		<link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link>
		<link title="3D Kinematic Character Demo">https://godotengine.org/asset-library/asset/126</link>
		<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
	</tutorials>
	<methods>
		<method name="make_convex_from_siblings">
			<return type="void" />
			<description>
				Sets the collision shape's shape to the addition of all its convexed [MeshInstance3D] siblings geometry.
			</description>
		</method>
		<method name="resource_changed" deprecated="Use [signal Resource.changed] instead.">
			<return type="void" />
			<param index="0" name="resource" type="Resource" />
			<description>
				This method does nothing.
			</description>
		</method>
	</methods>
	<members>
		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false" keywords="enabled">
			A disabled collision shape has no effect in the world.
		</member>
		<member name="shape" type="Shape3D" setter="set_shape" getter="get_shape">
			The actual shape owned by this collision shape.
		</member>
	</members>
</class>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="CollisionShape3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<brief_description>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 22:59:03 +02:00			`A node that provides a [Shape3D] to a [CollisionObject3D] parent.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 22:59:03 +02:00			`A node that provides a [Shape3D] to a [CollisionObject3D] parent and allows to edit it. This can give a detection shape to an [Area3D] or turn a [PhysicsBody3D] into a solid object.`
			`[b]Warning:[/b] A non-uniformly scaled [CollisionShape3D] will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its [member shape] resource instead.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 10:43:07 +01:00			`<link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link>`
Link to demos from within the class reference 2020-10-01 10:34:47 +02:00			`<link title="3D Kinematic Character Demo">https://godotengine.org/asset-library/asset/126</link>`
			`<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>`
			`<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</tutorials>`
			`<methods>`
Implement CollisionShape3D.make_convex_from_siblings() 2020-08-05 10:51:41 +02:00			`<method name="make_convex_from_siblings">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<return type="void" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<description>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`Sets the collision shape's shape to the addition of all its convexed [MeshInstance3D] siblings geometry.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`</method>`
Documentation: Add support for deprecated/experimental messages 2024-02-12 14:55:02 +01:00			`<method name="resource_changed" deprecated="Use [signal Resource.changed] instead.">`
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there. 2021-07-30 15:28:05 +02:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="resource" type="Resource" />`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`<description>`
Documentation: Add support for deprecated/experimental messages 2024-02-12 14:55:02 +01:00			`This method does nothing.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`</description>`
			`</method>`
			`</methods>`
			`<members>`
Add keywords to improve search in the class reference 2024-02-21 18:51:08 +01:00			`<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false" keywords="enabled">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`A disabled collision shape has no effect in the world.`
			`</member>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 18:22:57 +02:00			`<member name="shape" type="Shape3D" setter="set_shape" getter="get_shape">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 22:42:36 +02:00			`The actual shape owned by this collision shape.`
			`</member>`
			`</members>`
			`</class>`