virtualx-engine/doc/classes/SeparationRayShape3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SeparationRayShape3D" inherits="Shape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Separation ray shape resource for 3D physics.
	</brief_description>
	<description>
		3D separation ray shape to be added as a [i]direct[/i] child of a [PhysicsBody3D] or [Area3D] using a [CollisionShape3D] node. A ray is not really a collision body; instead, it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters.
		[b]Performance:[/b] Being a primitive collision shape, [SeparationRayShape3D] is fast to check collisions against.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="length" type="float" setter="set_length" getter="get_length" default="1.0">
			The ray's length.
		</member>
		<member name="slide_on_slope" type="bool" setter="set_slide_on_slope" getter="get_slide_on_slope" default="false">
			If [code]false[/code] (default), the shape always separates and returns a normal along its own direction.
			If [code]true[/code], the shape can return the correct normal and separate in any direction, allowing sliding motion on slopes.
		</member>
	</members>
</class>
Restore RayShape as a regular shape type Partial revert from previously removing ray shapes completely, added back as a shape type but without the specific character controller code. 2021-08-17 19:15:11 +02: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 14:18:53 +01:00			`<class name="SeparationRayShape3D" inherits="Shape3D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Restore RayShape as a regular shape type Partial revert from previously removing ray shapes completely, added back as a shape type but without the specific character controller code. 2021-08-17 19:15:11 +02: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 01:37:19 +01:00			`Separation ray shape resource for 3D physics.`
Restore RayShape as a regular shape type Partial revert from previously removing ray shapes completely, added back as a shape type but without the specific character controller code. 2021-08-17 19:15:11 +02: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 01:37:19 +01:00			`3D separation ray shape to be added as a [i]direct[/i] child of a [PhysicsBody3D] or [Area3D] using a [CollisionShape3D] node. A ray is not really a collision body; instead, it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters.`
			`[b]Performance:[/b] Being a primitive collision shape, [SeparationRayShape3D] is fast to check collisions against.`
Restore RayShape as a regular shape type Partial revert from previously removing ray shapes completely, added back as a shape type but without the specific character controller code. 2021-08-17 19:15:11 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
Rename RayShape to SeparationRayShape Makes it clearer that it's used for special cases when picking a collision shape. 2021-08-19 20:21:56 +02:00			`<member name="length" type="float" setter="set_length" getter="get_length" default="1.0">`
Restore RayShape as a regular shape type Partial revert from previously removing ray shapes completely, added back as a shape type but without the specific character controller code. 2021-08-17 19:15:11 +02:00			`The ray's length.`
			`</member>`
Rename slips_on_slope to slide_on_slope Also added some precision to the documentation. 2021-08-19 20:02:40 +02:00			`<member name="slide_on_slope" type="bool" setter="set_slide_on_slope" getter="get_slide_on_slope" default="false">`
			`If [code]false[/code] (default), the shape always separates and returns a normal along its own direction.`
			`If [code]true[/code], the shape can return the correct normal and separate in any direction, allowing sliding motion on slopes.`
Restore RayShape as a regular shape type Partial revert from previously removing ray shapes completely, added back as a shape type but without the specific character controller code. 2021-08-17 19:15:11 +02:00			`</member>`
			`</members>`
			`</class>`