mirror of
https://github.com/godotengine/godot
synced 2024-11-05 16:53:09 +00:00
e61a127042
Removes some outdated/incorrect/duplicated info, adds correct info. Also removes no longer applicable "editor-only helper" statements.
35 lines
2.5 KiB
XML
35 lines
2.5 KiB
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>
|
|
Node that represents collision shape data in 2D space.
|
|
</brief_description>
|
|
<description>
|
|
Editor facility for creating and editing collision shapes in 2D space. Set the [member shape] property to configure the shape.
|
|
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.
|
|
</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>
|