Class EntityRemovalSystem

java.lang.Object

com.hypixel.hytale.component.system.System<EntityStore>

com.hypixel.hytale.component.system.RefSystem<EntityStore>

com.hypixel.hytale.server.core.entity.EntityRemovalSystem

All Implemented Interfaces:

ISystem<EntityStore>, QuerySystem<EntityStore>

public class EntityRemovalSystem
extends RefSystem<EntityStore>

A ref system that tombstones an entity's persisted body row when the entity is permanently removed. The per-entity save paths (EntitySavingSystem, saveEntitySection, saveChunkColumn) write a UUID-keyed row per entity but, being UUID-keyed rather than coordinate-bounded, those rows can't be range-deleted alongside the chunk/section. Without this system a row would be orphaned every time its entity is removed or leaves the section it was last saved in, growing the store unbounded.

RemoveReason.REMOVE and RemoveReason.BUILDER_TOOLS_UNDO (both permanent removals) tombstone the row. RemoveReason.UNLOAD is left alone, because the entity still exists and is being persisted, not deleted. Non-cubic savers embed entities in the column holder, so per-entity removal doesn't apply to them.

Field Summary

Fields inherited from interface ISystem

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
EntityRemovalSystem()

Method Summary

Modifier and Type	Method	Description
Query<EntityStore>	getQuery()
void	onEntityAdded(Ref<EntityStore> ref, AddReason reason, Store<EntityStore> store, CommandBuffer<EntityStore> commandBuffer)	Called after an entity has been added to a Store and has an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.
void	onEntityRemove(Ref<EntityStore> ref, RemoveReason reason, Store<EntityStore> store, CommandBuffer<EntityStore> commandBuffer)	Called before an entity has been removed from a Store and has an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.

Methods inherited from class System

getComponentRegistrations, getResourceRegistrations, registerResource, registerResource

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ISystem

getDependencies, getGroup, onSystemRegistered, onSystemUnregistered

Methods inherited from interface QuerySystem

getHierarchyScope, test

Constructor Details

EntityRemovalSystem

public EntityRemovalSystem()

Method Details

getQuery

@Nonnull
public Query<EntityStore> getQuery()

onEntityAdded

public void onEntityAdded(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 AddReason reason,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 CommandBuffer<EntityStore> commandBuffer)

Description copied from class: RefSystem

Called after an entity has been added to a Store and has an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.

Specified by:

onEntityAdded in class RefSystem<EntityStore>

Parameters:

ref - The entity reference of the added entity.

reason - The reason for the entity being added.

store - The store the entity was added to.

commandBuffer - The command buffer to execute tasks. Note: The command buffer tasks are executed after all systems have processed the entity add.

onEntityRemove

public void onEntityRemove(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 RemoveReason reason,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 CommandBuffer<EntityStore> commandBuffer)

Description copied from class: RefSystem

Called before an entity has been removed from a Store and has an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.

Specified by:

onEntityRemove in class RefSystem<EntityStore>

Parameters:

ref - The entity reference of the removed entity.

reason - The reason for the entity being removed.

store - The store the entity is being removed from.

commandBuffer - The command buffer to execute tasks. Note: The command buffer tasks are executed after all systems have processed the entity remove.