godot/doc/classes/CollisionShape2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionShape2D" inherits="Node2D" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A node that provides a [Shape2D] to a [CollisionObject2D] parent.
	</brief_description>
	<description>
		A node that provides a [Shape2D] to a [CollisionObject2D] parent and allows to edit it. This can give a detection shape to an [Area2D] or turn a [PhysicsBody2D] into a solid object.
	</description>
	<tutorials>
		<link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link>
		<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>
		<link title="2D Pong Demo">https://godotengine.org/asset-library/asset/121</link>
		<link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link>
	</tutorials>
	<members>
		<member name="debug_color" type="Color" setter="set_debug_color" getter="get_debug_color" default="Color(0, 0, 0, 1)">
			The collision shape debug color.
			[b]Note:[/b] The default value is [member ProjectSettings.debug/shapes/collision/shape_color]. The [code]Color(0, 0, 0, 1)[/code] value documented here is a placeholder, and not the actual default debug color.
		</member>
		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
			A disabled collision shape has no effect in the world. This property should be changed with [method Object.set_deferred].
		</member>
		<member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false">
			Sets whether this collision shape should only detect collision on one side (top or bottom).
			[b]Note:[/b] This property has no effect if this [CollisionShape2D] is a child of an [Area2D] node.
		</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 shape at a high velocity.
		</member>
		<member name="shape" type="Shape2D" setter="set_shape" getter="get_shape">
			The actual shape owned by this collision shape.
		</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 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Bump version to 4.1-dev Can't stop, won't stop, they said, huh? 2023-03-01 00:44:37 +00:00			`<class name="CollisionShape2D" inherits="Node2D" version="4.1" 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>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 20:59:03 +00:00			`A node that provides a [Shape2D] to a [CollisionObject2D] 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 20:42:36 +00:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (Physics classes) 2023-04-28 20:59:03 +00:00			`A node that provides a [Shape2D] to a [CollisionObject2D] parent and allows to edit it. This can give a detection shape to an [Area2D] or turn a [PhysicsBody2D] into a solid object.`
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>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 09:43:07 +00:00			`<link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link>`
Link to demos from within the class reference 2020-10-01 08:34:47 +00:00			`<link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>`
			`<link title="2D Pong Demo">https://godotengine.org/asset-library/asset/121</link>`
			`<link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link>`
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			`</tutorials>`
			`<members>`
Add `CollisionShape2D.debug_color` property 2022-09-21 13:01:43 +00:00			`<member name="debug_color" type="Color" setter="set_debug_color" getter="get_debug_color" default="Color(0, 0, 0, 1)">`
			`The collision shape debug color.`
			`[b]Note:[/b] The default value is [member ProjectSettings.debug/shapes/collision/shape_color]. The [code]Color(0, 0, 0, 1)[/code] value documented here is a placeholder, and not the actual default debug color.`
			`</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">`
Update CollisionShape2D doc 2020-08-20 02:16:58 +00:00			`A disabled collision shape has no effect in the world. This property should be changed with [method Object.set_deferred].`
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">`
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			`Sets whether this collision shape should only detect collision on one side (top or bottom).`
Mention that Area2D doesn't support one_way_collision 2022-05-07 22:31:40 +00:00			`[b]Note:[/b] This property has no effect if this [CollisionShape2D] is a child of an [Area2D] node.`
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 shape at a high velocity.`
doc: Sync classref with current source 2019-01-26 21:21:53 +00:00			`</member>`
doc: Sync classref with current source 2019-07-15 18:42:47 +00:00			`<member name="shape" type="Shape2D" setter="set_shape" getter="get_shape">`
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			`The actual shape owned by this collision shape.`
			`</member>`
			`</members>`
			`</class>`