unity-physicscore2d-bodies-api

name: unity-physicscore2d-bodies-api description: Authoritative Unity 6000.5 PhysicsCore2D API reference for Bodies. Lists every type, property, field, method (with signatures, params, returns) for: PhysicsBody, PhysicsBodyDefinition. Use whenever working with these types in code.

Unity PhysicsCore2D API — Bodies

This skill is the auto-generated API surface for the listed types. It pre-dates Claude's training data on Unity 6000.5, so it should be treated as the source of truth for member names, signatures, and documentation strings.

Generated from Unity 6000.5.0b9 UnityEngine.PhysicsCore2DModule.xml.

Top-level types in this file: PhysicsBody, PhysicsBodyDefinition.

PhysicsBody

A body is contained within a world and has 3 degrees-of-freedom, two for position and one for rotation. A body can have forces, torques and impulses applied to it. A body has three distinct types: - Static: This type of body does not move under simulation and behaves as if it has infinite mass, essentially an immovable object. Static bodies never interact with other Static or Kinematic bodies. - Dynamic: This type of body is fully simulated and moves according to forces and torques applied to its linear/angular velocities. It can interact with all other body types. It always has finite, non-zero mass. - Kinematic: This type of body moves under simulation and moves according to its linear/angular velocities and never uses forces or torques. It only interacts with Dynamic body types. It behaves as if it has infinite mass. A body is automatically destroyed when the world it is in is destroyed. A body cannot exist outside a world.

Full name: Unity.U2D.Physics.PhysicsBody
Docs: Unity.U2D.Physics.PhysicsBody

Properties

Methods

ApplyAngularImpulse(float, bool)

Apply an angular impulse. This should be used for one-shot impulses. If you need a steady torque, use a torque instead, which will work better with the sub-stepping solver.

Params:

• impulse — The angular impulse, usually in units of kgmm/s.
• wake — Should the body be woken up.

ApplyForce(Vector2, Vector2, bool)

Apply a force at a world point. If the force is not applied at the center of mass, it will generate a torque and affect the angular velocity.

Params:

• force — The world force vector, usually in newtons (N)
• point — The world position of the point of application.
• wake — Should the body be woken up.

ApplyForceToCenter(Vector2, bool)

Apply a force to the center of mass.

Params:

• force — The world force vector, usually in newtons (N).
• wake — Should the body be woken up.

ApplyLinearImpulse(Vector2, Vector2, bool)

Apply an impulse at a point. This immediately modifies the velocity and also modifies the angular velocity if the point of application is not at the center of mass. This should be used for one-shot impulses. If you need a steady force, use a force instead, which will work better with the sub-stepping solver.

Params:

• impulse — The world impulse vector, usually in Ns or kgm/s.
• point — The world position of the point of application.
• wake — Should the body be woken up.

ApplyLinearImpulseToCenter(Vector2, bool)

Apply an impulse to the center of mass. This immediately modifies the velocity. This should be used for one-shot impulses. If you need a steady force, use a force instead, which will work better with the sub-stepping solver.

Params:

• impulse — The world impulse vector, usually in Ns or kgm/s.
• wake — Should the body be woken up.

ApplyMassFromShapes()

Typically a body will automatically calculate the using all the attached shapes. The is automatically updated whenever a is added, removed or modified. When adding many shapes to a body, you can choose to stop this automatic calculation, therefore improving performance, by disabling for each shape being added to the body. This call will result in the being calculated using the currently added so is typically called after many shapes are added if they have disabled. Alternately, if you wish to assign your own then disabling the automatic calculation also makes sense. In either case, you must call this method or set before any simulation step occurs otherwise the will exhibit unstable collision behaviour. The will be overwritten when calling , if is set or when adding, removing or changing with enabled.

ApplyTorque(float, bool)

Apply a torque. This affects the angular velocity without affecting the linear velocity.

Params:

• torque — Torque, usually in N*m.
• wake — Should the body be woken up.

ClearForces()

Clear any user forces that have been applied to this body. Forces on a body are automatically cleared when a simulation step completes, however under some circumstances it may be desirable to clear the forces explicitly.

Create(PhysicsWorld)

Create a body using in the specified world.

Params:

• world — The world to create the body in.

Returns: The created body.

Create(PhysicsWorld, PhysicsBodyDefinition)

Create a body in the specified world.

Params:

• world — The world to create the body in.
• definition — The body definition to use.

Returns: The created body.

CreateBatch(PhysicsWorld, PhysicsBodyDefinition, int, Unity.Collections.Allocator)

Create a batch of bodies in the specified world.

Params:

• world — The world to create the bodies in.
• definition — The body definition to use for all bodies.
• bodyCount — The number of bodies to create.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The created bodies. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

CreateBatch(PhysicsWorld, ReadOnlySpan{Unity.U2D.Physics.PhysicsBodyDefinition}, Unity.Collections.Allocator)

Create a batch of bodies in the specified world.

Params:

• world — The world to create the bodies in.
• definitions — The definitions used to create the bodies. The number of bodies produced is implicitly controlled by the number of definitions in this span.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The created bodies. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

CreateChain(ChainGeometry, PhysicsChainDefinition)

Create a Chain attached to this body.

Params:

• geometry — The geometry to use.
• definition — The chain definition to use.

Returns: The created chain.

CreateShape(CircleGeometry)

Create a Circle shape, using its default definition, attached to this body.

Params:

• geometry — The geometry to use.

Returns: The created shape.

CreateShape(CircleGeometry, PhysicsShapeDefinition)

Create a Circle shape attached to this body.

Params:

• geometry — The geometry to use.
• definition — The shape definition to use.

Returns: The created shape.

CreateShape(PolygonGeometry)

Create a Polygon shape, using its default definition, attached to this body.

Params:

• geometry — The geometry to use.

Returns: The created shape.

CreateShape(PolygonGeometry, PhysicsShapeDefinition)

Create a Polygon shape attached to this body.

Params:

• geometry — The geometry to use.
• definition — The shape definition to use.

Returns: The created shape.

CreateShape(CapsuleGeometry)

Create a Capsule shape, using its default definition, attached to this body.

Params:

• geometry — The geometry to use.

Returns: The created shape.

CreateShape(CapsuleGeometry, PhysicsShapeDefinition)

Create a Capsule shape attached to this body.

Params:

• geometry — The geometry to use.
• definition — The shape definition to use.

Returns: The created shape.

CreateShape(SegmentGeometry)

Create a Segment shape, using its default definition, attached to this body.

Params:

• geometry — The geometry to use.

Returns: The created shape.

CreateShape(SegmentGeometry, PhysicsShapeDefinition)

Create a Segment shape attached to this body.

Params:

• geometry — The geometry to use.
• definition — The shape definition to use.

Returns: The created shape.

CreateShape(ChainSegmentGeometry)

Create a Chain Segment shape, using its default definition, attached to this body.

Params:

• geometry — The geometry to use.

Returns: The created shape.

CreateShape(ChainSegmentGeometry, PhysicsShapeDefinition)

Create a Chain Segment shape attached to this body.

Params:

• geometry — The geometry to use.
• definition — The shape definition to use.

Returns: The created shape.

CreateShapeBatch(ReadOnlySpan{Unity.U2D.Physics.CircleGeometry}, PhysicsShapeDefinition, Unity.Collections.Allocator)

Create a batch of Circle shapes attached to this body.

Params:

• geometry — The shape geometry to use.
• definition — The shape definition to use.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The created shapes. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

CreateShapeBatch(ReadOnlySpan{Unity.U2D.Physics.PolygonGeometry}, PhysicsShapeDefinition, Unity.Collections.Allocator)

Create a batch of Polygon shapes attached to this body.

Params:

• geometry — The shape geometry to use.
• definition — The shape definition to use.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The created shapes. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

CreateShapeBatch(ReadOnlySpan{Unity.U2D.Physics.CapsuleGeometry}, PhysicsShapeDefinition, Unity.Collections.Allocator)

Create a batch of Capsule shapes attached to this body.

Params:

• geometry — The shape geometry to use.
• definition — The shape definition to use.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The created shapes. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

CreateShapeBatch(ReadOnlySpan{Unity.U2D.Physics.SegmentGeometry}, PhysicsShapeDefinition, Unity.Collections.Allocator)

Create a batch of Segment shapes attached to this body.

Params:

• geometry — The shape geometry to use.
• definition — The shape definition to use.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The created shapes. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

CreateShapeBatch(ReadOnlySpan{Unity.U2D.Physics.ChainSegmentGeometry}, PhysicsShapeDefinition, Unity.Collections.Allocator)

Create a batch of Chain Segment shapes attached to this body.

Params:

• geometry — The shape geometry to use.
• definition — The shape definition to use.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The created shapes. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

Destroy(int)

Destroy a body, destroying all attached and . If the object is owned with then you must provide the owner key it returned. Failing to do so will return a warning and the body will not be destroyed.

Params:

• ownerKey — Optional owner key returned when using .

Returns: If the body was destroyed or not.

DestroyBatch(ReadOnlySpan{Unity.U2D.Physics.PhysicsBody})

Destroy a batch of bodies, destroying all attached and . Any invalid bodies will be ignored. Owned bodies will produce a warning and will not be destroyed (See ).

Params:

• bodies — The bodies to destroy.

Distance(PhysicsShape, bool)

Get the minimum distance between all the shapes attached to this body and the specified shape.

Params:

• physicsShape — The shape to check the distance of.
• useRadii — Whether to use the radii of all shapes or not.

Returns: The distance result.

Draw()

Draw a body that visually represents its current state in the world.

Equals(object)

Equals(PhysicsBody)

GetAABB()

Get the world AABB that bounds all the shapes attached to this body. If there are no shapes attached to the body then the returned AABB is empty and centered on the body origin.

Returns: The world AABB that bounds all the shapes attached to this body.

GetBatchTransform(ReadOnlySpan{Unity.U2D.Physics.PhysicsBody}, Unity.Collections.Allocator)

Get the transform for a batch of .

Params:

• bodies — The bodies to retrieve the batch of transforms for.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The batch of transform for the specified bodies.

GetBatchVelocity(ReadOnlySpan{Unity.U2D.Physics.PhysicsBody}, Unity.Collections.Allocator)

Get the velocity for a batch of .

Params:

• bodies — The bodies to retrieve the batch of velocity for.
• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The batch of velocity for the specified bodies.

GetContacts(Unity.Collections.Allocator)

Get all the touching contacts this body is currently participating in. Speculative collision is used so some contact points may be separated, a property available in the provided contact manifold.

Params:

• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The touching contacts this body is currently participating in. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

GetHashCode()

GetJoints(Unity.Collections.Allocator)

Get the joints attached to this body.

Params:

• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The joints attached to this body. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

GetLocalPoint(Vector2)

Gets a local point relative to the body given a world point.

Params:

• worldPoint — The world point to transform.

Returns: The local point relative to the body.

GetLocalPointVelocity(Vector2)

Get the linear velocity of a local point attached to a body. Usually in meters per second.

Params:

• localPoint — The local point to transform.

Returns: The linear velocity at the specified local point attached to a body.

GetLocalVector(Vector2)

Gets a local vector on a body given a world vector.

Params:

• worldVector — The world vector to transform.

Returns: The local vector relative to the body.

GetOwner()

Get the owner object associated with this body as specified using .

Returns: The owner object associated with this body or NULL if no owner has been specified.

GetShapes(Unity.Collections.Allocator)

Get the shapes attached to this body.

Params:

• allocator — The memory allocator to use for the results. This can only be , or .

Returns: The shapes attached to this body. This NativeArray must be disposed of after use otherwise leaks will occur. The exception to this is if the array is empty.

GetWorldPoint(Vector2)

Gets a world point transformed from a local point relative to the body.

Params:

• localPoint — The local point to transform.

Returns: The transformed world point.

GetWorldPointVelocity(Vector2)

Get the linear velocity of a world point attached to a body. Usually in meters per second.

Params:

• worldPoint — The world point to transform.

Returns: The linear velocity at the specified world point attached to a body.

GetWorldVector(Vector2)

Gets a world vector transformed from a local vector relative to the body.

Params:

• localVector — The local vector to transform.

Returns: The transformed world vector.

operator ==(PhysicsBody, PhysicsBody)

operator !=(PhysicsBody, PhysicsBody)

ReadPose(Transform, Vector3, Quaternion)

Read the full 3D position and rotation of the body given the specified .

Params:

• transform — The Transform object to be used as a reference when converting from 2D position/rotation to 3D position/rotation, usually the same as any TransformObject assigned to the PhysicsBody.
• position — The calculated output position.
• rotation — The calculated output rotation.

SetBatchForce(ReadOnlySpan{Unity.U2D.Physics.PhysicsBody.BatchForce})

Apply a force for a batch of using a span of . If invalid values are passed to the batch, they will simply be ignored. For best performance, the bodies contained in the batch should all be part of the same . If the bodies in the batch are not contained in the same , the batch should be sorted by the the bodies are contained within.

Params:

• batch — The batch of bodies and values to set.

SetBatchImpulse(ReadOnlySpan{Unity.U2D.Physics.PhysicsBody.BatchImpulse})

Apply an impulse for a batch of using a span of . If invalid values are passed to the batch, they will simply be ignored. For best performance, the bodies contained in the batch should all be part of the same . If the bodies in the batch are not contained in the same , the batch should be sorted by the the bodies are contained within.

Params:

• batch — The batch of bodies and values to set.

SetBatchTransform(ReadOnlySpan{Unity.U2D.Physics.PhysicsBody.BatchTransform})

Set the transform for a batch of using a span of . If invalid values are passed to the batch, they will simply be ignored. For best performance, the bodies contained in the batch should all be part of the same . If the bodies in the batch are not contained in the same , the batch should be sorted by the the bodies are contained within.

Params:

• batch — The batch of bodies and values to set.

SetBatchVelocity(ReadOnlySpan{Unity.U2D.Physics.PhysicsBody.BatchVelocity})

Set the velocity for a batch of using a span of . If invalid values are passed to the batch, they will simply be ignored. For best performance, the bodies contained in the batch should all be part of the same . If the bodies in the batch are not contained in the same , the batch should be sorted by the the bodies are contained within.

Params:

• batch — The batch of bodies and values to set.

SetContactEvents(bool)

Enable/disable contact events on all shapes attached to the body. See .

Params:

• contactEvents — Whether contact events are allowed on all shapes attached to this body or not.

SetHitEvents(bool)

Enable/disable hit events on all shapes attached to the body. See .

Params:

• hitEvents — Whether hit events are allowed on all shapes attached to this body or not.

SetOwner(ReadOnlySpan{Unity.U2D.Physics.PhysicsBody}, Object, int)

Set the owner object using the specified owner key. You can only set the owner once, multiple attempts will produce a warning. This call does not bind the lifetime of the specified owner object, it is simply a reference. Whilst it is valid to not specify an owner object (NULL), it is recommended for debugging purposes.

Params:

• bodies — The bodies to set ownership for.
• owner — The object that owns this key. Whilst it is valid to not specify an owner object (NULL), it is recommended for debugging purposes.
• ownerKey — The owner key to be used. The value must be non-zero. You can use for this value although any non-zero integer will work.

SetOwner(Object, int)

Set the owner object using the specified owner key. You can only set the owner once, multiple attempts will produce a warning. This call does not bind the lifetime of the specified owner object, it is simply a reference. It is also valid to not specify an owner object (NULL) to simply gain an owner key however it can be useful, if simply for debugging purposes and discovery, to know which object is the owner.

Params:

• owner — The object that owns this key. This can be NULL if not required but is recommended as the key is formed in part by the hash-code of the owner object.
• ownerKey — The owner key to be used. If zero then a new owner key is created. You can use for this value although any non-zero integer will work.

SetOwner(Object)

Set the owner object using the specified owner key. You can only set the owner once, multiple attempts will produce a warning. This call does not bind the lifetime of the specified owner object, it is simply a reference. It is also valid to not specify an owner object (NULL) to simply gain an owner key however it can be useful, if simply for debugging purposes and discovery, to know which object is the owner.

Params:

• owner — The object that owns this key. This can be NULL if not required but is recommended as the key is formed in part by the hash-code of the owner object.

Returns: The owner key assigned.

SetOwnerUserData(PhysicsUserData, int)

Set that can be used for any purpose, typically by the owner only.

Params:

• physicsUserData — The user data to set.
• ownerKey — Optional owner key returned when using .

SetTransformTarget(PhysicsTransform, float)

Set the and to reach the specified transform in the specified time. The resultant transform will be closed by may not be exact. This is designed ideally for Kinematic bodies but will work with Dynamic bodies if nothing changes the assigned velocities. This will be ignored if the calculated and would be below the . This will automatically wake the body if it is asleep.

Params:

• transform — The transform target for the body.
• deltaTime — The timer over which to calculate the required velocities to move to the transform.

ToString()

WakeTouching()

Wake any bodies that are touching this body via their shapes. This also works for Static bodies.

WritePose()

Write the full 3D position and rotation of the body to the currently set . If no is assigned, this method will do nothing and false will be returned.

Returns: Whether the was written to.

Nested Types

• BatchForce — A batch item used to apply a force to a .
• BatchImpulse — A batch item used to apply an impulse to a .
• BatchTransform — A batch item used to get/set the pose of a .
• BatchVelocity — A batch item used to set the velocity of a .
• BodyConstraints — Body constrains constrain the degrees of freedom a body when solving the simulation.
• BodyType — A body is one of these three body types, Dynamic, Kinematic or Static, each of which determines how the body behaves in the simulation.
• MassConfiguration — This holds the mass configuration computed for a PhysicsBody.
• TransformWriteMode — The method used to Write the body pose to the Transform. See .
• TransformWriteTween — Used to define a Transform write "tween" for a body.

BatchForce

A batch item used to apply a force to a .

Full name: Unity.U2D.Physics.PhysicsBody.BatchForce

Properties

Methods

new(PhysicsBody)

Create a default batch force, assigning the .

Params:

• physicsBody — The to write to.

ApplyForce(Vector2, Vector2, bool)

Apply a force at a world point. If the force is not applied at the center of mass, it will generate a torque and affect the angular velocity. .

Params:

• force — The world force vector, usually in newtons (N)
• point — The world position of the point of application.
• wake — Should the body be woken up.

ApplyForceToCenter(Vector2, bool)

Apply a force to the center of mass. .

Params:

• force — The world force vector, usually in newtons (N).
• wake — Should the body be woken up.

ApplyTorque(float, bool)

Apply a torque. This affects the angular velocity without affecting the linear velocity. .

Params:

• torque — Torque, usually in N*m.
• wake — Should the body be woken up.

BatchImpulse

A batch item used to apply an impulse to a .

Full name: Unity.U2D.Physics.PhysicsBody.BatchImpulse

Properties

Methods

new(PhysicsBody)

Create a default batch impulse, assigning the .

Params:

• physicsBody — The to write to.

ApplyAngularImpulse(float, bool)

Apply an angular impulse. This should be used for one-shot impulses. If you need a steady torque, use a torque instead, which will work better with the sub-stepping solver. .

Params:

• impulse — The angular impulse, usually in units of kgmm/s.
• wake — Should the body be woken up.

ApplyLinearImpulse(Vector2, Vector2, bool)

Apply an impulse at a point. This immediately modifies the velocity and also modifies the angular velocity if the point of application is not at the center of mass. This should be used for one-shot impulses. If you need a steady force, use a force instead, which will work better with the sub-stepping solver. .

Params:

• impulse — The world impulse vector, usually in Ns or kgm/s.
• point — The world position of the point of application.
• wake — Should the body be woken up.

ApplyLinearImpulseToCenter(Vector2, bool)

Apply an impulse to the center of mass. This immediately modifies the velocity. This should be used for one-shot impulses. If you need a steady force, use a force instead, which will work better with the sub-stepping solver. .

Params:

• impulse — The world impulse vector, usually in Ns or kgm/s.
• wake — Should the body be woken up.

BatchTransform

A batch item used to get/set the pose of a .

Full name: Unity.U2D.Physics.PhysicsBody.BatchTransform

Properties

Methods

new(PhysicsBody)

Create a default batch transform, assigning the .

Params:

• physicsBody — The to write to.

BatchVelocity

A batch item used to set the velocity of a .

Full name: Unity.U2D.Physics.PhysicsBody.BatchVelocity

Properties

Methods

new(PhysicsBody)

Create a default batch velocity, assigning the .

Params:

• physicsBody — The to write to.

BodyConstraints

Body constrains constrain the degrees of freedom a body when solving the simulation.

Full name: Unity.U2D.Physics.PhysicsBody.BodyConstraints

Fields

BodyType

A body is one of these three body types, Dynamic, Kinematic or Static, each of which determines how the body behaves in the simulation.

Full name: Unity.U2D.Physics.PhysicsBody.BodyType

Fields

MassConfiguration

This holds the mass configuration computed for a PhysicsBody.

Full name: Unity.U2D.Physics.PhysicsBody.MassConfiguration

Properties

TransformWriteMode

The method used to Write the body pose to the Transform. See .

Full name: Unity.U2D.Physics.PhysicsBody.TransformWriteMode

Fields

TransformWriteTween

Used to define a Transform write "tween" for a body.

Full name: Unity.U2D.Physics.PhysicsBody.TransformWriteTween

Properties

Methods

GetExtrapolatedPose(PhysicsWorld.TransformPlane, PhysicsWorld.TransformPlaneCustom, float, Vector3, Quaternion)

Get the extrapolated pose for the current write tween.

Params:

• transformPlane — The transform plane to use to calculate a non-custom transform plane.
• transformPlaneCustom — The custom transform plane to use.
• extrapolationTime — The extrapolation time to use in the range [0, 1].
• position — The calculated position.
• rotation — The calculated rotation.

GetInterpolatedPose(PhysicsWorld.TransformPlane, PhysicsWorld.TransformPlaneCustom, bool, float, Vector3, Quaternion)

Get the interpolated pose for the current write tween.

Params:

• transformPlane — The transform plane to use to calculate a non-custom transform plane.
• transformPlaneCustom — The custom transform plane to use.
• fast2D — Whether to perform fast 2D or slow 3D calculations. See .
• interpolationTime — The interpolation time to use in the range [0, 1].
• position — The calculated position.
• rotation — The calculated rotation.

GetPose(PhysicsWorld.TransformPlane, PhysicsWorld.TransformPlaneCustom, bool, Vector3, Quaternion)

Get the write pose for the current write tween.

Params:

• transformPlane — The transform plane to use to calculate a non-custom transform plane.
• transformPlaneCustom — The custom transform plane to use.
• fast2D — Whether to perform fast 2D or slow 3D calculations. See .
• position — The calculated position.
• rotation — The calculated rotation.

PhysicsBodyDefinition

A definition used to specify important initial properties.

Full name: Unity.U2D.Physics.PhysicsBodyDefinition
Docs: Unity.U2D.Physics.PhysicsBodyDefinition

Properties

Methods

new()

Create a default definition.

new(bool)

Create a default definition.

Params:

• useSettings — Controls whether the default settings come from the physics settings or not.

Generated by ~/.claude/physicscore2d-api-generator/_generate.py from Unity 6000.5.0b9 UnityEngine.PhysicsCore2DModule.xml. Do not hand-edit; re-run the generator.