2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
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" >
2017-09-12 20:42:36 +00:00
<brief_description >
Node that represents collision shape data in 2D space.
</brief_description>
<description >
2023-03-05 15:36:01 +00:00
Editor facility for creating and editing collision shapes in 2D space. Set the [member shape] property to configure the shape.
2022-08-23 16:35:47 +00:00
You can use this node to represent all sorts of collision shapes, for example, add this to an [Area2D] to give it a detection shape, or add it to a [PhysicsBody2D] to create a solid object.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
2021-11-15 09:43:07 +00:00
<link title= "Physics introduction" > $DOCS_URL/tutorials/physics/physics_introduction.html</link>
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>
2017-09-12 20:42:36 +00:00
</tutorials>
<members >
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>
2019-06-29 10:38:01 +00:00
<member name= "disabled" type= "bool" setter= "set_disabled" getter= "is_disabled" default= "false" >
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].
2017-09-12 20:42:36 +00:00
</member>
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" >
2017-09-12 20:42:36 +00:00
Sets whether this collision shape should only detect collision on one side (top or bottom).
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.
2017-09-12 20:42:36 +00:00
</member>
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" >
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.
2019-01-26 21:21:53 +00:00
</member>
2019-07-15 18:42:47 +00:00
<member name= "shape" type= "Shape2D" setter= "set_shape" getter= "get_shape" >
2017-09-12 20:42:36 +00:00
The actual shape owned by this collision shape.
</member>
</members>
</class>