docs.unity3d.com
    Show / Hide Table of Contents

    Class BuildPhysicsWorld

    Inheritance
    Object
    ComponentSystemBase
    SystemBase
    BuildPhysicsWorld
    Inherited Members
    SystemBase.CompleteDependency()
    SystemBase.Update()
    SystemBase.GetComponent<T>(Entity)
    SystemBase.SetComponent<T>(Entity, T)
    SystemBase.HasComponent<T>(Entity)
    SystemBase.GetComponentDataFromEntity<T>(Boolean)
    SystemBase.GetBuffer<T>(Entity, Boolean)
    SystemBase.GetBufferFromEntity<T>(Boolean)
    SystemBase.GetStorageInfoFromEntity()
    Unity.Entities.SystemBase.UnmanagedUpdate$BurstManaged(System.IntPtr, Unity.Entities.SystemDependencySafetyUtility.SafetyErrorDetails)
    SystemBase.Dependency
    SystemBase.Entities
    SystemBase.Job
    ComponentSystemBase.OnCreateForCompiler()
    ComponentSystemBase.OnStopRunning()
    ComponentSystemBase.ShouldRunSystem()
    ComponentSystemBase.GetComponentTypeHandle<T>(Boolean)
    ComponentSystemBase.GetDynamicComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetBufferTypeHandle<T>(Boolean)
    ComponentSystemBase.GetSharedComponentTypeHandle<T>()
    ComponentSystemBase.GetDynamicSharedComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetEntityTypeHandle()
    ComponentSystemBase.RequireForUpdate(EntityQuery)
    ComponentSystemBase.RequireSingletonForUpdate<T>()
    ComponentSystemBase.HasSingleton<T>()
    ComponentSystemBase.GetSingleton<T>()
    ComponentSystemBase.TryGetSingleton<T>(T)
    ComponentSystemBase.SetSingleton<T>(T)
    ComponentSystemBase.GetSingletonEntity<T>()
    ComponentSystemBase.TryGetSingletonEntity<T>(Entity)
    ComponentSystemBase.GetEntityQuery(ComponentType[])
    ComponentSystemBase.GetEntityQuery(NativeArray<ComponentType>)
    ComponentSystemBase.GetEntityQuery(EntityQueryDesc[])
    ComponentSystemBase.GetEntityQuery(EntityQueryDescBuilder)
    ComponentSystemBase.Enabled
    ComponentSystemBase.EntityQueries
    ComponentSystemBase.GlobalSystemVersion
    ComponentSystemBase.LastSystemVersion
    ComponentSystemBase.EntityManager
    ComponentSystemBase.World
    ComponentSystemBase.SystemHandleUntyped
    ComponentSystemBase.Time
    Namespace: Unity.Physics.Systems
    Syntax
    [UpdateInGroup(typeof(FixedStepSimulationSystemGroup))]
    [UpdateBefore(typeof(StepPhysicsWorld))]
    [AlwaysUpdateSystem]
    public class BuildPhysicsWorld : SystemBase

    Fields

    PhysicsData

    Declaration
    public PhysicsWorldData PhysicsData
    Field Value
    Type Description
    PhysicsWorldData

    WorldFilter

    Declaration
    public PhysicsWorldIndex WorldFilter
    Field Value
    Type Description
    PhysicsWorldIndex

    Properties

    CollisionWorldProxyGroup

    Declaration
    public EntityQuery CollisionWorldProxyGroup { get; }
    Property Value
    Type Description
    EntityQuery

    DynamicEntityGroup

    Declaration
    public EntityQuery DynamicEntityGroup { get; }
    Property Value
    Type Description
    EntityQuery

    JointEntityGroup

    Declaration
    public EntityQuery JointEntityGroup { get; }
    Property Value
    Type Description
    EntityQuery

    PhysicsWorld

    Declaration
    public ref PhysicsWorld PhysicsWorld { get; }
    Property Value
    Type Description
    PhysicsWorld

    StaticEntityGroup

    Declaration
    public EntityQuery StaticEntityGroup { get; }
    Property Value
    Type Description
    EntityQuery

    Methods

    AddInputDependency(JobHandle)

    Declaration
    [Obsolete("AddInputDependency() has been deprecated. Please call RegisterPhysicsRuntimeSystemReadWrite() or RegisterPhysicsRuntimeSystemReadOnly() in your system's OnStartRunning() to achieve the same effect. (RemovedAfter 2021-05-01)", true)]
    public void AddInputDependency(JobHandle inputDep)
    Parameters
    Type Name Description
    JobHandle inputDep

    AddInputDependencyToComplete(JobHandle)

    Adds the dependency that BuildPhysicsWorld will complete on the next OnUpdate() call. Multiple dependencies can be added this way (they are combined). BuildPhysicsWorld resets the PhysicsWorld immediately in the OnUpdate() method (not through jobs), so any jobs that rely on that data should use this to make sure their data is not ruined before they access it.

    Declaration
    public void AddInputDependencyToComplete(JobHandle dependencyToComplete)
    Parameters
    Type Name Description
    JobHandle dependencyToComplete

    GetOutputDependency()

    Declaration
    [Obsolete("GetOutputDependency() has been deprecated. Please call RegisterPhysicsRuntimeSystemReadWrite() or RegisterPhysicsRuntimeSystemReadOnly() in your system's OnStartRunning() to achieve the same effect. (RemovedAfter 2021-05-01)", true)]
    public JobHandle GetOutputDependency()
    Returns
    Type Description
    JobHandle

    OnCreate()

    Declaration
    protected override void OnCreate()
    Overrides
    ComponentSystemBase.OnCreate()

    OnDestroy()

    Declaration
    protected override void OnDestroy()
    Overrides
    ComponentSystemBase.OnDestroy()

    OnStartRunning()

    Declaration
    protected override void OnStartRunning()
    Overrides
    ComponentSystemBase.OnStartRunning()

    OnUpdate()

    Declaration
    protected override void OnUpdate()
    Overrides
    SystemBase.OnUpdate()

    Extension Methods

    PhysicsRuntimeExtensions.RegisterPhysicsRuntimeSystemReadOnly(SystemBase)
    PhysicsRuntimeExtensions.RegisterPhysicsRuntimeSystemReadWrite(SystemBase)
    PhysicsRuntimeExtensions.RegisterPhysicsRuntimeSystemReadOnly<T>(SystemBase)
    PhysicsRuntimeExtensions.RegisterPhysicsRuntimeSystemReadWrite<T>(SystemBase)
    Back to top
    Terms of use
    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