WorldUnmanaged
A pointer-to-implementation for the unmanaged representation of a World.
Read time 2 minutesLast updated a day ago
Definition
- Type: Struct
- Namespace: Unity.Entities
- Assembly: UnityEngine.EntitiesModule
- Implements: IEquatable<WorldUnmanaged>, IComparable<WorldUnmanaged>
public struct WorldUnmanaged : IEquatable<WorldUnmanaged>, IComparable<WorldUnmanaged>
Remarks
This is intended to stay small (8 bytes without collections checks, 32 bytes with padding with collections checks), because it is intended to be cheaply passed around by value.
Properties
Property | Description |
|---|---|
| EntityManager | An interface to manipulate the World's entity data from the main thread |
| Flags | The WorldFlags settings for this World |
| IsCreated | Has this World been successfully initialized? |
| MaximumDeltaTime | The maximum single-frame delta time permitted in this world. |
| Name | The name of the World |
| SequenceNumber | The World's current sequence number |
| Time | The world's simulated time, include elapsed time since World creation and the delta time since the previous update. |
| UpdateAllocator | Rewindable allocator instance for this World. |
| Version | The World's current version number |
Methods
Method | Description |
|---|---|
| CompareTo | Compares this world with another by sequence number, then by version. |
| GetAllSystems | Retrieve an array of all systems in this world, both unmanaged and managed |
| GetAllUnmanagedSystems | Retrieve an array of all unmanaged systems in this world |
| GetExistingSystemState | Return the system state for an existing instance of a system of type |
| GetExistingUnmanagedSystem | Return an existing instance of a system of type |
| GetSystemTypeIndex | Gets the SystemTypeIndex for the specified SystemHandle. |
| GetUnsafeSystemRef | Resolves the system handle to a reference to its underlying system instantiation. |
| IsSystemValid | Checks whether a system identified by its system handle exists and is in a valid state |
| ResetUpdateAllocator | Manually update the double update allocators. This switches to the other allocator and rewinds the newly switched allocator. |
| ResolveSystemStateRef | Resolves the system handle to a reference to its underlying system state. |
Operators
Operator | Description |
|---|---|
| operator == | Whether two references point to the same world. |
| operator != | Whether two references point to different worlds. |