Class CinemachineCollisionImpulseSource | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class CinemachineCollisionImpulseSource

    Generate an Impulse Event 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.

    Inheritance
    System.Object
    CinemachineImpulseSource
    CinemachineCollisionImpulseSource
    Inherited Members
    CinemachineImpulseSource.m_ImpulseDefinition
    CinemachineImpulseSource.GenerateImpulseAt(Vector3, Vector3)
    CinemachineImpulseSource.GenerateImpulse(Vector3)
    CinemachineImpulseSource.GenerateImpulse()
    Namespace: Cinemachine
    Syntax
    [DocumentationSorting(DocumentationSortingAttribute.Level.UserRef)]
    public class CinemachineCollisionImpulseSource : CinemachineImpulseSource

    Fields

    m_IgnoreTag

    No Impulse evemts will be generated for collisions with objects having these tags

    Declaration
    public string m_IgnoreTag
    Field Value
    Type Description
    System.String

    m_LayerMask

    Only collisions with objects on these layers will generate Impulse events.

    Declaration
    public LayerMask m_LayerMask
    Field Value
    Type Description
    LayerMask

    m_ScaleImpactWithMass

    If checked, signal amplitude will be multiplied by the mass of the impacting object

    Declaration
    public bool m_ScaleImpactWithMass
    Field Value
    Type Description
    System.Boolean

    m_ScaleImpactWithSpeed

    If checked, signal amplitude will be multiplied by the speed of the impacting object

    Declaration
    public bool m_ScaleImpactWithSpeed
    Field Value
    Type Description
    System.Boolean

    m_UseImpactDirection

    If checked, signal direction will be affected by the direction of impact

    Declaration
    public bool m_UseImpactDirection
    Field Value
    Type Description
    System.Boolean
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023