Class CompanionBlockSpawnerSystems.MarkerHeartbeat

java.lang.Object

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

com.hypixel.hytale.component.system.tick.TickingSystem<EntityStore>

com.hypixel.hytale.component.system.tick.ArchetypeTickingSystem<EntityStore>

com.hypixel.hytale.component.system.tick.EntityTickingSystem<EntityStore>

com.hypixel.hytale.builtin.companionblockspawner.CompanionBlockSpawnerSystems.MarkerHeartbeat

All Implemented Interfaces:

ISystem<EntityStore>, QuerySystem<EntityStore>, TickableSystem<EntityStore>

Enclosing class:

CompanionBlockSpawnerSystems

public static class CompanionBlockSpawnerSystems.MarkerHeartbeat
extends EntityTickingSystem<EntityStore>

Entity-store counterpart of the spawner-side liveness check: a marker created by a companion spawner removes itself (and its companions) when its origin spawner block no longer exists or no longer references it - so a spawner broken while the marker's chunk was unloaded can't leave an orphaned marker respawning NPCs forever. Modelled on SpawnMarkerBlockStateSystems.SpawnMarkerTickHeartbeat, with one deliberate difference: while the origin chunk is unloaded the marker trusts it and waits indefinitely (no removal timeout) - removal only happens on loaded, contradicting evidence.

Nested Class Summary

Nested classes/interfaces inherited from class EntityTickingSystem

EntityTickingSystem.SystemTaskData<ECS_TYPE>

Field Summary

Fields inherited from interface ISystem

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
MarkerHeartbeat(ComponentType<EntityStore, CompanionSpawnerMarkerReference> referenceType)

Method Summary

Modifier and Type	Method	Description
Query<EntityStore>	getQuery()
boolean	isParallel(int archetypeChunkSize, int taskCount)
void	tick(float dt, int index, ArchetypeChunk<EntityStore> archetypeChunk, Store<EntityStore> store, CommandBuffer<EntityStore> commandBuffer)	Required reading: CommandBuffer

Methods inherited from class EntityTickingSystem

doTick, tick

Methods inherited from class ArchetypeTickingSystem

isExplicitQuery, test, tick

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

Constructor Details

MarkerHeartbeat

public MarkerHeartbeat(@Nonnull
 ComponentType<EntityStore, CompanionSpawnerMarkerReference> referenceType)

Method Details

getQuery

@Nullable
public Query<EntityStore> getQuery()

isParallel

public boolean isParallel(int archetypeChunkSize,
 int taskCount)

Overrides:

isParallel in class EntityTickingSystem<EntityStore>

Returns:

true if parallel ticking is enabled.

See Also:

• EntityTickingSystem.tick(float, int, ArchetypeChunk, Store, CommandBuffer)

tick

public void tick(float dt,
 int index,
 @Nonnull
 ArchetypeChunk<EntityStore> archetypeChunk,
 @Nonnull
 Store<EntityStore> store,
 @Nonnull
 CommandBuffer<EntityStore> commandBuffer)

Description copied from class: EntityTickingSystem

Required reading: CommandBuffer

Called once per world tick for each 'entity' inside of an ArchetypeChunk with an Archetype that fulfills the Query provided by QuerySystem.getQuery()}.

If EntityTickingSystem.isParallel(int, int) returns true then this is called from a worker thread in the thread pool NOT from the world thread. When working with a parallel system special care must be taken to ensure data that is accessed is done so in a thead safe manor and that all components that have data that is modified are present in the ReadWriteArchetypeQuery.getWriteArchetype(). TODO: Expand docs to talk more about how other query types tie into this.

To access component data when using this method you should use the following:

var component = archetypeChunk.getComponent(index, componentType);

Specified by:

tick in class EntityTickingSystem<EntityStore>

Parameters:

dt - The delta time in seconds.

index - The index of the entity in the ArchetypeChunk.