journeymap.api.v2.common.event

Class CommonEventRegistry

java.lang.Object

journeymap.api.v2.common.event.CommonEventRegistry

public class CommonEventRegistry
extends java.lang.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 and Description
static Event<DeathWaypointEvent>	DEATH_WAYPOINT_EVENT Fired before a death waypoint is created.
static Event<WaypointEvent>	WAYPOINT_EVENT This event handles all the CRUD operations of a waypoints on client and server.
static Event<WaypointGroupEvent>	WAYPOINT_GROUP_EVENT This event handles all the CRUD operations of a waypoint groups on client and server.
static 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 and Description
CommonEventRegistry()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

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.

Constructor Detail

CommonEventRegistry

public CommonEventRegistry()