Sector Simulation #5
Conversation
This is the system behind the simulation of sector-scope entities. It allows sector-level entities to be used for simulation, even when the chunk they are in is not loaded.
| @@ -33,7 +33,7 @@ | |||
| * | |||
| * @return the newly created EntityRef | |||
| */ | |||
| default EntityRef createSectorEntity() { | |||
| default EntityRef createSectorEntity(long maxDelta) { | |||
There was a problem hiding this comment.
Should have a @param maxDelta Javadoc description.
| /** | ||
| * The component that allows the {@link SectorSimulationSystem} to send simulation events to a sector-scope entity. | ||
| * | ||
| * This should be automatically added by either {@link EntityManager#createSectorEntity(long)} or |
There was a problem hiding this comment.
Hm, might there be a use case for setting this component in a prefab? I can't think of any good example right now ... maybe a group of deer splitting up and a new DeerGroup entity is created (in sector-scope). Just want to hear you opinion on this...
There was a problem hiding this comment.
I was thinking about that too. There should probably be a way to define this in the prefab, and to set the maxDelta there too.
I think it would be useful, as you can just create an entity from the prefab, and not worry about any scope or deltas or anything like that (which would also allow, say, a DeerGroup to simulate correctly if it is spawned with the spawnPrefab command).
| } | ||
|
|
||
| /** | ||
| * This gives the time elapsed, in seconds, since the last time this event was sent to the given {@link EntityRef}. |
There was a problem hiding this comment.
I'm wondering whether it is a smart decision to use seconds here. It obviously conveys the idea that sector simulation happens at larger intervals. However, usually the simulations would get a delta in milliseconds for their computation. This might yield confusion when you try to use the same simulation code for both scopes.
There was a problem hiding this comment.
Where are milliseconds used? I know the DelayManager uses them to set the delay, but the UpdateSubscriberSystem uses seconds for its delta, and I've used seconds for all of the sector simulation stuff (I assumed seconds was the more common one). If ms is more common it would probably be best to use that to be consistent.
| * big variations in the time between sending these events (notably, an event will be sent whenever the chunk an | ||
| * entity is in is loaded, even if one has just been sent. | ||
| * | ||
| * Using the delta will give a relaible measure of how much simulation to perform. |
|
Merged in MovingBlocks#3009 |
This PR includes the mechanisms to allow sector-scope entities to perform simulation tasks. The bulk of the work is done by the
SectorSimulationSystem, which sends events to allow sector-scope entities to work.The
SectorSimulationEventis sent repeatedly, whether or not the chunk the entity is in is loaded. It will be sent at least once everymaxDelta(defined in theSectorSimulationComponent, which holds information for calculating the simulation delta), but might be sent more often (e.g. it is always sent when the chunk is loaded). This should be used for any calculations and simulation the entity needs to do.TODO: add another property so that the simulation rate can be adjusted when the entity is loaded
The
LoadedSectorUpdateEventis sent repeatedly, but only while the chunk the entity is in is loaded. This is where any effects on the world should take place, as the chunk is guaranteed to be loaded whenever this is sent. ASectorSimulationEventis always sent immediately prior to this one, so no simulation needs to happen in reaction to this event.The OnChunkLoaded and BeforeChunkLoaded also get forwarded to the appropriate sector entities when their chunks are affected, so certain things can be done on chunk load/unload (e.g. caching some data to use when the chunk is unloaded). A
LoadedSectorUpdateEventis automatically sent immediately after theOnChunkLoadedevent, so this only needs to be used for things that don't normally get simulated (e.g. generating new villager entities).See the SectorTesting module for an example of how it is implemented.