virtualx-engine/doc/classes/RayShape.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="RayShape" inherits="Shape" version="4.0">
	<brief_description>
		Ray shape for 3D collisions.
	</brief_description>
	<description>
		Ray shape for 3D collisions, which can be set into a [PhysicsBody] or [Area]. 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.
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="length" type="float" setter="set_length" getter="get_length" default="1.0">
			The ray's length.
		</member>
		<member name="slips_on_slope" type="bool" setter="set_slips_on_slope" getter="get_slips_on_slope" default="false">
			If [code]true[/code], allow the shape to return the correct normal.
		</member>
	</members>
	<constants>
	</constants>
</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" ?>`
Update docs to version 4.0 2020-02-01 02:03:48 +01:00			`<class name="RayShape" inherits="Shape" version="4.0">`
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>`
RayShape, Shape, SphereShape 2017-09-23 13:12:30 +02:00			`Ray shape for 3D collisions.`
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>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 01:04:47 +02:00			`Ray shape for 3D collisions, which can be set into a [PhysicsBody] or [Area]. 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.`
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>`
			`</tutorials>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="length" type="float" setter="set_length" getter="get_length" default="1.0">`
RayShape, Shape, SphereShape 2017-09-23 13:12:30 +02:00			`The ray's length.`
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			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 12:38:01 +02:00			`<member name="slips_on_slope" type="bool" setter="set_slips_on_slope" getter="get_slips_on_slope" default="false">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 15:24:23 +02:00			`If [code]true[/code], allow the shape to return the correct normal.`
[DOCS] Sync classref with current source 2018-02-25 07:19:42 +01:00			`</member>`
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			`</members>`
			`<constants>`
			`</constants>`
			`</class>`