virtualx-engine/doc/classes/GrooveJoint2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="GrooveJoint2D" inherits="Joint2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Groove constraint for 2D physics.
	</brief_description>
	<description>
		Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset" default="25.0">
			The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's Y axis (along the groove).
		</member>
		<member name="length" type="float" setter="set_length" getter="get_length" default="50.0">
			The groove's length. The groove is from the joint's origin towards [member length] along the joint's local Y axis.
		</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" ?>`
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="GrooveJoint2D" inherits="Joint2D" version="4.0" 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>`
			`Groove constraint for 2D physics.`
			`</brief_description>`
			`<description>`
			`Groove constraint for 2D physics. This is useful for making a body "slide" through a segment placed in another.`
			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<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="initial_offset" type="float" setter="set_initial_offset" getter="get_initial_offset" default="25.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 15:24:23 +02:00			`The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's Y axis (along the groove).`
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="length" type="float" setter="set_length" getter="get_length" default="50.0">`
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. 2019-06-29 15:24:23 +02:00			`The groove's length. The groove is from the joint's origin towards [member length] along the joint's local Y axis.`
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>`
			`</members>`
			`</class>`