All Classes and Interfaces
Class
Description
Deprecated, for removal: This API element is subject to removal in a future version.
Parent class for events propagated by the Client API to IClientPlugin implementations.
Events consumers subscribe in the
IClientPlugin.initialize(IClientAPI) method on your plugin.Common events, fired both on Client and Server
Events consumers subscribe in the
IClientPlugin.initialize(IClientAPI) or @link IServerPlugin#initialize(IServerAPI) method on your plugin.Deprecated, for removal: This API element is subject to removal in a future version.
Use
Config instead.Enums that describe the various display contexts in JourneyMap.
Map types.
Map UIs.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
CustomIntegerOption instead.Deprecated, for removal: This API element is subject to removal in a future version.
Use
CustomOption instead.Custom Option generates a text box in the options menu.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
CustomTextOption instead.Indicates a Death Waypoint is about to be created.
Fired before a death waypoint is created, both client-side (singleplayer or
non-JM-managed servers) and server-side (JourneyMap-managed servers).
Base class for Overlays and Waypoints.
Enum of display types which are usable in the JourneyMap Client API
and the class reference to each one's implementation.
Indicates a change in the display characteristics of the specified UI.
This event is fired when JourneyMap updates an entity before it is displayed on the map.
Register entity classes that are not a typical
LivingEntity or Entity that is used by vanilla that needs to be displayed on the map.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
EnumOption instead.Deprecated, for removal: This API element is subject to removal in a future version.
Use
FloatOption instead.This event is used for adding buttons to existing tool-bars or creating your own toolbars on the fullscreen map.
This event is used for adding buttons to the right panel on the fullscreen map.
Deprecated.
this event should be a rare usage event, most mods should use
FullscreenDisplayEvent.AddonButtonDisplayEvent.Deprecated.
since this is a special event that requires special modification uses, it is suggested to not use it.
Event classes for the Fullscreen map.
ClickedEvent, handles mouseclicks pre and post, pre is cancelable post is not.
MouseDraggedEvent, handles mouse dragging pre and post, pre is cancelable post is not.
MouseDraggedEvent, handles mouse dragging pre and post, pre is cancelable post is not.
This event fired after map tiles and all entities, polygons, waypoints and before the buttons.
Fired on the server for global waypoint CRUD operations.
Fired on the server for global waypoint group CRUD operations.
Definition for the JourneyMap Client API.
Interface used by JourneyMap to initialize client plugins and provide the Client API.
An image overlay places an image on the map between the given coordinates.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
IntegerOption instead.Interface for receiving user events related to an Overlay.
Server-side JourneyMap API for reading and manipulating waypoints.
Interface used by JourneyMap to initialize server plugins and provide the Server API.
The button action.
Deprecated, for removal: This API element is subject to removal in a future version.
this will be removed, please use
JourneyMapPlugin
This will be removed when the API is out of snapshot phase.Used by JourneyMap to discover and classload plugin classes.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
KeyedEnum instead.Interface indicating an enum has a key.
Defines attributes needed to display an image on the map.
This event fires when mapping starts or stops.
The mapping stages
A MapPolygon is a sequence of at least 3 BlockPos.
This is a simple convenience wrapper for an outer
MapPolygon and
a list of holes.A Marker overlay shows a geographical point on the map with an icon and a label.
The action when the menu button is clicked.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
Option instead.Deprecated, for removal: This API element is subject to removal in a future version.
Use
OptionCategory instead.Deprecated, for removal: This API element is subject to removal in a future version.
Use
OptionsRegistry instead.This class is not intended for use by modders, Options register themselves.
Provides IDs and key information for map overlays in JourneyMap.
Fired on the server for player radar visibility decisions.
Utility class related to Polygons.
A polygon overlay displays a geometric area on a map.
This event is used for adding items to the right click menu on the fullscreen map.
This event is fired when a user right clicks anywhere on the fullscreen map that is not an overlay or waypoint.
This event is fired when a user right-clicks on a waypoint icon.
Event classes for journeymap registries.
Used for creating your own info slots.
Fired when it is time to register custom options to display in journeymap options screen.
The registry types.
Fired on the server when it is time for server plugins to register their
configuration options.
Properties defining the display of a shape.
Fired on the server when a teleport is about to be applied by JourneyMap.
Properties defining the display of text.
Provides the current state of a Map UI in JourneyMap.
Deprecated, for removal: This API element is subject to removal in a future version.
this event will be deleted, use same event in
WaypointEvent
Switch your registration to use CommonEventRegistry.WAYPOINT_EVENTThis event handles all the CRUD operations of a waypoints.
Fired when a recipient accepts or declines a pending waypoint.
Fired once per recipient before a pending waypoint entry is stored.
Fired on the server when a player (or addon via IServerAPI) submits a waypoint share.
This interface is used for setting values of an entity, this controls how an entity is displayed.
BooleanOptioninstead.