Class LivingEntityEffectSystem

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.server.core.modules.entity.livingentity.LivingEntityEffectSystem

All Implemented Interfaces:

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

public class LivingEntityEffectSystem
extends EntityTickingSystem<EntityStore>
implements DisableProcessingAssert

An entity ticking system that handles updating active entity effects for living entities.

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
LivingEntityEffectSystem()

Method Summary

Modifier and Type	Method	Description
static boolean	canApplyEffect(Ref<EntityStore> ownerRef, EntityEffect entityEffect, ComponentAccessor<EntityStore> componentAccessor)	Determines whether the given entity effect can be applied to the entity.
SystemGroup<EntityStore>	getGroup()
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, onSystemRegistered, onSystemUnregistered

Methods inherited from interface QuerySystem

getHierarchyScope

Constructor Details

LivingEntityEffectSystem

public LivingEntityEffectSystem()

Method Details

getQuery

@Nonnull
public Query<EntityStore> getQuery()

Specified by:

getQuery in interface QuerySystem<EntityStore>

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.

getGroup

@Nullable
public SystemGroup<EntityStore> getGroup()

Specified by:

getGroup in interface ISystem<EntityStore>

Returns:

the group this system is a part of or null.

See Also:

• SystemGroup

canApplyEffect

public static boolean canApplyEffect(@Nonnull
 Ref<EntityStore> ownerRef,
 @Nonnull
 EntityEffect entityEffect,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Determines whether the given entity effect can be applied to the entity.

Parameters:

ownerRef - The entity reference of the owner.

entityEffect - The entity effect to check.

componentAccessor - The ComponentAccessor<EntityStore> for component access.

Returns:

true if the effect can be applied, false otherwise.