ECS Architecture Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

//CREAT3D.ECS.DataModel.EventSystems.Topics.ChunkManagement//
===== EntityPacketCollectionLoadingProgressTopic =====

^Type | [[Topic]] |
^Payload | [[ValueMessage]]<float> |
^Broadcaster | [[IEntityPacketCollectionLoadingService]] |

This topic is broadcast from [[IEntityPacketCollectionLoadingService]] when a [[Chunk]] loads from a previously serialized state, as serialized Entities of that [[Chunk]] load and instantiate. The value of the payload is the normalized loading progress of the operation with values ranging from 0.0 to 1.0. This broadcast is meant to be captured so that the UI layer can be notified and produce a loading report. The frequency and number of these broadcasts is determined by the LoadingFrequency value found in [[IChunkSystemStaticData]]. Even at very high LoadingFrequency, the topic is broadcast at least 2 times, once with progress value of 0f at the beginning of the load, and once with progress value of 1f at the end of the load. More broadcasts are injected in between as LoadingFrequency value decreases. At loading Frequency value of 1, there is one broadcast happening for every loaded [[Entity]].