Rigidbodyclass
Adds physics properties to an object. Requires a collider to be attached to the same object.
Constructors1
Showing 1 constructors
public Rigidbody()
No results match this filter.
Methods15
Showing 15 methods
public void ApplyForce(Vector3 force)
Applies linear force to this body
| Parameter | Type | Description |
|---|---|---|
| force | Vector3 | — |
void—public void ApplyForceAt(Vector3 position, Vector3 force)
Applies force to this body at given position.
| Parameter | Type | Description |
|---|---|---|
| position | Vector3 | — |
| force | Vector3 | — |
void—public void ApplyImpulse(Vector3 force)
Applies instant linear impulse (i.e. a bullet impact) to this body
| Parameter | Type | Description |
|---|---|---|
| force | Vector3 | — |
void—public void ApplyImpulseAt(Vector3 position, Vector3 force)
Applies instant linear impulse (i.e. a bullet impact) to this body at given position
| Parameter | Type | Description |
|---|---|---|
| position | Vector3 | — |
| force | Vector3 | — |
void—public void ApplyTorque(Vector3 force)
Applies angular velocity to this body.
| Parameter | Type | Description |
|---|---|---|
| force | Vector3 | — |
void—public void ClearForces()
Clear accumulated linear forces (`Sandbox.Rigidbody.ApplyForce(Vector3@)` and `Sandbox.Rigidbody.ApplyForceAt(Vector3@,Vector3@)`) during this physics frame that were not yet applied to the physics body.
void—public Vector3 FindClosestPoint(Vector3 position)
Returns the closest point to the given one between all convex shapes of this body.
| Parameter | Type | Description |
|---|---|---|
| position | Vector3 | — |
public Vector3 GetVelocityAtPoint(Vector3 position)
Returns the world space velocity of a point of the object. This is useful for objects rotating around their own axis/origin.
| Parameter | Type | Description |
|---|---|---|
| position | Vector3 | — |
public void ResetInertiaTensor()
Resets the inertia tensor and its rotation to the values automatically calculated from the attached colliders. This removes any custom overrides set via `Sandbox.Rigidbody.InertiaTensor` or `Sandbox.Rigidbody.InertiaTensorRotation`.
void—No results match this filter.
Properties28
Showing 28 properties
public float Sandbox.Rigidbody.AngularDamping { get; set; }
float—public bool Sandbox.Rigidbody.CollisionEventsEnabled { get; set; }
Enable or disable touch events. If you disable the events then ICollisionListener won't get any touch events and you won't get things like collision sounds.
bool—public bool Sandbox.Rigidbody.CollisionUpdateEventsEnabled { get; set; }
Like CollisionEventsEnabled but means the OnCollisionUpdate gets called when the collision persists
bool—public bool Sandbox.Rigidbody.EnableImpactDamage { get; set; }
Whether this rigidbody can deal damage to damageable objects on high-speed impacts.
bool—public bool Sandbox.Rigidbody.EnhancedCcd { get; set; }
Enable enhanced continuous collision detection (CCD) for this body. When enabled, the body performs CCD against dynamic bodies (but not against other bodies with enhanced CCD enabled). This is useful for fast-moving objects like bullets or rockets that need reliable collision detection.
bool—public bool Sandbox.Rigidbody.Gravity { get; set; }
Is gravity enabled or not.
bool—public float Sandbox.Rigidbody.GravityScale { get; set; }
Scale the gravity relative to `Sandbox.PhysicsWorld.Gravity`. 2 is double the gravity, etc.
float—public float Sandbox.Rigidbody.ImpactDamage { get; set; }
The amount of damage this rigidbody deals to other objects when it collides at high speed. If set to 0 or less, this will be calculated from the mass of the rigidbody.
float—public Vector3 Sandbox.Rigidbody.InertiaTensor { get; set; }
Gets or sets the inertia tensor for this body. By default, the inertia tensor is automatically calculated from the shapes attached to the body. Setting this property overrides the automatically calculated inertia tensor until `Sandbox.Rigidbody.ResetInertiaTensor` is called.
public Rotation Sandbox.Rigidbody.InertiaTensorRotation { get; set; }
Gets or sets the rotation applied to the inertia tensor. Like `Sandbox.Rigidbody.InertiaTensor`, this acts as an override to the automatically calculated inertia tensor rotation and remains in effect until `Sandbox.Rigidbody.ResetInertiaTensor` is called.
public System.Collections.Generic.IReadOnlySet`1<Sandbox.Joint> Sandbox.Rigidbody.Joints { get; set; }
A list of joints that we're connected to, if any.
public float Sandbox.Rigidbody.LinearDamping { get; set; }
float—public Sandbox.PhysicsLock Sandbox.Rigidbody.Locking { get; set; }
public float Sandbox.Rigidbody.Mass { get; set; }
float—public Vector3 Sandbox.Rigidbody.MassCenter { get; set; }
Center of mass for this rigidbody in local space coordinates.
public float Sandbox.Rigidbody.MassOverride { get; set; }
Override mass for this body, only when value is more than zero
float—public float Sandbox.Rigidbody.MinImpactDamageSpeed { get; set; }
The minimum speed required for an impact to cause damage.
float—public bool Sandbox.Rigidbody.MotionEnabled { get; set; }
bool—public bool Sandbox.Rigidbody.OverrideMassCenter { get; set; }
bool—public Sandbox.PhysicsBody Sandbox.Rigidbody.PhysicsBody { get; set; }
Get the actual physics body that was created by this component. You should be careful, this can of course be null when the object is not enabled or the physics world is not available. It might also get deleted and re-created, so best use this to access, but don't store it.
public Sandbox.RigidbodyFlags Sandbox.Rigidbody.RigidbodyFlags { get; set; }
public bool Sandbox.Rigidbody.Sleeping { get; set; }
bool—public float Sandbox.Rigidbody.SleepThreshold { get; set; }
The speed threshold below which this body will be put to sleep. Units per second. Increase this to make the body sleep sooner, which is useful for stacking stability.
float—public bool Sandbox.Rigidbody.StartAsleep { get; set; }
bool—No results match this filter.