docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class EntitiesJournaling

    Entities journaling provides detailed information about past ECS events.

    Inheritance
    object
    EntitiesJournaling
    Namespace: Unity.Entities
    Assembly: Unity.Entities.dll
    Syntax
    [BurstCompile]
    public static class EntitiesJournaling

    Properties

    Name Description
    AllocatedBytes

    Current allocated bytes.

    Enabled

    Whether or not entities journaling events are recorded.

    RecordCount

    The number of records in the buffer.

    RecordIndex

    The last record index that was added to the buffer.

    UsedBytes

    Current used bytes.

    Methods

    Name Description
    Clear()

    Clear all the records.

    ExportToCSV()

    Export journaling data as CSV.

    GetRecords(Ordering)

    Retrieve records currently in buffer.

    TryGetRecordDataAsComponentDataArrayBoxed(RecordView, out Array)

    Try to retrieve record data as component data array boxed.

    TryGetRecordDataAsSystemView(RecordView, out SystemView)

    Try to retrieve record data as a EntitiesJournaling.SystemView.

    TryGetRecords(Ordering)

    Try to retrieve records currently in buffer.

    WithComponentType(IEnumerable<RecordView>, string)

    Get all records matching a component type name.

    WithComponentType(IEnumerable<RecordView>, ComponentType)

    Get all records matching a component type.

    WithComponentType(IEnumerable<RecordView>, TypeIndex)

    Get all records matching a component type index.

    WithEntity(IEnumerable<RecordView>, int)

    Get all records matching an entity index.

    WithEntity(IEnumerable<RecordView>, int, int)

    Get all records matching an entity index and version.

    WithEntity(IEnumerable<RecordView>, string)

    Get all records matching an existing entity name.

    WithEntity(IEnumerable<RecordView>, Entity)

    Get all records matching an entity.

    WithExecutingSystem(IEnumerable<RecordView>, string)

    Get all records matching an executing system type name.

    WithExecutingSystem(IEnumerable<RecordView>, SystemHandle)

    Get all records matching an executing system handle untyped.

    WithFrameIndex(IEnumerable<RecordView>, int)

    Get all records matching a frame index.

    WithOriginSystem(IEnumerable<RecordView>, string)

    Get all records matching an origin system type name.

    WithOriginSystem(IEnumerable<RecordView>, SystemHandle)

    Get all records matching an origin system handle untyped.

    WithRecordIndex(IEnumerable<RecordView>, ulong)

    Get the records matching a record index.

    WithRecordType(IEnumerable<RecordView>, RecordType)

    Get all records matching a record type.

    WithSystem(IEnumerable<RecordView>, string)

    Get all records matching a system type name.

    WithSystem(IEnumerable<RecordView>, SystemHandle)

    Get all records matching a system handle untyped.

    WithWorld(IEnumerable<RecordView>, string)

    Get all records matching a world name.

    WithWorld(IEnumerable<RecordView>, ulong)

    Get all records matching a world sequence number.

    WithWorld(IEnumerable<RecordView>, World)

    Get all records matching an existing world.

    Events

    Name Description
    s_JournalingOperationExecuted
    In This Article
    Back to top
    Copyright © 2024 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)