Package journeymap.api.v2.common.event

Class ClientEventRegistry

java.lang.Object

journeymap.api.v2.common.event.ClientEventRegistry

public class ClientEventRegistry
extends Object

Events consumers subscribe in the IClientPlugin.initialize(IClientAPI) method on your plugin. Example: DEATH_WAYPOINT_EVENT.subscribe(MOD_ID, Consumer)

Field Summary

Fields

Modifier and Type	Field	Description
static final Event<FullscreenDisplayEvent.AddonButtonDisplayEvent>	ADDON_BUTTON_DISPLAY_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use FullscreenEventRegistry
static final Event<FullscreenDisplayEvent.CustomToolbarEvent>	CUSTOM_TOOLBAR_UPDATE_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use FullscreenEventRegistry
static final Event<DeathWaypointEvent>	DEATH_WAYPOINT_EVENT	Indicates a Death Waypoint is about to be created for the player.
static final Event<DisplayUpdateEvent>	DISPLAY_UPDATE_EVENT	Indicates a change in the display characteristics of the specified UI.
static final Event<EntityRadarUpdateEvent>	ENTITY_RADAR_UPDATE_EVENT	This event is fired when JourneyMap updates an entity before it is displayed on the map.
static final Event<EntityRegistrationEvent>	ENTITY_REGISTRATION_EVENT	This event is fired very early in mod loading so that JourneyMap has a handle on possible entities to display on the map This event is not cancellable.
static final Event<FullscreenMapEvent.ClickEvent>	FULLSCREEN_MAP_CLICK_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use FullscreenEventRegistry
static final Event<FullscreenMapEvent.MouseDraggedEvent>	FULLSCREEN_MAP_DRAG_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use FullscreenEventRegistry
static final Event<FullscreenMapEvent.MouseMoveEvent>	FULLSCREEN_MAP_MOVE_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use FullscreenEventRegistry
static final Event<PopupMenuEvent.FullscreenPopupMenuEvent>	FULLSCREEN_POPUP_MENU_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use FullscreenEventRegistry
static final Event<RegistryEvent.InfoSlotRegistryEvent>	INFO_SLOT_REGISTRY_EVENT
static final Event<RegistryEvent.InfoSlotRegistryEvent>	INFO_SLOT_REGISTRY_EVENT_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. due to rename use INFO_SLOT_REGISTRY_EVENT
static final Event<FullscreenDisplayEvent.MapTypeButtonDisplayEvent>	MAP_TYPE_BUTTON_DISPLAY_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use FullscreenEventRegistry
static final Event<MappingEvent>	MAPPING_EVENT	Indicates JourneyMap has started or stopped mapping chunks in the dimension.
static final Event<RegistryEvent.OptionsRegistryEvent>	OPTIONS_REGISTRY_EVENT
static final Event<RegistryEvent.OptionsRegistryEvent>	OPTIONS_REGISTRY_EVENT_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. due to rename use OPTIONS_REGISTRY_EVENT
static final Event<WaypointEvent>	WAYPOINT_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use CommonEventRegistry.WAYPOINT_EVENT
static final Event<PopupMenuEvent.WaypointPopupMenuEvent>	WAYPOINT_POPUP_MENU_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. use FullscreenEventRegistry

Constructor Summary

Constructors

Constructor	Description
ClientEventRegistry()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

DEATH_WAYPOINT_EVENT

public static final Event<DeathWaypointEvent> DEATH_WAYPOINT_EVENT

Indicates a Death Waypoint is about to be created for the player. Event will be a DeathWaypointEvent, which can be cancelled. Can be cancelled, which will prevent the waypoint creation.

DISPLAY_UPDATE_EVENT

public static final Event<DisplayUpdateEvent> DISPLAY_UPDATE_EVENT

Indicates a change in the display characteristics of the specified UI. Event will be a DisplayUpdateEvent, which can not be cancelled.

MAPPING_EVENT

public static final Event<MappingEvent> MAPPING_EVENT

Indicates JourneyMap has started or stopped mapping chunks in the dimension. Event will be a MappingEvent. Cannot be cancelled.

FULLSCREEN_MAP_CLICK_EVENT

@Deprecated(forRemoval=true)
public static final Event<FullscreenMapEvent.ClickEvent> FULLSCREEN_MAP_CLICK_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use FullscreenEventRegistry

Indicates that the fullscreen map is going to have a mouse click. This is a staged event. Pre can be canceled, post cannot be canceled. FullscreenMapEvent.ClickEvent, which can be cancelled.

FULLSCREEN_MAP_DRAG_EVENT

@Deprecated(forRemoval=true)
public static final Event<FullscreenMapEvent.MouseDraggedEvent> FULLSCREEN_MAP_DRAG_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use FullscreenEventRegistry

Indicates the start of the mouse dragging. This is a staged event. Pre can be canceled, post cannot be canceled. FullscreenMapEvent.MouseDraggedEvent, which can be cancelled.

FULLSCREEN_MAP_MOVE_EVENT

@Deprecated(forRemoval=true)
public static final Event<FullscreenMapEvent.MouseMoveEvent> FULLSCREEN_MAP_MOVE_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use FullscreenEventRegistry

Indicates moving of the mouse, gets block info where the cursor is pointing. FullscreenMapEvent.MouseMoveEvent, which can not be cancelled.

INFO_SLOT_REGISTRY_EVENT_EVENT

@Deprecated(forRemoval=true)
public static final Event<RegistryEvent.InfoSlotRegistryEvent> INFO_SLOT_REGISTRY_EVENT_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

due to rename use INFO_SLOT_REGISTRY_EVENT

Register info slots. RegistryEvent

INFO_SLOT_REGISTRY_EVENT

public static final Event<RegistryEvent.InfoSlotRegistryEvent> INFO_SLOT_REGISTRY_EVENT

OPTIONS_REGISTRY_EVENT_EVENT

@Deprecated(forRemoval=true)
public static final Event<RegistryEvent.OptionsRegistryEvent> OPTIONS_REGISTRY_EVENT_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

due to rename use OPTIONS_REGISTRY_EVENT

Register options in the addon options screen. RegistryEvent

OPTIONS_REGISTRY_EVENT

public static final Event<RegistryEvent.OptionsRegistryEvent> OPTIONS_REGISTRY_EVENT

WAYPOINT_EVENT

@Deprecated(forRemoval=true)
public static final Event<WaypointEvent> WAYPOINT_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use CommonEventRegistry.WAYPOINT_EVENT

This event handles all the CRUD operations of a waypoints. This event is not cancellable.

FULLSCREEN_POPUP_MENU_EVENT

@Deprecated(forRemoval=true)
public static final Event<PopupMenuEvent.FullscreenPopupMenuEvent> FULLSCREEN_POPUP_MENU_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use FullscreenEventRegistry

This event is fired when a user right clicks anywhere on the fullscreen map that is not an overlay or waypoint. To target overlays, see IOverlayListener.onOverlayMenuPopup(UIState, Point2D.Double, BlockPos, ModPopupMenu) This event is cancellable

WAYPOINT_POPUP_MENU_EVENT

@Deprecated(forRemoval=true)
public static final Event<PopupMenuEvent.WaypointPopupMenuEvent> WAYPOINT_POPUP_MENU_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use FullscreenEventRegistry

This event is fired when a user right-clicks on a waypoint icon. This event is cancellable.

CUSTOM_TOOLBAR_UPDATE_EVENT

@Deprecated(forRemoval=true)
public static final Event<FullscreenDisplayEvent.CustomToolbarEvent> CUSTOM_TOOLBAR_UPDATE_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use FullscreenEventRegistry

Used to create custom toolbars on the fullscreen map.

MAP_TYPE_BUTTON_DISPLAY_EVENT

@Deprecated(forRemoval=true)
public static final Event<FullscreenDisplayEvent.MapTypeButtonDisplayEvent> MAP_TYPE_BUTTON_DISPLAY_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use FullscreenEventRegistry

Used for adding buttons to the maptype theme button list. We currently do not have any hooks to add map types, but this event exists for those that want to add maptypes through your own means. This event is not cancellable

ADDON_BUTTON_DISPLAY_EVENT

@Deprecated(forRemoval=true)
public static final Event<FullscreenDisplayEvent.AddonButtonDisplayEvent> ADDON_BUTTON_DISPLAY_EVENT

Deprecated, for removal: This API element is subject to removal in a future version.

use FullscreenEventRegistry

This event is used for adding buttons to the right panel on the fullscreen map. This event is not cancellable.

ENTITY_RADAR_UPDATE_EVENT

public static final Event<EntityRadarUpdateEvent> ENTITY_RADAR_UPDATE_EVENT

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.

ENTITY_REGISTRATION_EVENT

public static final Event<EntityRegistrationEvent> ENTITY_REGISTRATION_EVENT

This event is fired very early in mod loading so that JourneyMap has a handle on possible entities to display on the map This event is not cancellable.

Constructor Details

ClientEventRegistry

public ClientEventRegistry()