Class DamageSystems

java.lang.Object

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

public class DamageSystems
extends Object

Systems for handling and processing damage to entities.

Damage is handled by systems queuing up damage events (attaching any metadata they need at the time) and then other systems processing that data either by cancelling it, modifying it or just inspecting it before finally it is applied to the entity.

In order for this to work predictably the process is split up into phases. The phases are as followed:

1. Gather Phase

   This phase is where any system that wishes to deal damage should be. Systems here should only submit damage events (using methods such as executeDamage(int, ArchetypeChunk, CommandBuffer, Damage).

   Systems within this phase should set their group to DamageModule.getGatherDamageGroup().

2. Filter Phase

   This phase is where any system that wishes to modify or cancel damage should be. Systems here should query damage events via the damage parameter and use the setters on Damage to change the result.

   At this point systems must not submit any new damage events otherwise they could be skipped by other filter systems that have already run.

   Whilst systems here may inspect the current state of the entries to use for any calculations they need they must not consider these results final as they may be modified/cancelled later.

   Systems within this phase should set their group to DamageModule.getFilterDamageGroup().

3. Application phase

   This phase is internal and should not be added to. This phase takes all the remaining damage events and applies them to the entity.

   If you need to inspect the entity after the damage then you can depend on the system DamageSystems.ApplyDamage.

4. Inspect Phase

   This phase is where any system that wishes to act on damage events (without modification) should be. Systems here should query damage events via the damage parameter and use the getters on Damage to view the result.

   The damage will not have been applied to the entity yet but is final and will not change at this point. Systems in this phase must not change anything to do with damage at this point as other systems may not see the changes made at this point.

   Systems within this phase should set their group to DamageModule.getInspectDamageGroup().

Once done the damage events will be cleared ready for the next tick.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DamageSystems.ApplyDamage	An entity ticking system that handles the final step of damage processing.
static class	DamageSystems.ApplyParticles	An entity ticking system that plays any effects for damage with Damage.IMPACT_PARTICLES.
static class	DamageSystems.ApplySoundEffects	An entity ticking system that plays any effects for damage with Damage.IMPACT_SOUND_EFFECT.
static class	DamageSystems.ArmorDamageReduction	Deprecated. Move to modifiers
static class	DamageSystems.ArmorKnockbackReduction	Deprecated. Move to modifiers
static class	DamageSystems.BreathingSystem	A delayed entity system that tracks the block material and fluid at each entity's breathing height.
static class	DamageSystems.CanBreathe	A system that handles applying damage to an entity if the entity has run out of oxygen.
static class	DamageSystems.DamageArmor
static class	DamageSystems.DamageAttackerTool
static class	DamageSystems.DamageStamina
static class	DamageSystems.EntityUIEvents
static class	DamageSystems.FallDamageNPCs	An entity ticking system that handles applying fall damage to NPC entities.
static class	DamageSystems.FallDamagePlayers	We have both FallDamagePlayers and FallDamageNPCs because player movement is client authoritative so we need to handle things differently and use the input queue.
static class	DamageSystems.FilterNPCWorldConfig	A DamageEventSystem that cancels damage for NPCs when the GameplayConfig dictates so
static class	DamageSystems.FilterPlayerWorldConfig	A DamageEventSystem that cancels damage for players when the GameplayConfig dictates so
static class	DamageSystems.FilterUnkillable	An entity ticking system that cancels damage events on unkillable entities.
static class	DamageSystems.HackKnockbackValues	Deprecated. This is a hack to modify knockback on NPCs/players before the physics rework unifies both
static class	DamageSystems.HitAnimation	An entity ticking system that handles displaying the hit animations to damaged entities.
static class	DamageSystems.InvulnerableBreathing	A ref change system that reprocesses an entity's breathing state when an Invulnerable component is added, set, or removed.
static class	DamageSystems.OutOfWorldDamage	A delayed entity system that handles applying out of world damage to entities that are below the world.
static class	DamageSystems.PlayerDamageFilterSystem	A damage event system that handles damage filtering for player entities.
static class	DamageSystems.PlayerHitIndicators	An entity ticking system that handles displaying hit indicators upon damage dealt to a player entity.
static class	DamageSystems.RecordLastCombat	An entity ticking system that updates DamageDataComponent with the last combat time for any entities involved in combat.
static class	DamageSystems.ReticleEvents
static class	DamageSystems.ScaleOutgoingDamageFromEntityEffects	Deprecated. Move to modifiers
static class	DamageSystems.TrackLastDamage	An entity ticking system that keeps track of the last time that damage was received.
static class	DamageSystems.WieldingDamageReduction
static class	DamageSystems.WieldingKnockbackReduction	Deprecated. Move to modifiers

Field Summary

Fields

Modifier and Type	Field	Description
static final float	DEFAULT_DAMAGE_DELAY

Constructor Summary

Constructors

Constructor	Description
DamageSystems()

Method Summary

Modifier and Type	Method	Description
static void	executeDamage(int index, ArchetypeChunk<EntityStore> chunk, CommandBuffer<EntityStore> commandBuffer, Damage damage)	Called to queue the given damage entry onto the given entity.
static void	executeDamage(Ref<EntityStore> ref, CommandBuffer<EntityStore> commandBuffer, Damage damage)	Called to queue the given damage entry onto the given entity.
static void	executeDamage(Ref<EntityStore> ref, ComponentAccessor<EntityStore> componentAccessor, Damage damage)	Called to queue the given damage entry onto the given entity.

Methods inherited from class Object

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

Field Details

DEFAULT_DAMAGE_DELAY

public static final float DEFAULT_DAMAGE_DELAY

See Also:

• Constant Field Values

Constructor Details

DamageSystems

public DamageSystems()

Method Details

executeDamage

public static void executeDamage(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor,
 @Nonnull
 Damage damage)

Called to queue the given damage entry onto the given entity.

Parameters:

ref - The entity reference of the entity to queue the damage for.

componentAccessor - The ComponentAccessor<EntityStore> for component access.

damage - The Damage entry to be queued.

executeDamage

public static void executeDamage(int index,
 @Nonnull
 ArchetypeChunk<EntityStore> chunk,
 @Nonnull
 CommandBuffer<EntityStore> commandBuffer,
 @Nonnull
 Damage damage)

Called to queue the given damage entry onto the given entity.

Parameters:

index - The index of the entity to queue the damage for.

chunk - The archetype chunk that the entity is associated with.

commandBuffer - The CommandBuffer<EntityStore> for component access.

damage - The Damage entry to be queued.

executeDamage

public static void executeDamage(@Nonnull
 Ref<EntityStore> ref,
 @Nonnull
 CommandBuffer<EntityStore> commandBuffer,
 @Nonnull
 Damage damage)

Called to queue the given damage entry onto the given entity.

Parameters:

ref - The entity reference of the entity to queue the damage for.

commandBuffer - The CommandBuffer<EntityStore> for component access.

damage - The Damage entry to be queued.