docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class VehicleAuthoring

    Authoring component for vehicles

    Inheritance
    object
    Object
    Component
    Behaviour
    MonoBehaviour
    VehicleAuthoring
    Inherited Members
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(string, float)
    MonoBehaviour.InvokeRepeating(string, float, float)
    MonoBehaviour.CancelInvoke(string)
    MonoBehaviour.IsInvoking(string)
    MonoBehaviour.StartCoroutine(string)
    MonoBehaviour.StartCoroutine(string, object)
    MonoBehaviour.StartCoroutine(IEnumerator)
    MonoBehaviour.StartCoroutine_Auto(IEnumerator)
    MonoBehaviour.StopCoroutine(IEnumerator)
    MonoBehaviour.StopCoroutine(Coroutine)
    MonoBehaviour.StopCoroutine(string)
    MonoBehaviour.StopAllCoroutines()
    MonoBehaviour.print(object)
    MonoBehaviour.destroyCancellationToken
    MonoBehaviour.useGUILayout
    MonoBehaviour.didStart
    MonoBehaviour.didAwake
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, out Component)
    Component.TryGetComponent<T>(out T)
    Component.GetComponent(string)
    Component.GetComponentInChildren(Type, bool)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(bool)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, bool)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(bool)
    Component.GetComponentsInChildren<T>(bool, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type, bool)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>(bool)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, bool)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(bool)
    Component.GetComponentsInParent<T>(bool, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.GetComponentIndex()
    Component.CompareTag(string)
    Component.CompareTag(TagHandle)
    Component.SendMessageUpwards(string, object, SendMessageOptions)
    Component.SendMessageUpwards(string, object)
    Component.SendMessageUpwards(string)
    Component.SendMessageUpwards(string, SendMessageOptions)
    Component.SendMessage(string, object)
    Component.SendMessage(string)
    Component.SendMessage(string, object, SendMessageOptions)
    Component.SendMessage(string, SendMessageOptions)
    Component.BroadcastMessage(string, object, SendMessageOptions)
    Component.BroadcastMessage(string, object)
    Component.BroadcastMessage(string)
    Component.BroadcastMessage(string, SendMessageOptions)
    Component.transform
    Component.gameObject
    Component.tag
    Object.GetInstanceID()
    Object.GetHashCode()
    Object.Equals(object)
    Object.InstantiateAsync<T>(T)
    Object.InstantiateAsync<T>(T, Transform)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int)
    Object.InstantiateAsync<T>(T, int, Transform)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)
    Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)
    Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)
    Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)
    Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)
    Object.Instantiate(Object, Vector3, Quaternion)
    Object.Instantiate(Object, Vector3, Quaternion, Transform)
    Object.Instantiate(Object)
    Object.Instantiate(Object, Scene)
    Object.Instantiate<T>(T, InstantiateParameters)
    Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)
    Object.Instantiate(Object, Transform)
    Object.Instantiate(Object, Transform, bool)
    Object.Instantiate<T>(T)
    Object.Instantiate<T>(T, Vector3, Quaternion)
    Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
    Object.Instantiate<T>(T, Transform)
    Object.Instantiate<T>(T, Transform, bool)
    Object.Destroy(Object, float)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, bool)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.FindObjectsOfType(Type, bool)
    Object.FindObjectsByType(Type, FindObjectsSortMode)
    Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, float)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectsByType<T>(FindObjectsSortMode)
    Object.FindObjectsOfType<T>(bool)
    Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
    Object.FindObjectOfType<T>()
    Object.FindObjectOfType<T>(bool)
    Object.FindFirstObjectByType<T>()
    Object.FindAnyObjectByType<T>()
    Object.FindFirstObjectByType<T>(FindObjectsInactive)
    Object.FindAnyObjectByType<T>(FindObjectsInactive)
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.FindFirstObjectByType(Type)
    Object.FindAnyObjectByType(Type)
    Object.FindObjectOfType(Type, bool)
    Object.FindFirstObjectByType(Type, FindObjectsInactive)
    Object.FindAnyObjectByType(Type, FindObjectsInactive)
    Object.ToString()
    Object.name
    Object.hideFlags
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.Vehicles
    Assembly: com.unity.vehicles.dll
    Syntax
    [DisallowMultipleComponent]
    public class VehicleAuthoring : MonoBehaviour

    Fields

    AxlePairedWheels

    Array of wheel pairs belonging to the same axle. A pair consists of a left and a right wheel, in that order.

    Declaration
    [Tooltip("Array of wheel pairs belonging to the same axle.  A pair consists of a left and a right wheel, in that order.")]
    public PairedWheels[] AxlePairedWheels
    Field Value
    Type Description
    PairedWheels[]

    ContactSurfaceNormalAngleThreshold

    Angle threshold for collision smoothing between the vehicle and mesh colliders.

    If, at a given contact point between the vehicle and a mesh collider, the angle between the contact normal and the mesh surface normal is larger than this threshold and does not exceed 90 degrees minus this threshold, the normal of the corresponding contact will be set to the surface normal, ensuring smooth collisions with the terrain surface.

    Declaration
    [Tooltip("Angle threshold for collision smoothing between the vehicle and mesh colliders.\n\nIf, at a given contact point between the vehicle and a mesh collider, the angle between the contact normal and the mesh surface normal is larger than this threshold and does not exceed 90 degrees minus this threshold, the normal of the corresponding contact will be set to the surface normal, ensuring smooth collisions with the terrain surface.")]
    public float ContactSurfaceNormalAngleThreshold
    Field Value
    Type Description
    float

    Dimensions

    Dimensions of the vehicle, expressed in m. Used to scale certain value thresholds in vehicle code. May also be used for aerodynamics calculations if the Vehicle Control component is used.

    Declaration
    [Tooltip("Dimensions of the vehicle, expressed in m. Used to scale certain value thresholds in vehicle code. May also be used for aerodynamics calculations if the Vehicle Control component is used.")]
    public float3 Dimensions
    Field Value
    Type Description
    float3

    DimensionsDebugCenter

    Local center position of the Dimensions gizmo

    Declaration
    [Tooltip("Local center position of the Dimensions gizmo")]
    public float3 DimensionsDebugCenter
    Field Value
    Type Description
    float3

    HardTerrainFeatureAngleThreshold

    Angle threshold for detecting hard terrain features, for which no smoothing should be applied.

    Corresponds to a threshold on the delta angle between the inverted vehicle's velocity at a given contact point and the colliding terrain feature's surface normal. Any surface feature leading to a delta angle that is larger than the threshold will be considered a hard terrain feature and contacts with this feature will not be filtered, ensuring collisions with hard terrain features are retained, enabling accurate collision response.

    Declaration
    [Tooltip("Angle threshold for detecting hard terrain features, for which no smoothing should be applied.\n\nCorresponds to a threshold on the delta angle between the inverted vehicle's velocity at a given contact point and the colliding terrain feature's surface normal. Any surface feature leading to a delta angle that is larger than the threshold will be considered a hard terrain feature and contacts with this feature will not be filtered, ensuring collisions with hard terrain features are retained, enabling accurate collision response.")]
    public float HardTerrainFeatureAngleThreshold
    Field Value
    Type Description
    float

    SubstepCount

    Number of slices the vehicle physics will slice one physics frame into. Higher values should be used to achieve stiffer friction and better high speed handling.

    Declaration
    [Range(4, 32)]
    [Tooltip("Number of slices the vehicle physics will slice one physics frame into. Higher values should be used to achieve stiffer friction and better high speed handling.")]
    public int SubstepCount
    Field Value
    Type Description
    int

    UseContactFiltering

    Enables contact filtering for smoothing collisions between the vehicle and mesh colliders representing a terrain surface.

    Declaration
    [Tooltip("Enables contact filtering for smoothing collisions between the vehicle and mesh colliders representing a terrain surface.")]
    public bool UseContactFiltering
    Field Value
    Type Description
    bool

    Wheels

    Array holding the wheels belonging to this vehicle in the front left, front right, rear left, rear right, etc. order.

    Declaration
    [Tooltip("Array holding the wheels belonging to this vehicle in the front left, front right, rear left, rear right, etc. order.")]
    public WheelAuthoring[] Wheels
    Field Value
    Type Description
    WheelAuthoring[]

    Methods

    OnAutoDetectWheels()

    Auto detect wheels

    Declaration
    public void OnAutoDetectWheels()
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)