Skip to content

Commit

Permalink
DOCATT-4964 - Add hint for impulse characteristics
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienduverne committed Jun 18, 2024
1 parent 7d58b3b commit 6ef7068
Showing 1 changed file with 3 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ namespace Unity.Cinemachine
public class CinemachineCollisionImpulseSource : CinemachineImpulseSource {}
#else
/// <summary>
/// Generate an Impulse Event this object's Collider collides with something
/// Generate an Impulse Event when this object's Collider collides with something
/// or its trigger zone is entered.
///
/// This component should be attached to a GameObject with a Collider or a Collider2D.
/// Objects colliding with this (or entering its trigger zone if it's a trigger) will be
/// filtered according to the layer and tag settings defined here, and if they
/// pass the filter, they will cause an impulse event to be generated.
///
/// Use CinemachineImpulseSource.ImpulseDefinition to define the characteristics of the impulse.
/// </summary>
[SaveDuringPlay]
[AddComponentMenu("Cinemachine/Helpers/Cinemachine Collision Impulse Source")]
Expand Down

0 comments on commit 6ef7068

Please sign in to comment.