godot/doc/classes/CylinderShape3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CylinderShape3D" inherits="Shape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Cylinder shape for 3D collisions.
	</brief_description>
	<description>
		Cylinder shape for collisions. Like [CapsuleShape3D], but without hemispheres at the cylinder's ends.
		[b]Note:[/b] There are several known bugs with cylinder collision shapes. Using [CapsuleShape3D] or [BoxShape3D] instead is recommended.
		[b]Performance:[/b] Being a primitive collision shape, [CylinderShape3D] is fast to check collisions against (though not as fast as [SphereShape3D]). [CylinderShape3D] is also more demanding compared to [CapsuleShape3D].
	</description>
	<tutorials>
		<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
		<link title="3D Physics Tests Demo">https://godotengine.org/asset-library/asset/675</link>
		<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
	</tutorials>
	<members>
		<member name="height" type="float" setter="set_height" getter="get_height" default="2.0">
			The cylinder's height.
		</member>
		<member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.5">
			The cylinder's radius.
		</member>
	</members>
</class>
added cylinder shape support 2018-06-12 22:53:28 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-02-14 13:18:53 +00:00			`<class name="CylinderShape3D" inherits="Shape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
added cylinder shape support 2018-06-12 22:53:28 +00:00			`<brief_description>`
Improve documentation related to physics collision shapes - Document using convex decomposition in the editor. - Mention that "trimesh" is synonymous with a concave collision shape. - Add performance hints for each collision shape. 2022-03-02 00:37:19 +00:00			`Cylinder shape for 3D collisions.`
added cylinder shape support 2018-06-12 22:53:28 +00:00			`</brief_description>`
			`<description>`
Improve documentation related to physics collision shapes - Document using convex decomposition in the editor. - Mention that "trimesh" is synonymous with a concave collision shape. - Add performance hints for each collision shape. 2022-03-02 00:37:19 +00:00			`Cylinder shape for collisions. Like [CapsuleShape3D], but without hemispheres at the cylinder's ends.`
Document known issues with CylinderShape3D 2022-10-19 21:43:18 +00:00			`[b]Note:[/b] There are several known bugs with cylinder collision shapes. Using [CapsuleShape3D] or [BoxShape3D] instead is recommended.`
Improve documentation related to physics collision shapes - Document using convex decomposition in the editor. - Mention that "trimesh" is synonymous with a concave collision shape. - Add performance hints for each collision shape. 2022-03-02 00:37:19 +00:00			`[b]Performance:[/b] Being a primitive collision shape, [CylinderShape3D] is fast to check collisions against (though not as fast as [SphereShape3D]). [CylinderShape3D] is also more demanding compared to [CapsuleShape3D].`
added cylinder shape support 2018-06-12 22:53:28 +00:00			`</description>`
			`<tutorials>`
Link to demos from within the class reference 2020-10-01 08:34:47 +00:00			`<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>`
			`<link title="3D Physics Tests Demo">https://godotengine.org/asset-library/asset/675</link>`
			`<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>`
added cylinder shape support 2018-06-12 22:53:28 +00:00			`</tutorials>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="height" type="float" setter="set_height" getter="get_height" default="2.0">`
added cylinder shape support 2018-06-12 22:53:28 +00:00			`The cylinder's height.`
			`</member>`
Improve the default size for 3D shapes (Box, Capsule, and Cylinder) 2021-12-30 23:20:56 +00:00			`<member name="radius" type="float" setter="set_radius" getter="get_radius" default="0.5">`
added cylinder shape support 2018-06-12 22:53:28 +00:00			`The cylinder's radius.`
			`</member>`
			`</members>`
			`</class>`