godot/doc/classes/CollisionPolygon2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionPolygon2D" inherits="Node2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Defines a 2D collision polygon.
	</brief_description>
	<description>
		Provides a 2D collision polygon to a [CollisionObject2D] parent. Polygons can be drawn in the editor or specified by a list of vertices.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" enum="CollisionPolygon2D.BuildMode" default="0">
			Collision build mode. Use one of the [enum BuildMode] constants.
		</member>
		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
			If [code]true[/code], no collisions will be detected.
		</member>
		<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false">
			If [code]true[/code], only edges that face up, relative to [CollisionPolygon2D]'s rotation, will collide with other objects.
		</member>
		<member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin" default="1.0">
			The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity.
		</member>
		<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array()">
			The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PackedVector2Array], not a reference.
		</member>
	</members>
	<constants>
		<constant name="BUILD_SOLIDS" value="0" enum="BuildMode">
			Collisions will include the polygon and its contained area.
		</constant>
		<constant name="BUILD_SEGMENTS" value="1" enum="BuildMode">
			Collisions will only include the polygon edges.
		</constant>
	</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 20:42:36 +00: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 13:18:53 +00:00			`<class name="CollisionPolygon2D" inherits="Node2D" 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 20:42:36 +00:00			`<brief_description>`
[DOCS] Update Polygon2D and CollisionPolygon2D 2017-10-02 04:13:36 +00:00			`Defines a 2D collision 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 20:42:36 +00:00			`</brief_description>`
			`<description>`
doc: Markup fixes for enums and constants 2019-12-06 22:09:20 +00:00			`Provides a 2D collision polygon to a [CollisionObject2D] parent. Polygons can be drawn in the editor or specified by a list of vertices.`
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 20:42:36 +00:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<members>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" enum="CollisionPolygon2D.BuildMode" default="0">`
doc: Markup fixes for enums and constants 2019-12-06 22:09:20 +00:00			`Collision build mode. Use one of the [enum BuildMode] constants.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">`
doc: Add missing commas after "If true/false" 2018-12-20 12:46:54 +00:00			`If [code]true[/code], no collisions will be detected.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false">`
doc: Markup fixes for enums and constants 2019-12-06 22:09:20 +00:00			`If [code]true[/code], only edges that face up, relative to [CollisionPolygon2D]'s rotation, will collide with other objects.`
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 20:42:36 +00:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin" default="1.0">`
Add LOTS of missing docs 2020-03-03 18:21:21 +00:00			`The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity.`
doc: Sync classref with current source 2019-01-26 21:21:53 +00:00			`</member>`
Better format arguments in variant parser 2019-09-24 17:45:03 +00:00			`<member name="polygon" type="PackedVector2Array" setter="set_polygon" getter="get_polygon" default="PackedVector2Array()">`
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes. 2020-02-18 12:59:24 +00:00			`The polygon's list of vertices. The final point will be connected to the first. The returned value is a clone of the [PackedVector2Array], not a reference.`
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 20:42:36 +00:00			`</member>`
			`</members>`
			`<constants>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 22:16:30 +00:00			`<constant name="BUILD_SOLIDS" value="0" enum="BuildMode">`
[DOCS] Update Polygon2D and CollisionPolygon2D 2017-10-02 04:13:36 +00:00			`Collisions will include the polygon and its contained area.`
doc: Sync classref with current source [ci skip] 2017-09-15 23:46:14 +00:00			`</constant>`
doc: Fix enum tags thanks to 2bc6db6 2017-11-24 22:16:30 +00:00			`<constant name="BUILD_SEGMENTS" value="1" enum="BuildMode">`
[DOCS] Update Polygon2D and CollisionPolygon2D 2017-10-02 04:13:36 +00:00			`Collisions will only include the polygon edges.`
doc: Sync classref with current source [ci skip] 2017-09-15 23:46:14 +00:00			`</constant>`
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 20:42:36 +00:00			`</constants>`
			`</class>`