Class DamageSystems.OutOfWorldDamage

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.component.system.tick.DelayedEntitySystem<EntityStore>

com.hypixel.hytale.server.core.modules.entity.damage.DamageSystems.OutOfWorldDamage

All Implemented Interfaces:

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

Enclosing class:

DamageSystems

public static class DamageSystems.OutOfWorldDamage
extends DelayedEntitySystem<EntityStore>

A delayed entity system that handles applying out of world damage to entities that are below the world.

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
OutOfWorldDamage()	Default Constructor for a DamageSystems.OutOfWorldDamage instance.

Method Summary

Modifier and Type	Method	Description
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
void	tick(float dt, int systemIndex, Store<EntityStore> store)	Required reading: CommandBuffer

Methods inherited from class DelayedEntitySystem

getIntervalSec, getResourceType

Methods inherited from class EntityTickingSystem

doTick, tick

Methods inherited from class ArchetypeTickingSystem

isExplicitQuery, test

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

OutOfWorldDamage

public OutOfWorldDamage()

Default Constructor for a DamageSystems.OutOfWorldDamage instance.

Method Details

getGroup

@Nullable
public SystemGroup<EntityStore> getGroup()

Returns:

the group this system is a part of or null.

See Also:

• SystemGroup

getQuery

public Query<EntityStore> getQuery()

tick

public void tick(float dt,
 int systemIndex,
 @Nonnull
 Store<EntityStore> store)

Description copied from class: TickingSystem

Required reading: CommandBuffer

Called once per world tick.

Specified by:

tick in interface TickableSystem<EntityStore>

Overrides:

tick in class DelayedEntitySystem<EntityStore>

Parameters:

dt - The delta time in seconds.

systemIndex - The index of this system, used for faster lookups in Store.

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.

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)