Class EntitiesJournaling

Entities journaling provides detailed information about past ECS events.

Inheritance
Object
EntitiesJournaling
Namespace: Unity.Entities
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(EntitiesJournaling.Ordering)

Retrieve records currently in buffer.
TryGetRecordDataAsComponentDataArrayBoxed(EntitiesJournaling.RecordView, out Array)

Try to retrieve record data as component data array boxed.
TryGetRecordDataAsSystemView(EntitiesJournaling.RecordView, out EntitiesJournaling.SystemView)

Try to retrieve record data as a EntitiesJournaling.SystemView.
TryGetRecords(EntitiesJournaling.Ordering)

Try to retrieve records currently in buffer.
WithComponentType(IEnumerable<EntitiesJournaling.RecordView>, String)

Get all records matching a component type name.
WithComponentType(IEnumerable<EntitiesJournaling.RecordView>, ComponentType)

Get all records matching a component type.
WithComponentType(IEnumerable<EntitiesJournaling.RecordView>, TypeIndex)

Get all records matching a component type index.
WithEntity(IEnumerable<EntitiesJournaling.RecordView>, Int32)

Get all records matching an entity index.
WithEntity(IEnumerable<EntitiesJournaling.RecordView>, Int32, Int32)

Get all records matching an entity index and version.
WithEntity(IEnumerable<EntitiesJournaling.RecordView>, String)

Get all records matching an existing entity name.
WithEntity(IEnumerable<EntitiesJournaling.RecordView>, Entity)

Get all records matching an entity.
WithExecutingSystem(IEnumerable<EntitiesJournaling.RecordView>, String)

Get all records matching an executing system type name.
WithExecutingSystem(IEnumerable<EntitiesJournaling.RecordView>, SystemHandle)

Get all records matching an executing system handle untyped.
WithFrameIndex(IEnumerable<EntitiesJournaling.RecordView>, Int32)

Get all records matching a frame index.
WithOriginSystem(IEnumerable<EntitiesJournaling.RecordView>, String)

Get all records matching an origin system type name.
WithOriginSystem(IEnumerable<EntitiesJournaling.RecordView>, SystemHandle)

Get all records matching an origin system handle untyped.
WithRecordIndex(IEnumerable<EntitiesJournaling.RecordView>, UInt64)

Get the records matching a record index.
WithRecordType(IEnumerable<EntitiesJournaling.RecordView>, EntitiesJournaling.RecordType)

Get all records matching a record type.
WithSystem(IEnumerable<EntitiesJournaling.RecordView>, String)

Get all records matching a system type name.
WithSystem(IEnumerable<EntitiesJournaling.RecordView>, SystemHandle)

Get all records matching a system handle untyped.
WithWorld(IEnumerable<EntitiesJournaling.RecordView>, String)

Get all records matching a world name.
WithWorld(IEnumerable<EntitiesJournaling.RecordView>, UInt64)

Get all records matching a world sequence number.
WithWorld(IEnumerable<EntitiesJournaling.RecordView>, World)

Get all records matching an existing world.

Events

Name Description
s_JournalingOperationExecuted