s&box

class PhysicsBody

book_4_sparkGenerated

code_blocksInput

Description

The PhysicsBody class in the Sandbox namespace represents a physics object within the game. An entity can have multiple physics objects, each consisting of one or more PhysicsShapes. This class provides various methods and properties to manipulate and interact with the physics body, such as applying forces, adding shapes, and checking overlaps.

Members

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	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	Is this physics body mass calculated or set directly.
Mass	Mass of this physics body.
GravityEnabled	Whether gravity is enabled for this body or not.
EnableCollisionSounds	Whether to play collision sounds.
GravityScale	Scale the gravity relative to the physics world's gravity.
UseController	If true, creates a controller for this physics body for keyframed physics objects.
EnableTouch	Enables Touch callbacks on all PhysicsShapes 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 physics body, either Static, Keyframed, Dynamic.
AutoSleep	Whether this body is allowed to automatically go into "sleep" after inactivity.
Transform	Transform of this physics body.
ShapeCount	How many shapes belong to this body.
Shapes	All shapes that belong to this body.
Enabled	Whether this body is enabled or not.
MotionEnabled	Controls physics simulation on this body.
Sleeping	Physics bodies automatically go to sleep after inactivity to save on performance.
SpeculativeContactEnabled	Obsolete.
Parent	The physics body we are attached to, if any.
SelfOrParent	Returns Parent, or if there is no parent, returns itself.
PhysicsGroup	The physics group we belong to.
LinearDamping	Generic linear damping, i.e. how much the physics body will slow down on its own.
AngularDamping	Generic angular damping, i.e. how much the physics body will slow down on its own.
LinearDrag	Amount of air drag to be applied to linear movement.
AngularDrag	Amount of air drag to be applied to angular movement/rotation.
DragEnabled	Whether air drag forces are enabled for this body.
Inertia	The diagonal elements of the inertia tensor matrix.
InertiaRotation	The orientation of the principal axes of inertia tensor matrix.
Density	Returns average of densities for all physics shapes of this body.
LastWaterEffect	Time since last water splash effect. Used internally.
SurfaceMaterial	Sets surface material on all child PhysicsShapes.
Surface	Surface material of the physics body.
GroupName	What is this body called in the group?
GroupIndex	Return the index of this body in its PhysicsGroup.
OnIntersectionStart	Event triggered when an intersection starts.
OnIntersectionUpdate	Event triggered when an intersection updates.
OnIntersectionEnd	Event triggered when an intersection ends.
Locking	Physics lock state of the body.

Methods

Member Name	Summary
Move	Moves the physics body to a new transform over a delta time.
AddSphereShape	Adds a sphere 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	Remove all physics shapes, but not the physics body itself.
RebuildMass	Rebuilds mass from all shapes of this body based on their volume and physics properties.
Remove	Completely removes this 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 a torque to the physics body.
ClearForces	Clear accumulated linear forces during this physics frame that were not yet applied to the physics body.
ClearTorque	Clear accumulated torque during this physics frame that were not yet applied to the physics body.
GetVelocityAtPoint	Gets the velocity of the physics body at a specific point.
FindClosestPoint	Finds the closest point on the physics body to a given vector.
GetBounds	Returns Axis-Aligned Bounding Box (AABB) of this physics body.
LocalPoint	Converts a world point to a local point relative to the physics body.
WorldPoint	Converts a local point to a world point relative to the physics body.
MassCenterPoint	Returns a PhysicsPoint at the center of mass of this body.
CheckOverlap	Checks if this physics body overlaps with another.
AddShape	Adds a shape to the physics body.
GetLerpedTransform	Gets the interpolated transform of the physics body at a specific time.
SmoothMove	Moves the physics body smoothly to a new position over time.
SmoothRotate	Rotates the physics body smoothly to a new orientation over time.

Groups

Properties

Methods

class PhysicsBody

Description

Members

Properties

Methods