CollisionShape2D.xml 2.3 KB

123456789101112131415161718192021222324252627282930313233343536
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="CollisionShape2D" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. Node that represents collision shape data in 2D space.
  5. </brief_description>
  6. <description>
  7. Editor facility for creating and editing collision shapes in 2D space. Set the [member shape] property to configure the shape. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method CollisionObject2D.shape_owner_get_shape] to get the actual shape.
  8. 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.
  9. </description>
  10. <tutorials>
  11. <link title="Physics introduction">$DOCS_URL/tutorials/physics/physics_introduction.html</link>
  12. <link title="2D Dodge The Creeps Demo">https://godotengine.org/asset-library/asset/515</link>
  13. <link title="2D Pong Demo">https://godotengine.org/asset-library/asset/121</link>
  14. <link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link>
  15. </tutorials>
  16. <methods>
  17. </methods>
  18. <members>
  19. <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" default="false">
  20. A disabled collision shape has no effect in the world. This property should be changed with [method Object.set_deferred].
  21. </member>
  22. <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" default="false">
  23. Sets whether this collision shape should only detect collision on one side (top or bottom).
  24. [b]Note:[/b] This property has no effect if this [CollisionShape2D] is a child of an [Area2D] node.
  25. </member>
  26. <member name="one_way_collision_margin" type="float" setter="set_one_way_collision_margin" getter="get_one_way_collision_margin" default="1.0">
  27. 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.
  28. </member>
  29. <member name="shape" type="Shape2D" setter="set_shape" getter="get_shape">
  30. The actual shape owned by this collision shape.
  31. </member>
  32. </members>
  33. <constants>
  34. </constants>
  35. </class>