s&box

class PhysicsBody

robot_2Generated

code_blocksInput

Description

The PhysicsBody class in the Sandbox namespace represents a physics object within the game environment. It can be composed of multiple physics shapes and is part of a physics group. This class provides various methods and properties to manipulate and interact with the physics body, such as applying forces, adding shapes, and checking for overlaps.

Members

Instance Methods

Member Name	Summary
Move	Moves the physics body to a new transform over a specified delta time.
AddSphereShape	Adds a spherical shape to the physics body.
AddCapsuleShape	Adds a capsule shape to the physics body.
AddBoxShape	Adds a box shape to the physics body.
AddHullShape	Adds a hull shape to the physics body.
AddCylinderShape	Adds a cylinder shape to the physics body.
AddConeShape	Adds a cone shape to the physics body.
AddMeshShape	Adds a mesh shape to the physics body.
AddHeightFieldShape	Adds a height field shape to the physics body.
AddCloneShape	Adds a clone of an existing shape to the physics body.
ClearShapes	Removes all physics shapes from the body.
RebuildMass	Rebuilds the mass of the body based on its shapes.
Remove	Completely removes the physics body.
ApplyImpulse	Applies an impulse to the physics body.
ApplyImpulseAt	Applies an impulse at a specific point on the physics body.
ApplyAngularImpulse	Applies an angular impulse to the physics body.
ApplyForce	Applies a force to the physics body.
ApplyForceAt	Applies a force at a specific point on the physics body.
ApplyTorque	Applies torque to the physics body.
ClearForces	Clears all accumulated forces on the physics body.
ClearTorque	Clears all accumulated torque on the physics body.
GetVelocityAtPoint	Gets the velocity of the body at a specific point.
FindClosestPoint	Finds the closest point on the body to a given vector.
SetInertiaTensor	Sets the inertia tensor of the physics body.
ResetInertiaTensor	Resets the inertia tensor to its default values.
GetBounds	Returns the bounding box of the physics body.
LocalPoint	Converts a world point to a local point on the body.
WorldPoint	Converts a local point to a world point on the body.
MassCenterPoint	Returns the center of mass of the physics body.
CheckOverlap	Checks if this body overlaps with another body.
AddShape	Adds a shape to the physics body.
GetLerpedTransform	Gets the interpolated transform of the body at a specific time.
SmoothMove	Moves the body smoothly to a new position over time.
SmoothRotate	Rotates the body smoothly to a new orientation over time.

Instance Properties

Member Name	Summary
Position	Position of this body in world coordinates.
World	The physics world this body belongs to.
Rotation	Rotation of the physics body in world space.
Scale	Scale of the physics body (obsolete).
Velocity	Linear velocity of this body in world space.
AngularVelocity	Angular velocity of this body in world space.
MassCenter	Center of mass for this physics body in world space coordinates.
LocalMassCenter	Center of mass for this physics body relative to its origin.
OverrideMassCenter	Indicates if the mass center is calculated or set directly.
Mass	Mass of this physics body.
GravityEnabled	Whether gravity is enabled for this body.
EnableCollisionSounds	Whether to play collision sounds.
GravityScale	Scale the gravity relative to the physics world's gravity.
UseController	Indicates if a controller is created for this physics body.
EnableTouch	Enables touch callbacks on all physics shapes of this body.
EnableTouchPersists	Sets persistent touch events on all shapes of this body.
EnableSolidCollisions	Sets solid collisions on all shapes of this body.
BodyType	Movement type of the physics body.
AutoSleep	Indicates if the body can automatically go to sleep after inactivity.
Transform	Transform of this physics body.
ShapeCount	Number of shapes belonging to this body.
Shapes	All shapes that belong to this body.
Enabled	Indicates if the body is enabled.
MotionEnabled	Controls physics simulation on this body.
Sleeping	Indicates if the body is sleeping to save performance.
SpeculativeContactEnabled	If enabled, the body will move slightly ahead each frame (obsolete).
Parent	The physics body this body is attached to, if any.
SelfOrParent	Returns the parent body or itself if no parent exists.
PhysicsGroup	The physics group this body belongs to.
LinearDamping	Generic linear damping of the body.
AngularDamping	Generic angular damping of the body.
LinearDrag	Linear drag of the body (obsolete).
AngularDrag	Angular drag of the body (obsolete).
DragEnabled	Indicates if drag is enabled (obsolete).
Inertia	The diagonal elements of the local inertia tensor matrix.
InertiaRotation	The orientation of the principal axes of the local inertia tensor matrix.
Density	Average density of all physics shapes of this body.
LastWaterEffect	Time since last water splash effect.
SurfaceMaterial	Sets the surface material on all child physics shapes.
Surface	Surface of the physics body.
GroupName	Name of the body in its group.
GroupIndex	Index of the body in its physics group.
OnIntersectionStart	Event triggered when an intersection starts.
OnIntersectionUpdate	Event triggered when an intersection is updated.
OnIntersectionEnd	Event triggered when an intersection ends.
Locking	Locking mechanism for the physics body.

Groups

Properties

Methods

class PhysicsBody

Description

Members

Instance Methods

Instance Properties