Class World | Entities | 0.10.0-preview.6
docs.unity3d.com
    Show / Hide Table of Contents

    Class World

    Inheritance
    Object
    World
    Namespace: Unity.Entities
    Syntax
    public class World : IDisposable

    Constructors

    World(String)

    Declaration
    public World(string name)
    Parameters
    Type Name Description
    String name

    Fields

    Flags

    Declaration
    public readonly WorldFlags Flags
    Field Value
    Type Description
    WorldFlags

    m_CurrentTime

    Declaration
    protected TimeData m_CurrentTime
    Field Value
    Type Description
    TimeData

    m_TimeSingletonQuery

    Declaration
    protected EntityQuery m_TimeSingletonQuery
    Field Value
    Type Description
    EntityQuery

    Properties

    All

    Declaration
    public static World.NoAllocReadOnlyCollection<World> All { get; }
    Property Value
    Type Description
    World.NoAllocReadOnlyCollection<World>

    DefaultGameObjectInjectionWorld

    Declaration
    public static World DefaultGameObjectInjectionWorld { get; set; }
    Property Value
    Type Description
    World

    EntityManager

    Declaration
    public EntityManager EntityManager { get; }
    Property Value
    Type Description
    EntityManager

    IsCreated

    Declaration
    public bool IsCreated { get; }
    Property Value
    Type Description
    Boolean

    Name

    Declaration
    public string Name { get; }
    Property Value
    Type Description
    String

    QuitUpdate

    Declaration
    public bool QuitUpdate { get; set; }
    Property Value
    Type Description
    Boolean

    SequenceNumber

    Declaration
    public ulong SequenceNumber { get; }
    Property Value
    Type Description
    UInt64

    Systems

    Declaration
    public World.NoAllocReadOnlyCollection<ComponentSystemBase> Systems { get; }
    Property Value
    Type Description
    World.NoAllocReadOnlyCollection<ComponentSystemBase>

    Time

    Declaration
    public TimeData Time { get; }
    Property Value
    Type Description
    TimeData

    TimeSingleton

    Declaration
    protected Entity TimeSingleton { get; }
    Property Value
    Type Description
    Entity

    Version

    Declaration
    public int Version { get; }
    Property Value
    Type Description
    Int32

    Methods

    AddSystem<T>(T)

    Declaration
    public T AddSystem<T>(T system)
        where T : ComponentSystemBase
    Parameters
    Type Name Description
    T system
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    CreateSystem(Type)

    Declaration
    public ComponentSystemBase CreateSystem(Type type)
    Parameters
    Type Name Description
    Type type
    Returns
    Type Description
    ComponentSystemBase

    CreateSystem<T>()

    Declaration
    public T CreateSystem<T>()
        where T : ComponentSystemBase, new()
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    DestroyAllSystemsAndLogException()

    Declaration
    public void DestroyAllSystemsAndLogException()

    DestroySystem(ComponentSystemBase)

    Declaration
    public void DestroySystem(ComponentSystemBase system)
    Parameters
    Type Name Description
    ComponentSystemBase system

    Dispose()

    Declaration
    public void Dispose()

    DisposeAllWorlds()

    Declaration
    public static void DisposeAllWorlds()

    GetExistingSystem(Type)

    Declaration
    public ComponentSystemBase GetExistingSystem(Type type)
    Parameters
    Type Name Description
    Type type
    Returns
    Type Description
    ComponentSystemBase

    GetExistingSystem<T>()

    Declaration
    public T GetExistingSystem<T>()
        where T : ComponentSystemBase
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    GetOrCreateSystem(Type)

    Declaration
    public ComponentSystemBase GetOrCreateSystem(Type type)
    Parameters
    Type Name Description
    Type type
    Returns
    Type Description
    ComponentSystemBase

    GetOrCreateSystem<T>()

    Declaration
    public T GetOrCreateSystem<T>()
        where T : ComponentSystemBase
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    GetOrCreateSystemsAndLogException(Type[])

    Declaration
    public ComponentSystemBase[] GetOrCreateSystemsAndLogException(Type[] types)
    Parameters
    Type Name Description
    Type[] types
    Returns
    Type Description
    ComponentSystemBase[]

    PopTime()

    Declaration
    public void PopTime()

    PushTime(TimeData)

    Declaration
    public void PushTime(TimeData newTimeData)
    Parameters
    Type Name Description
    TimeData newTimeData

    SetTime(TimeData)

    Declaration
    public void SetTime(TimeData newTimeData)
    Parameters
    Type Name Description
    TimeData newTimeData

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    Object.ToString()

    Update()

    Declaration
    public void Update()
    In This Article
    • Constructors
      • World(String)
    • Fields
      • Flags
      • m_CurrentTime
      • m_TimeSingletonQuery
    • Properties
      • All
      • DefaultGameObjectInjectionWorld
      • EntityManager
      • IsCreated
      • Name
      • QuitUpdate
      • SequenceNumber
      • Systems
      • Time
      • TimeSingleton
      • Version
    • Methods
      • AddSystem<T>(T)
      • CreateSystem(Type)
      • CreateSystem<T>()
      • DestroyAllSystemsAndLogException()
      • DestroySystem(ComponentSystemBase)
      • Dispose()
      • DisposeAllWorlds()
      • GetExistingSystem(Type)
      • GetExistingSystem<T>()
      • GetOrCreateSystem(Type)
      • GetOrCreateSystem<T>()
      • GetOrCreateSystemsAndLogException(Type[])
      • PopTime()
      • PushTime(TimeData)
      • SetTime(TimeData)
      • ToString()
      • Update()
    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