Class ClearUsedTeleporterSystem

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.adventure.teleporter.system.ClearUsedTeleporterSystem

All Implemented Interfaces:

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

public class ClearUsedTeleporterSystem
extends EntityTickingSystem<EntityStore>

An entity ticking system that clears the UsedTeleporter component from entities when they have moved sufficiently far from their teleported destination.

Nested Class Summary

Nested classes/interfaces inherited from class EntityTickingSystem

EntityTickingSystem.SystemTaskData<ECS_TYPE>

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	TELEPORTER_GLOBAL_COOLDOWN

Fields inherited from interface ISystem

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor	Description
ClearUsedTeleporterSystem(ComponentType<EntityStore, UsedTeleporter> usedTeleporterComponentType, ComponentType<EntityStore, TransformComponent> transformComponentType, ComponentType<EntityStore, TeleportRecord> teleportRecordComponentType, ComponentType<EntityStore, Teleport> teleportComponentType, ComponentType<EntityStore, PendingTeleport> pendingTeleportComponentType)

Method Summary

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

Methods inherited from class EntityTickingSystem

doTick, isParallel, 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

getGroup, onSystemRegistered, onSystemUnregistered

Methods inherited from interface QuerySystem

getHierarchyScope

Field Details

TELEPORTER_GLOBAL_COOLDOWN

@Nonnull
public static final Duration TELEPORTER_GLOBAL_COOLDOWN

Constructor Details

ClearUsedTeleporterSystem

public ClearUsedTeleporterSystem(@Nonnull
 ComponentType<EntityStore, UsedTeleporter> usedTeleporterComponentType,
 @Nonnull
 ComponentType<EntityStore, TransformComponent> transformComponentType,
 @Nonnull
 ComponentType<EntityStore, TeleportRecord> teleportRecordComponentType,
 @Nonnull
 ComponentType<EntityStore, Teleport> teleportComponentType,
 @Nonnull
 ComponentType<EntityStore, PendingTeleport> pendingTeleportComponentType)

Method Details

getDependencies

@Nonnull
public Set<Dependency<EntityStore>> getDependencies()

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.

getQuery

@Nonnull
public Query<EntityStore> getQuery()