Package journeymap.api.v2.common.event

Class CommonEventRegistry

java.lang.Object

journeymap.api.v2.common.event.CommonEventRegistry

public class CommonEventRegistry
extends Object

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. Example: WAYPOINT_EVENT.subscribe(MOD_ID, Consumer)

Field Summary

Fields

Modifier and Type	Field	Description
static final Event<DeathWaypointEvent>	DEATH_WAYPOINT_EVENT	Fired before a death waypoint is created.
static final Event<TeleportEvent>	TELEPORT_EVENT	Deprecated, for removal: This API element is subject to removal in a future version. Will move to ServerEventRegistry.TELEPORT_EVENT in JourneyMap 26.2.
static final Event<WaypointEvent>	WAYPOINT_EVENT	This event handles all the CRUD operations of a waypoints on client and server.
static final Event<WaypointGroupEvent>	WAYPOINT_GROUP_EVENT	This event handles all the CRUD operations of a waypoint groups on client and server.
static final Event<WaypointGroupTransferEvent>	WAYPOINT_GROUP_TRANSFER_EVENT	This event fires when a waypoint is transferred from one group to another, from may be null.

Constructor Summary

Constructors

Constructor	Description
CommonEventRegistry()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

WAYPOINT_EVENT

public static final Event<WaypointEvent> WAYPOINT_EVENT

This event handles all the CRUD operations of a waypoints on client and server.

WAYPOINT_GROUP_EVENT

public static final Event<WaypointGroupEvent> WAYPOINT_GROUP_EVENT

This event handles all the CRUD operations of a waypoint groups on client and server.

WAYPOINT_GROUP_TRANSFER_EVENT

public static final Event<WaypointGroupTransferEvent> WAYPOINT_GROUP_TRANSFER_EVENT

This event fires when a waypoint is transferred from one group to another, from may be null.

DEATH_WAYPOINT_EVENT

public static final Event<DeathWaypointEvent> DEATH_WAYPOINT_EVENT

Fired before a death waypoint is created. Cancellable. Fires both client-side (singleplayer or non-JM-managed servers) and server-side (JourneyMap-managed servers). The plain WaypointEvent CREATE is suppressed for death waypoints so subscribers receive exactly one notification per death.

TELEPORT_EVENT

@Deprecated(forRemoval=true)
public static final Event<TeleportEvent> TELEPORT_EVENT

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

Will move to ServerEventRegistry.TELEPORT_EVENT in JourneyMap 26.2. The event is only fired on the server; the registry location is misnamed today. Subscriptions registered here will continue to work for the current major version.

Constructor Details

CommonEventRegistry

public CommonEventRegistry()