virtualx-engine/doc/classes/CollisionPolygon3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionPolygon3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A node that provides a thickened polygon shape (a prism) to a [CollisionObject3D] parent.
	</brief_description>
	<description>
		A node that provides a thickened polygon shape (a prism) to a [CollisionObject3D] parent and allows to edit it. The polygon can be concave or convex. This can give a detection shape to an [Area3D] or turn [PhysicsBody3D] into a solid object.
		[b]Warning:[/b] A non-uniformly scaled [CollisionShape3D] will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its shape resource instead.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">
			Length that the resulting collision extends in either direction perpendicular to its 2D polygon.
		</member>
		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false" keywords="enabled">
			If [code]true[/code], no collision will be produced.
		</member>
		<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">
			The collision margin for the generated [Shape3D]. See [member Shape3D.margin] for more details.
		</member>
		<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array()">
			Array of vertices which define the 2D polygon in the local XY plane.
		</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" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="CollisionPolygon3D" inherits="Node3D" 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>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 22:59:03 +02:00			`A node that provides a thickened polygon shape (a prism) to a [CollisionObject3D] parent.`
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>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 22:59:03 +02:00			`A node that provides a thickened polygon shape (a prism) to a [CollisionObject3D] parent and allows to edit it. The polygon can be concave or convex. This can give a detection shape to an [Area3D] or turn [PhysicsBody3D] into a solid object.`
			`[b]Warning:[/b] A non-uniformly scaled [CollisionShape3D] will likely not behave as expected. Make sure to keep its scale the same on all axes and adjust its shape resource instead.`
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>`
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="depth" type="float" setter="set_depth" getter="get_depth" default="1.0">`
Fix concave/convex polygon shape documentation Removes some outdated/incorrect/duplicated info, adds correct info. Also removes no longer applicable "editor-only helper" statements. 2023-03-05 16:36:01 +01:00			`Length that the resulting collision extends in either direction perpendicular to its 2D polygon.`
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>`
Add keywords to improve search in the class reference 2024-02-21 18:51:08 +01:00			`<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false" keywords="enabled">`
Consistently wrap booleans in [code] 2019-04-17 13:42:56 +02:00			`If [code]true[/code], no collision will be produced.`
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>`
Implement CollisionPolygon3D margin 2021-02-09 20:37:12 +01:00			`<member name="margin" type="float" setter="set_margin" getter="get_margin" default="0.04">`
			`The collision margin for the generated [Shape3D]. See [member Shape3D.margin] for more details.`
			`</member>`
Better format arguments in variant parser 2019-09-24 19:45:03 +02:00			`<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array()">`
Fix concave/convex polygon shape documentation Removes some outdated/incorrect/duplicated info, adds correct info. Also removes no longer applicable "editor-only helper" statements. 2023-03-05 16:36:01 +01:00			`Array of vertices which define the 2D polygon in the local XY plane.`
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>`