journeymap.api.v2.client.event

Class EntityRadarUpdateEvent

java.lang.Object

journeymap.api.v2.common.event.impl.JourneyMapEvent

journeymap.api.v2.client.event.ClientEvent

journeymap.api.v2.client.event.EntityRadarUpdateEvent

public class EntityRadarUpdateEvent
extends ClientEvent

This event is fired when JourneyMap updates an entity before it is displayed on the map. This event is cancellable, when cancelled, it will prevent the entity from being displayed on the map.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityRadarUpdateEvent.EntityType

Field Summary

Fields inherited from class journeymap.api.v2.client.event.ClientEvent

dimension

Fields inherited from class journeymap.api.v2.common.event.impl.JourneyMapEvent

timestamp

Constructor Summary

Constructors

Constructor and Description
EntityRadarUpdateEvent(UIState activeUiState, EntityRadarUpdateEvent.EntityType entityType, WrappedEntity wrappedEntity)

Method Summary

Modifier and Type	Method and Description
UIState	getActiveUiState() Gets the current active UIState, small chance it may be null.
EntityRadarUpdateEvent.EntityType	getType() Gets the entity type.
WrappedEntity	getWrappedEntity() Gets the wrapped entity, modifying the Entity itself will not change anything.

Methods inherited from class journeymap.api.v2.common.event.impl.JourneyMapEvent

cancel, isCancellable, isCancelled

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityRadarUpdateEvent

public EntityRadarUpdateEvent(UIState activeUiState,
                              EntityRadarUpdateEvent.EntityType entityType,
                              WrappedEntity wrappedEntity)

Method Detail

getActiveUiState

@Nullable
public UIState getActiveUiState()

Gets the current active UIState, small chance it may be null.

Returns:

- The UIState

getType

public EntityRadarUpdateEvent.EntityType getType()

Gets the entity type.

Returns:

- The entity type.

getWrappedEntity

public WrappedEntity getWrappedEntity()

Gets the wrapped entity, modifying the Entity itself will not change anything.

Returns:

- The wrapped entity.