Package journeymap.api.v2.common.event.common

Class WaypointEvent

java.lang.Object

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

journeymap.api.v2.common.event.impl.CommonEvent

journeymap.api.v2.common.event.common.WaypointEvent

public class WaypointEvent
extends CommonEvent

This event handles all the CRUD operations of a waypoints. TODO: Currently only a client side event, will be a common event eventually.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WaypointEvent.Context

Nested classes/interfaces inherited from class journeymap.api.v2.common.event.impl.CommonEvent

CommonEvent.Side

Field Summary

Fields

Modifier and Type	Field	Description
final WaypointEvent.Context	context
final int	dimension
final Waypoint	waypoint

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

timestamp

Constructor Summary

Constructors

Constructor	Description
WaypointEvent(Waypoint waypoint, WaypointEvent.Context context, int dimension)
WaypointEvent(Waypoint waypoint, WaypointEvent.Context context, int dimension, CommonEvent.Side side)	Server-side constructor.

Method Summary

Modifier and Type	Method	Description
WaypointEvent.Context	getContext()	The event context.
int	getDimension()	World dimension where event occurred.
Waypoint	getWaypoint()	Gets the waypoint that the event is handling.

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

getSide

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

Field Details

waypoint

public final Waypoint waypoint

context

public final WaypointEvent.Context context

dimension

public final int dimension

Constructor Details

WaypointEvent

public WaypointEvent(Waypoint waypoint,
 WaypointEvent.Context context,
 int dimension)

WaypointEvent

public WaypointEvent(Waypoint waypoint,
 WaypointEvent.Context context,
 int dimension,
 CommonEvent.Side side)

Server-side constructor. Use when firing from a server context.

Method Details

getDimension

public int getDimension()

World dimension where event occurred.

getWaypoint

public Waypoint getWaypoint()

Gets the waypoint that the event is handling.

Returns:

- The waypoint.

getContext

public WaypointEvent.Context getContext()

The event context.

Returns:

- The context.