virtualx-engine/doc/classes/SegmentShape2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="SegmentShape2D" inherits="Shape2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Segment shape resource for 2D physics.
	</brief_description>
	<description>
		2D segment shape to be added as a [i]direct[/i] child of a [PhysicsBody2D] or [Area2D] using a [CollisionShape2D] node. Consists of two points, [code]a[/code] and [code]b[/code].
		[b]Performance:[/b] Being a primitive collision shape, [SegmentShape2D] is fast to check collisions against (though not as fast as [CircleShape2D]).
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="a" type="Vector2" setter="set_a" getter="get_a" default="Vector2(0, 0)">
			The segment's first point position.
		</member>
		<member name="b" type="Vector2" setter="set_b" getter="get_b" default="Vector2(0, 10)">
			The segment's second point position.
		</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="SegmentShape2D" inherits="Shape2D" 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>`
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			`Segment shape resource for 2D physics.`
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>`
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			`2D segment shape to be added as a [i]direct[/i] child of a [PhysicsBody2D] or [Area2D] using a [CollisionShape2D] node. Consists of two points, [code]a[/code] and [code]b[/code].`
			`[b]Performance:[/b] Being a primitive collision shape, [SegmentShape2D] is fast to check collisions against (though not as fast as [CircleShape2D]).`
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>`
			`<members>`
Better format arguments in variant parser 2019-09-24 19:45:03 +02:00			`<member name="a" type="Vector2" setter="set_a" getter="get_a" default="Vector2(0, 0)">`
[DOCS] added member descriptions to various shapes 2017-09-17 06:06:58 +02:00			`The segment's first point position.`
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>`
Better format arguments in variant parser 2019-09-24 19:45:03 +02:00			`<member name="b" type="Vector2" setter="set_b" getter="get_b" default="Vector2(0, 10)">`
[DOCS] added member descriptions to various shapes 2017-09-17 06:06:58 +02:00			`The segment's second point position.`
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>`