StaticBody2D.xml 2.0 KB

123456789101112131415161718192021222324252627
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="StaticBody2D" inherits="PhysicsBody2D" version="4.0">
  3. <brief_description>
  4. Physics body for 2D physics which is static or moves only by script. Useful for floor and walls.
  5. </brief_description>
  6. <description>
  7. Static body for 2D physics.
  8. A static body is a simple body that can't be moved by external forces or contacts. It is ideal for implementing objects in the environment, such as walls or platforms. In contrast to [RigidDynamicBody2D], it doesn't consume any CPU resources as long as they don't move.
  9. They have extra functionalities to move and affect other bodies:
  10. [b]Static transform change:[/b] Static bodies can be moved by animation or script. In this case, they are just teleported and don't affect other bodies on their path.
  11. [b]Constant velocity:[/b] When [member constant_linear_velocity] or [member constant_angular_velocity] is set, static bodies don't move themselves but affect touching bodies as if they were moving. This is useful for simulating conveyor belts or conveyor wheels.
  12. </description>
  13. <tutorials>
  14. </tutorials>
  15. <members>
  16. <member name="constant_angular_velocity" type="float" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" default="0.0">
  17. The body's constant angular velocity. This does not rotate the body, but affects touching bodies, as if it were rotating.
  18. </member>
  19. <member name="constant_linear_velocity" type="Vector2" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity" default="Vector2(0, 0)">
  20. The body's constant linear velocity. This does not move the body, but affects touching bodies, as if it were moving.
  21. </member>
  22. <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override">
  23. The physics material override for the body.
  24. If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one.
  25. </member>
  26. </members>
  27. </class>