Search Unity

Error in documentation

Discussion in 'Documentation' started by Ossyahn, Oct 22, 2014.

  1. Ossyahn

    Ossyahn

    Joined:
    Oct 18, 2014
    Posts:
    1
    There's an error in the scripting API that I just noticed, I don't know where is the better place to report it.

    In the description page for Rigidbody.AddExplosionForce it reads:

    If radius is 0, the full force will be applied no matter how far away position is from the rigidbody. explosionRadius applies the force as if it was applied from beneath the object. This is useful since explosions that throw things up instead of pushing things to the side look cooler. A value of 2 will apply a force as if it is applied from 2 meters below while not changing the actual explosion position. explosionRadius is the position from which the explosion force is to be applied.explosionRadius is the radius of the explosion. Rigidbodies further away than explosionRadius will not be affected.

    while it should be:

    If radius is 0, the full force will be applied no matter how far away position is from the rigidbody. upwardsModifier applies the force as if it was applied from beneath the object. This is useful since explosions that throw things up instead of pushing things to the side look cooler. A value of 2 will apply a force as if it is applied from 2 meters below while not changing the actual explosion position. explosionPosition is the position from which the explosion force is to be applied.explosionRadius is the radius of the explosion. Rigidbodies further away than explosionRadius will not be affected.
     
  2. Graham-Dunnett

    Graham-Dunnett

    Administrator

    Joined:
    Jun 2, 2009
    Posts:
    4,287
    Thanks, we'll sort that.
     
  3. Docman

    Docman

    Unity Technologies

    Joined:
    Oct 19, 2012
    Posts:
    11
    This page in the documentation has been updated, and you should see the change in the next docs release.