Class Damage.EntitySource

java.lang.Object

com.hypixel.hytale.server.core.modules.entity.damage.Damage.EntitySource

All Implemented Interfaces:

Damage.Source

Direct Known Subclasses:

Damage.EntityEffectSource, Damage.ProjectileSource

Enclosing class:

Damage

public static class Damage.EntitySource
extends Object
implements Damage.Source

A damage source that contains an affiliated entity

Constructor Summary

Constructors

Constructor	Description
EntitySource(Ref<EntityStore> sourceRef)	Default Constructor for a Damage.EntitySource instance

Method Summary

Modifier and Type	Method	Description
Message	getDeathMessage(Damage info, Ref<EntityStore> targetRef, ComponentAccessor<EntityStore> componentAccessor)	Generates a death message from this source and any information provided in info.
Ref<EntityStore>	getRef()	The reference to the entity that caused the damage event.
DamageSourceType	getSourceType()

Methods inherited from class Object

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

Constructor Details

EntitySource

public EntitySource(@Nonnull
 Ref<EntityStore> sourceRef)

Default Constructor for a Damage.EntitySource instance

Parameters:

sourceRef - The reference to the affiliated entity

Method Details

getRef

@Nonnull
public Ref<EntityStore> getRef()

The reference to the entity that caused the damage event.

Returns:

The reference.

getDeathMessage

@Nonnull
public Message getDeathMessage(@Nonnull
 Damage info,
 @Nonnull
 Ref<EntityStore> targetRef,
 @Nonnull
 ComponentAccessor<EntityStore> componentAccessor)

Description copied from interface: Damage.Source

Generates a death message from this source and any information provided in info.

Specified by:

getDeathMessage in interface Damage.Source

Parameters:

info - The damage info to inspect

targetRef - The entity reference of the entity that has been killed.

componentAccessor - The ComponentAccessor<EntityStore> for component access.

Returns:

The generated death message

getSourceType

@Nonnull
public DamageSourceType getSourceType()

Specified by:

getSourceType in interface Damage.Source

Returns:

the DamageSourceType of this source.