docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct VehicleControlSystem.VehicleControlJob

    Updates the powertrain and sends the torque to the WheelControl. Also handles steering and aerodynamics.

    Implements
    IJobEntity
    IJobChunk
    Inherited Members
    ValueType.Equals(object)
    ValueType.GetHashCode()
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: Unity.Vehicles
    Assembly: com.unity.vehicles.dll
    Syntax
    [BurstCompile]
    [WithAll(new Type[] { typeof(Simulate) })]
    public struct VehicleControlSystem.VehicleControlJob : IJobEntity, IJobChunk

    Fields

    DeltaTime

    Time since the last update.

    Declaration
    public float DeltaTime
    Field Value
    Type Description
    float

    EngineControlLookup

    EngineStartStop lookup.

    Declaration
    [NativeDisableParallelForRestriction]
    public ComponentLookup<EngineStartStop> EngineControlLookup
    Field Value
    Type Description
    ComponentLookup<EngineStartStop>

    PhysicsWorld

    The physics world

    Declaration
    [ReadOnly]
    public PhysicsWorld PhysicsWorld
    Field Value
    Type Description
    PhysicsWorld

    WheelControlLookup

    WheelControl lookup.

    Declaration
    [ReadOnly]
    public ComponentLookup<WheelControl> WheelControlLookup
    Field Value
    Type Description
    ComponentLookup<WheelControl>

    Methods

    Execute(in ArchetypeChunk, int, bool, in v128)

    Declaration
    public void Execute(in ArchetypeChunk chunk, int chunkIndexInQuery, bool useEnabledMask, in v128 chunkEnabledMask)
    Parameters
    Type Name Description
    ArchetypeChunk chunk
    int chunkIndexInQuery
    bool useEnabledMask
    v128 chunkEnabledMask

    Run()

    Declaration
    public void Run()

    Run(EntityQuery)

    Declaration
    public void Run(EntityQuery query)
    Parameters
    Type Name Description
    EntityQuery query

    RunByRef()

    Declaration
    public void RunByRef()

    RunByRef(EntityQuery)

    Declaration
    public void RunByRef(EntityQuery query)
    Parameters
    Type Name Description
    EntityQuery query

    Schedule()

    Declaration
    public void Schedule()

    Schedule(EntityQuery)

    Declaration
    public void Schedule(EntityQuery query)
    Parameters
    Type Name Description
    EntityQuery query

    Schedule(EntityQuery, JobHandle)

    Declaration
    public JobHandle Schedule(EntityQuery query, JobHandle dependsOn)
    Parameters
    Type Name Description
    EntityQuery query
    JobHandle dependsOn
    Returns
    Type Description
    JobHandle

    Schedule(JobHandle)

    Declaration
    public JobHandle Schedule(JobHandle dependsOn)
    Parameters
    Type Name Description
    JobHandle dependsOn
    Returns
    Type Description
    JobHandle

    ScheduleByRef()

    Declaration
    public void ScheduleByRef()

    ScheduleByRef(EntityQuery)

    Declaration
    public void ScheduleByRef(EntityQuery query)
    Parameters
    Type Name Description
    EntityQuery query

    ScheduleByRef(EntityQuery, JobHandle)

    Declaration
    public JobHandle ScheduleByRef(EntityQuery query, JobHandle dependsOn)
    Parameters
    Type Name Description
    EntityQuery query
    JobHandle dependsOn
    Returns
    Type Description
    JobHandle

    ScheduleByRef(JobHandle)

    Declaration
    public JobHandle ScheduleByRef(JobHandle dependsOn)
    Parameters
    Type Name Description
    JobHandle dependsOn
    Returns
    Type Description
    JobHandle

    ScheduleParallel()

    Declaration
    public void ScheduleParallel()

    ScheduleParallel(EntityQuery)

    Declaration
    public void ScheduleParallel(EntityQuery query)
    Parameters
    Type Name Description
    EntityQuery query

    ScheduleParallel(EntityQuery, JobHandle)

    Declaration
    public JobHandle ScheduleParallel(EntityQuery query, JobHandle dependsOn)
    Parameters
    Type Name Description
    EntityQuery query
    JobHandle dependsOn
    Returns
    Type Description
    JobHandle

    ScheduleParallel(EntityQuery, JobHandle, NativeArray<int>)

    Declaration
    public JobHandle ScheduleParallel(EntityQuery query, JobHandle dependsOn, NativeArray<int> chunkBaseEntityIndices)
    Parameters
    Type Name Description
    EntityQuery query
    JobHandle dependsOn
    NativeArray<int> chunkBaseEntityIndices
    Returns
    Type Description
    JobHandle

    ScheduleParallel(JobHandle)

    Declaration
    public JobHandle ScheduleParallel(JobHandle dependsOn)
    Parameters
    Type Name Description
    JobHandle dependsOn
    Returns
    Type Description
    JobHandle

    ScheduleParallelByRef()

    Declaration
    public void ScheduleParallelByRef()

    ScheduleParallelByRef(EntityQuery)

    Declaration
    public void ScheduleParallelByRef(EntityQuery query)
    Parameters
    Type Name Description
    EntityQuery query

    ScheduleParallelByRef(EntityQuery, JobHandle)

    Declaration
    public JobHandle ScheduleParallelByRef(EntityQuery query, JobHandle dependsOn)
    Parameters
    Type Name Description
    EntityQuery query
    JobHandle dependsOn
    Returns
    Type Description
    JobHandle

    ScheduleParallelByRef(EntityQuery, JobHandle, NativeArray<int>)

    Declaration
    public JobHandle ScheduleParallelByRef(EntityQuery query, JobHandle dependsOn, NativeArray<int> chunkBaseEntityIndices)
    Parameters
    Type Name Description
    EntityQuery query
    JobHandle dependsOn
    NativeArray<int> chunkBaseEntityIndices
    Returns
    Type Description
    JobHandle

    ScheduleParallelByRef(JobHandle)

    Declaration
    public JobHandle ScheduleParallelByRef(JobHandle dependsOn)
    Parameters
    Type Name Description
    JobHandle dependsOn
    Returns
    Type Description
    JobHandle

    ShiftDown(ref VehicleControlData, ref DynamicBuffer<VehicleControlEvent>)

    Attempts to shift the transmission down a gear.

    Declaration
    public static bool ShiftDown(ref VehicleControlData vehicleControlData, ref DynamicBuffer<VehicleControlEvent> controlEvents)
    Parameters
    Type Name Description
    VehicleControlData vehicleControlData

    Target VehicleControlData.

    DynamicBuffer<VehicleControlEvent> controlEvents

    Vehicle control inputs.

    Returns
    Type Description
    bool

    True on successful shift.

    ShiftInto(int, ref VehicleControlData, ref DynamicBuffer<VehicleControlEvent>)

    Attempts to shift the transmission into the target gear.

    Declaration
    public static bool ShiftInto(int targetGear, ref VehicleControlData vehicleControlData, ref DynamicBuffer<VehicleControlEvent> controlEvents)
    Parameters
    Type Name Description
    int targetGear

    Target fear to shift into.

    VehicleControlData vehicleControlData

    Target VehicleControlData.

    DynamicBuffer<VehicleControlEvent> controlEvents

    Vehicle control inputs.

    Returns
    Type Description
    bool

    True on successful shift.

    ShiftUp(ref VehicleControlData, ref DynamicBuffer<VehicleControlEvent>)

    Attempts to shift the transmission up a gear.

    Declaration
    public static bool ShiftUp(ref VehicleControlData vehicleControlData, ref DynamicBuffer<VehicleControlEvent> controlEvents)
    Parameters
    Type Name Description
    VehicleControlData vehicleControlData

    Target VehicleControlData.

    DynamicBuffer<VehicleControlEvent> controlEvents

    Vehicle control inputs.

    Returns
    Type Description
    bool

    True on successful shift.

    StartEngine(Entity)

    Starts the engine.

    Declaration
    public void StartEngine(Entity entity)
    Parameters
    Type Name Description
    Entity entity

    Target VehicleControl

    StopEngine(Entity)

    Stops the engine.

    Declaration
    public void StopEngine(Entity entity)
    Parameters
    Type Name Description
    Entity entity

    Target VehicleControl.

    Implements

    IJobEntity
    IJobChunk
    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)