Version: 2019.1 (switch to 2018.4
LanguageEnglish
  • C#

Rigidbody.AddExplosionForce

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public void AddExplosionForce(float explosionForce, Vector3 explosionPosition, float explosionRadius, float upwardsModifier = 0.0f, ForceMode mode = ForceMode.Force));

Parameters

explosionForceThe force of the explosion (which may be modified by distance).
explosionPositionThe centre of the sphere within which the explosion has its effect.
explosionRadiusThe radius of the sphere within which the explosion has its effect.
upwardsModifierAdjustment to the apparent position of the explosion to make it seem to lift objects.
modeThe method used to apply the force to its targets.

Description

Applies a force to a rigidbody that simulates explosion effects.

The explosion is modelled as a sphere with a certain centre position and radius in world space; normally, anything outside the sphere is not affected by the explosion and the force decreases in proportion to distance from the centre. However, if a value of zero is passed for the radius then the full force will be applied regardless of how far the centre is from the rigidbody.

This function applies a force to the object at the point on the surface of the rigidbody that is closest to explosionPosition. The force acts along the direction from explosionPosition to the surface point on the rigidbody. If explosionPosition is inside the rigidbody, or the rigidbody has no active colliders, then the center of mass is used instead of the closest point on the surface.

The magnitude of the force is dependent on the distance between explosionPosition and the point where the force was applied at. As the distance between explosionPosition and the force point increases, the actual applied force decreases.

The vertical direction of the force can be modified using upwardsModifier. If this parameter is greater than zero, the force is going to be applied at the point on the surface of the rigidbody that is closest to explosionPosition shifted negative upwardsModifier along Y. Using this parameter, you can make the explosion appear to throw objects up into the air, which can give a more dramatic effect rather than a simple outward force. Force can be applied only to an active rigidbody. If a GameObject is inactive, AddExplosionForce has no effect.

using UnityEngine;
using System.Collections;

// Applies an explosion force to all nearby rigidbodies public class ExampleClass : MonoBehaviour { public float radius = 5.0F; public float power = 10.0F;

void Start() { Vector3 explosionPos = transform.position; Collider[] colliders = Physics.OverlapSphere(explosionPos, radius); foreach (Collider hit in colliders) { Rigidbody rb = hit.GetComponent<Rigidbody>();

if (rb != null) rb.AddExplosionForce(power, explosionPos, radius, 3.0F); } } }

Did you find this page useful? Please give it a rating: