Class KillFeedEvent.Display

java.lang.Object

com.hypixel.hytale.component.system.EcsEvent

com.hypixel.hytale.component.system.CancellableEcsEvent

com.hypixel.hytale.server.core.modules.entity.damage.event.KillFeedEvent.Display

All Implemented Interfaces:

ICancellableEcsEvent

Enclosing class:

KillFeedEvent

public static final class KillFeedEvent.Display
extends CancellableEcsEvent

A kill feed event that can be used to cancel or modify the display of the kill feed entry.

Constructor Summary

Constructors

Constructor	Description
Display(Damage damage, String icon, List<PlayerRef> broadcastTargets)	Default Constructor for a KillFeedEvent instance.

Method Summary

Modifier and Type	Method	Description
List<PlayerRef>	getBroadcastTargets()
Damage	getDamage()
String	getIcon()
void	setIcon(String icon)	Called to set the icon representing the kill method or weapon used.

Methods inherited from class CancellableEcsEvent

isCancelled, setCancelled

Methods inherited from class Object

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

Constructor Details

Display

public Display(@Nonnull
 Damage damage,
 @Nullable
 String icon,
 @Nonnull
 List<PlayerRef> broadcastTargets)

Default Constructor for a KillFeedEvent instance.

Parameters:

damage - The damage instance associated with the kill event.

icon - The icon representing the kill method or weapon used.

broadcastTargets - A list of PlayerRef instances to whom the kill feed event should be broadcasted.

Method Details

getBroadcastTargets

@Nonnull
public List<PlayerRef> getBroadcastTargets()

Returns:

a list of PlayerRef instances to whom the kill feed event should be broadcasted.

getDamage

@Nonnull
public Damage getDamage()

Returns:

the Damage instance associated with the kill event.

getIcon

@Nullable
public String getIcon()

Returns:

the icon representing the kill method or weapon used.

setIcon

public void setIcon(@Nullable
 String icon)

Called to set the icon representing the kill method or weapon used.

Parameters:

icon - The icon representing the kill method or weapon used.