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

    Class SerializeUtility

    Inheritance
    Object
    SerializeUtility
    Namespace: Unity.Entities.Serialization
    Syntax
    public static class SerializeUtility

    Fields

    CurrentFileFormatVersion

    Declaration
    public static int CurrentFileFormatVersion
    Field Value
    Type Description
    Int32

    Methods

    DeserializeWorld(ExclusiveEntityTransaction, BinaryReader, Object[])

    Declaration
    public static void DeserializeWorld(ExclusiveEntityTransaction manager, BinaryReader reader, object[] unityObjects = null)
    Parameters
    Type Name Description
    ExclusiveEntityTransaction manager
    BinaryReader reader
    Object[] unityObjects

    GetSceneSectionEntity(Int32, EntityManager, ref EntityQuery, Boolean)

    Gets the entity representing the scene section with the index passed in. If createIfMissing is true the section entity is created if it doesn't already exist. Metadata components added to this section entity will be serialized into the entity scene header. At runtime these components will be added to the scene section entities when the scene is resolved. Only struct IComponentData components without BlobAssetReferences or Entity members are supported.

    Declaration
    public static Entity GetSceneSectionEntity(int sectionIndex, EntityManager manager, ref EntityQuery cachedSceneSectionEntityQuery, bool createIfMissing = true)
    Parameters
    Type Name Description
    Int32 sectionIndex

    The section index for which to get the scene section entity

    EntityManager manager

    The entity manager to which the entity belongs

    EntityQuery cachedSceneSectionEntityQuery

    The EntityQuery used to find the entity. Initially an null query should be passed in, the same query can the be passed in for subsequent calls to avoid recreating the query

    Boolean createIfMissing

    If true the section entity is created if it doesn't already exist. If false Entity.Null is returned for missing section entities

    Returns
    Type Description
    Entity

    The entity representing the scene section

    SerializeWorld(EntityManager, BinaryWriter)

    Declaration
    public static void SerializeWorld(EntityManager entityManager, BinaryWriter writer)
    Parameters
    Type Name Description
    EntityManager entityManager
    BinaryWriter writer

    SerializeWorld(EntityManager, BinaryWriter, NativeArray<EntityRemapUtility.EntityRemapInfo>)

    Declaration
    public static void SerializeWorld(EntityManager entityManager, BinaryWriter writer, NativeArray<EntityRemapUtility.EntityRemapInfo> entityRemapInfos)
    Parameters
    Type Name Description
    EntityManager entityManager
    BinaryWriter writer
    NativeArray<EntityRemapUtility.EntityRemapInfo> entityRemapInfos

    SerializeWorld(EntityManager, BinaryWriter, out Object[])

    Declaration
    public static void SerializeWorld(EntityManager entityManager, BinaryWriter writer, out object[] referencedObjects)
    Parameters
    Type Name Description
    EntityManager entityManager
    BinaryWriter writer
    Object[] referencedObjects

    SerializeWorld(EntityManager, BinaryWriter, out Object[], NativeArray<EntityRemapUtility.EntityRemapInfo>)

    Declaration
    public static void SerializeWorld(EntityManager entityManager, BinaryWriter writer, out object[] referencedObjects, NativeArray<EntityRemapUtility.EntityRemapInfo> entityRemapInfos)
    Parameters
    Type Name Description
    EntityManager entityManager
    BinaryWriter writer
    Object[] referencedObjects
    NativeArray<EntityRemapUtility.EntityRemapInfo> entityRemapInfos
    In This Article
    • Fields
      • CurrentFileFormatVersion
    • Methods
      • DeserializeWorld(ExclusiveEntityTransaction, BinaryReader, Object[])
      • GetSceneSectionEntity(Int32, EntityManager, ref EntityQuery, Boolean)
      • SerializeWorld(EntityManager, BinaryWriter)
      • SerializeWorld(EntityManager, BinaryWriter, NativeArray<EntityRemapUtility.EntityRemapInfo>)
      • SerializeWorld(EntityManager, BinaryWriter, out Object[])
      • SerializeWorld(EntityManager, BinaryWriter, out Object[], NativeArray<EntityRemapUtility.EntityRemapInfo>)
    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